API

Quality management APIs

POST quality/diagrams

Creates a diagram

HTTP method POST
URI https://api.rambase.net/quality/diagrams
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6392, version 3

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<QualityDiagram>
2
     <Title
Title

Required/mandatory field

Title of the diagram

>{String}</Title>
3
     <Description
Description

Description of the diagram

This field is optional.

>{String}</Description>
4
     <Folder
Folder

This field is optional.

>
5
          <FolderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

>{Integer}</FolderId>
6
     </Folder>
7
</QualityDiagram>
1
{
2
     "qualityDiagram": {
3
          "title
Title

Required/mandatory field

Title of the diagram

": "{String}",
4
          "description
Description

Description of the diagram

This field is optional.

": "{String}",
5
          "folder
Folder

This field is optional.

": {
6
               "folderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

": "{Integer}"
7
          }
8
     }
9
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<QualityDiagram>
2
     <QualityDiagramId
QualityDiagramId

Identifier of the diagram

>{Integer}</QualityDiagramId>
3
     <Title
Title

Title of the diagram

>{String}</Title>
4
     <Description
Description

Description of the diagram

>{String}</Description>
5
     <Status
Status

Status of the diagram

Possible domain values can be found here

>{Integer}</Status>
6
     <CreatedAt
CreatedAt

Automatically generated timestap of the creation date

>{Datetime}</CreatedAt>
7
     <UpdatedAt
UpdatedAt

Automatically created timestamp of the last update date

>{Datetime}</UpdatedAt>
8
     <PreviewFileStorageGuid
PreviewFileStorageGuid

Unique identifier for the fielstorage media service

>{String}</PreviewFileStorageGuid>
9
     <CreatedBy>
10
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
11
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
12
          <LastName
LastName

Last name of employee

>{String}</LastName>
13
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
14
          <FolderId
FolderId

Folder identifier

>{Integer}</FolderId>
15
          <Name
Name

Verbose folder text in english.

>{String}</Name>
16
          <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
17
     </CreatedBy>
18
</QualityDiagram>
1
{
2
     "qualityDiagram": {
3
          "qualityDiagramId
QualityDiagramId

Identifier of the diagram

": "{Integer}",
4
          "title
Title

Title of the diagram

": "{String}",
5
          "description
Description

Description of the diagram

": "{String}",
6
          "status
Status

Status of the diagram

Possible domain values can be found here

": "{Integer}",
7
          "createdAt
CreatedAt

Automatically generated timestap of the creation date

": "{Datetime}",
8
          "updatedAt
UpdatedAt

Automatically created timestamp of the last update date

": "{Datetime}",
9
          "previewFileStorageGuid
PreviewFileStorageGuid

Unique identifier for the fielstorage media service

": "{String}",
10
          "createdBy": {
11
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
12
               "firstName
FirstName

First name of employee

": "{String}",
13
               "lastName
LastName

Last name of employee

": "{String}",
14
               "employeeLink
EmployeeLink

Employee reference

": "{String}",
15
               "folderId
FolderId

Folder identifier

": "{Integer}",
16
               "name
Name

Verbose folder text in english.

": "{String}",
17
               "folderLink
FolderLink

Company folder id

": "{String}"
18
          }
19
     }
20
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: