Quality management APIs

POST quality/document-headers

Creates a document header

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

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:

                                        <QualityDocumentHeader>
                                    

<Title

Title

Required/mandatory field

Name of a document header

>{String}</Title>

<BackgroundColor

BackgroundColor

This field is optional.

<ColorHex

ColorHex

Only specified if not color scheme is specified (optional)

This field is optional.

>{String}</ColorHex>

<Color

Color

Color scheme reference (optional)

This field is optional.

<ColorId

ColorId

Color identifier

Minimum value: 100000

This field is optional.

>{Integer}</ColorId>

                                                  </Color>
                                    

                                             </BackgroundColor>
                                    

<Symbol

Symbol

Reference to symbol

This field is optional.

<QualitySymbolId

QualitySymbolId

Quality symbol identifier

Minimum value: 100000

This field is optional.

>{Integer}</QualitySymbolId>

                                             </Symbol>
                                    

                                        </QualityDocumentHeader>
                                    

{

                                             "qualityDocumentHeader": {
                                    

"title

Title

Required/mandatory field

Name of a document header

": "{String}",

"backgroundColor

BackgroundColor

This field is optional.

": {

"colorHex

ColorHex

Only specified if not color scheme is specified (optional)

This field is optional.

": "{String}",

"color

Color

Color scheme reference (optional)

This field is optional.

": {

"colorId

ColorId

Color identifier

Minimum value: 100000

This field is optional.

": "{Integer}"

}

},

"symbol

Symbol

Reference to symbol

This field is optional.

": {

"qualitySymbolId

QualitySymbolId

Quality symbol identifier

Minimum value: 100000

This field is optional.

": "{Integer}"

}

}

}

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:

                                        <QualityDocumentHeader>
                                    

<QualityDocumentHeaderId

QualityDocumentHeaderId

Document header identifier

>{Integer}</QualityDocumentHeaderId>

<Status

Status

Document header status

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time for when a document header was created

>{Datetime}</CreatedAt>

<UpdatedAt

UpdatedAt

Date and time for when a document header was updated

>{Datetime}</UpdatedAt>

<Title

Title

Name of a document header

>{String}</Title>

                                             <BackgroundColor>
                                    

<ColorHex

ColorHex

Only specified if not color scheme is specified (optional)

>{String}</ColorHex>

<Color

Color

Color scheme reference (optional)

<ColorId

ColorId

Color identifier

>{Integer}</ColorId>

<ColorLink

ColorLink

Color reference

>{String}</ColorLink>

                                                  </Color>
                                    

                                             </BackgroundColor>
                                    

<Symbol

Symbol

Reference to symbol

<QualitySymbolId

QualitySymbolId

Quality symbol identifier

>{Integer}</QualitySymbolId>

<QualitySymbolLink

QualitySymbolLink

Quality symbol reference

>{String}</QualitySymbolLink>

                                             </Symbol>
                                    

                                        </QualityDocumentHeader>
                                    

{

                                             "qualityDocumentHeader": {
                                    

"qualityDocumentHeaderId

QualityDocumentHeaderId

Document header identifier

": "{Integer}",

"status

Status

Document header status

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time for when a document header was created

": "{Datetime}",

"updatedAt

UpdatedAt

Date and time for when a document header was updated

": "{Datetime}",

"title

Title

Name of a document header

": "{String}",

                                                  "backgroundColor": {
                                    

"colorHex

ColorHex

Only specified if not color scheme is specified (optional)

": "{String}",

"color

Color

Color scheme reference (optional)

": {

"colorId

ColorId

Color identifier

": "{Integer}",

"colorLink

ColorLink

Color reference

": "{String}"

}

},

"symbol

Symbol

Reference to symbol

": {

"qualitySymbolId

QualitySymbolId

Quality symbol identifier

": "{Integer}",

"qualitySymbolLink

QualitySymbolLink

Quality symbol reference

": "{String}"

}

}

}

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: