API

Quality management APIs

POST quality/symbols

Creates a quality symbol

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

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
<QualitySymbol>
2
     <Title
Title

Required/mandatory field

Name of quality symbol

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

Quality symbol description

This field is optional.

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

DOV (note that DOVs should always have filter on TYPE)

Applicable domain values can be found here

This field is optional.

>{Integer}</Category>
5
</QualitySymbol>
1
{
2
     "qualitySymbol": {
3
          "title
Title

Required/mandatory field

Name of quality symbol

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

Quality symbol description

This field is optional.

": "{String}",
5
          "category
Category

DOV (note that DOVs should always have filter on TYPE)

Applicable domain values can be found here

This field is optional.

": "{Integer}"
6
     }
7
}

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
<QualitySymbol>
2
     <QualitySymbolId
QualitySymbolId

Quality symbol identifier

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

Quality symbol status

Possible domain values can be found here

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

Date and time for when a quality symbol was created

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

Date and time for when a quality symbol was updated

>{Datetime}</UpdatedAt>
6
     <Title
Title

Name of quality symbol

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

Quality symbol description

>{String}</Description>
8
     <Category
Category

DOV (note that DOVs should always have filter on TYPE)

Possible domain values can be found here

>{String}</Category>
9
     <FileStorageGuid
FileStorageGuid

UUID in file storage

>{String}</FileStorageGuid>
10
     <SortIndex
SortIndex

The field to control the order in which symbols are displayed

>
11
          <Scope
Scope

Scope of the Role

Possible domain values can be found here

>{String}</Scope>
12
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
13
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
14
               <UserId
UserId

User identifier

>{Integer}</UserId>
15
               <UserLink
UserLink

User reference

>{String}</UserLink>
16
          </ChangedBy>
17
     </SortIndex>
18
</QualitySymbol>
1
{
2
     "qualitySymbol": {
3
          "qualitySymbolId
QualitySymbolId

Quality symbol identifier

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

Quality symbol status

Possible domain values can be found here

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

Date and time for when a quality symbol was created

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

Date and time for when a quality symbol was updated

": "{Datetime}",
7
          "title
Title

Name of quality symbol

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

Quality symbol description

": "{String}",
9
          "category
Category

DOV (note that DOVs should always have filter on TYPE)

Possible domain values can be found here

": "{String}",
10
          "fileStorageGuid
FileStorageGuid

UUID in file storage

": "{String}",
11
          "sortIndex
SortIndex

The field to control the order in which symbols are displayed

": {
12
               "scope
Scope

Scope of the Role

Possible domain values can be found here

": "{String}",
13
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
14
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
15
                    "userId
UserId

User identifier

": "{Integer}",
16
                    "userLink
UserLink

User reference

": "{String}"
17
               }
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: