API

Quality management APIs

POST quality/document-templates

Create a new quality document template

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

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
<QualityDocumentTemplate>
2
     <Name
Name

Required/mandatory field

Template setting name

>{String}</Name>
3
     <Type
Type

Required/mandatory field

Can be either STANDARD or SET.
STANDARD is a single template.
SET is a set of templates.

Applicable domain values can be found here

>{Integer}</Type>
4
     <Description
Description

Template setting description

This field is optional.

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

Short numerical identifier. Should be integer for global templates. Should contain at least one letter for local templates.

This field is optional.

>{String}</ShortIdentifier>
6
</QualityDocumentTemplate>
1
{
2
     "qualityDocumentTemplate": {
3
          "name
Name

Required/mandatory field

Template setting name

": "{String}",
4
          "type
Type

Required/mandatory field

Can be either STANDARD or SET.
STANDARD is a single template.
SET is a set of templates.

Applicable domain values can be found here

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

Template setting description

This field is optional.

": "{String}",
6
          "shortIdentifier
ShortIdentifier

Short numerical identifier. Should be integer for global templates. Should contain at least one letter for local templates.

This field is optional.

": "{String}"
7
     }
8
}

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
<QualityDocumentTemplate>
2
     <QualityDocumentTemplateId
QualityDocumentTemplateId

Document template identifier

>{Integer}</QualityDocumentTemplateId>
3
     <Status
Status

Status of a document template

Possible domain values can be found here

>{Integer}</Status>
4
     <Type
Type

Can be either STANDARD or SET.
STANDARD is a single template.
SET is a set of templates.

Possible domain values can be found here

>{String}</Type>
5
     <Name
Name

Template setting name

>{String}</Name>
6
     <Description
Description

Template setting description

>{String}</Description>
7
     <ShortIdentifier
ShortIdentifier

Short numerical identifier. Should be integer for global templates. Should contain at least one letter for local templates.

>{String}</ShortIdentifier>
8
     <ThumbnailFileStorageGuid
ThumbnailFileStorageGuid

Unique identifier to download the template thumbnail

>{String}</ThumbnailFileStorageGuid>
9
</QualityDocumentTemplate>
1
{
2
     "qualityDocumentTemplate": {
3
          "qualityDocumentTemplateId
QualityDocumentTemplateId

Document template identifier

": "{Integer}",
4
          "status
Status

Status of a document template

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Can be either STANDARD or SET.
STANDARD is a single template.
SET is a set of templates.

Possible domain values can be found here

": "{String}",
6
          "name
Name

Template setting name

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

Template setting description

": "{String}",
8
          "shortIdentifier
ShortIdentifier

Short numerical identifier. Should be integer for global templates. Should contain at least one letter for local templates.

": "{String}",
9
          "thumbnailFileStorageGuid
ThumbnailFileStorageGuid

Unique identifier to download the template thumbnail

": "{String}"
10
     }
11
}

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: