API

Quality management APIs

PUT quality/document-headers/{documentHeaderId}

Edit a document header

HTTP method PUT
URI https://api.rambase.net/quality/document-headers/{documentHeaderId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {documentHeaderId} Document header identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6594, 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
<QualityDocumentHeader
QualityDocumentHeader

This field is optional.

>
2
     <Title
Title

Name of a document header

This field is optional.

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

This field is optional.

>
4
          <ColorHex
ColorHex

Only specified if not color scheme is specified (optional)

Input must match the following regular expression pattern: ^#[0-9a-fA-F]{6}$

This field is optional.

>{String}</ColorHex>
5
          <Color
Color

Color scheme reference (optional)

This field is optional.

>
6
               <ColorId
ColorId

Color identifier

Minimum value: 100000

This field is optional.

>{Integer}</ColorId>
7
          </Color>
8
     </BackgroundColor>
9
     <Symbol
Symbol

Reference to symbol

This field is optional.

>
10
          <QualitySymbolId
QualitySymbolId

Quality symbol identifier

Minimum value: 100000

This field is optional.

>{Integer}</QualitySymbolId>
11
     </Symbol>
12
     <SortIndex
SortIndex

Index by which the elements are displayed

Minimum value: 1

This field is optional.

>{Integer}</SortIndex>
13
</QualityDocumentHeader>
1
{
2
     "qualityDocumentHeader
QualityDocumentHeader

This field is optional.

": {
3
          "title
Title

Name of a document header

This field is optional.

": "{String}",
4
          "backgroundColor
BackgroundColor

This field is optional.

": {
5
               "colorHex
ColorHex

Only specified if not color scheme is specified (optional)

Input must match the following regular expression pattern: ^#[0-9a-fA-F]{6}$

This field is optional.

": "{String}",
6
               "color
Color

Color scheme reference (optional)

This field is optional.

": {
7
                    "colorId
ColorId

Color identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
8
               }
9
          },
10
          "symbol
Symbol

Reference to symbol

This field is optional.

": {
11
               "qualitySymbolId
QualitySymbolId

Quality symbol identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
12
          },
13
          "sortIndex
SortIndex

Index by which the elements are displayed

Minimum value: 1

This field is optional.

": "{Integer}"
14
     }
15
}

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.

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. Fields colored in grey is expandable fields.

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

Format:
1
1

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:

Error 110202 HTTP 400 Color scheme can't be selected on global objects
Error 109175 HTTP 400 You have not selected a valid colorscheme
Error 110203 HTTP 400 Quality symbol's scope needs to be global if objects's scope is global