API

Product APIs

POST product/quality-control-triggers

Create quality control trigger

HTTP method POST
URI https://api.rambase.net/product/quality-control-triggers
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6677, version 9

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

Required/mandatory field

Name of quality control trigger

>{String}</Name>
3
     <TriggerFor>
4
          <ObjectType
ObjectType

Required/mandatory field

The document type like SPO, ...

Applicable domain values can be found here

>{String}</ObjectType>
5
          <ObjectStatus
ObjectStatus

Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status

Applicable domain values can be found here

This field is optional.

>{Integer}</ObjectStatus>
6
     </TriggerFor>
7
     <Notification
Notification

This field is optional.

>
8
          <MessageToController
MessageToController

Message with additional informaation for a quality control trigger. Text to be copied to transatcion document when a notification is added due to this trigger.

This field is optional.

>{String}</MessageToController>
9
          <NotificationType
NotificationType

This field is optional.

>
10
               <NotificationTypeId
NotificationTypeId

Notification type identifier

Minimum value: 100

This field is optional.

>{Integer}</NotificationTypeId>
11
          </NotificationType>
12
     </Notification>
13
</QualityControlTrigger>
1
{
2
     "qualityControlTrigger": {
3
          "name
Name

Required/mandatory field

Name of quality control trigger

": "{String}",
4
          "triggerFor": {
5
               "objectType
ObjectType

Required/mandatory field

The document type like SPO, ...

Applicable domain values can be found here

": "{String}",
6
               "objectStatus
ObjectStatus

Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status

Applicable domain values can be found here

This field is optional.

": "{Integer}"
7
          },
8
          "notification
Notification

This field is optional.

": {
9
               "messageToController
MessageToController

Message with additional informaation for a quality control trigger. Text to be copied to transatcion document when a notification is added due to this trigger.

This field is optional.

": "{String}",
10
               "notificationType
NotificationType

This field is optional.

": {
11
                    "notificationTypeId
NotificationTypeId

Notification type identifier

Minimum value: 100

This field is optional.

": "{Integer}"
12
               }
13
          }
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.
$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
<QualityControlTrigger>
2
     <QualityControlTriggerId
QualityControlTriggerId

Quality control trigger identifier

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

Status of quality control trigger

Possible domain values can be found here

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

Date and time of creation

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

Name of quality control trigger

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

True if restricted location exists for the quality control trigger

>{Boolean}</IsRestrictedLocationExisting>
7
     <IsRestrictedSupplierIncluded
IsRestrictedSupplierIncluded

True if it exists restricted supplier that applies to the quality control trigger

>{Boolean}</IsRestrictedSupplierIncluded>
8
     <IsRestrictedSupplierExcluded
IsRestrictedSupplierExcluded

True if it exists restricted supplier that does not applies to the quality control trigger

>{Boolean}</IsRestrictedSupplierExcluded>
9
     <IsRestrictedSupplierClassificationExisting
IsRestrictedSupplierClassificationExisting

True if restricted supplier classification exists for the quality control trigger

>{Boolean}</IsRestrictedSupplierClassificationExisting>
10
     <HasDocumentationRequirement
HasDocumentationRequirement

If “true” it means that by attempt to register SSA, it will be checked if the SPO item which the SSA item origins from do have “documentation requirements” (in RQM) and if they are fullfilled or not.

>{Boolean}</HasDocumentationRequirement>
11
     <TriggerFor>
12
          <ObjectType
ObjectType

The document type like SPO, ...

Possible domain values can be found here

>{String}</ObjectType>
13
          <ObjectStatus
ObjectStatus

Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status

Possible domain values can be found here

>{Integer}</ObjectStatus>
14
     </TriggerFor>
15
     <Frequency>
16
          <Interval>
17
               <Threshold
Threshold

Interval in which the object item receives a quality control notification. . For QCT for goods reception e.g value "5" means that every fifth SPO item that matches the criterias for location, product and account will get a notification because of this trigger.

>{Integer}</Threshold>
18
               <Remaining
Remaining

Remaning interval in which the object item receives a quality control notification. This is a number that will be counted down based on the number that is set up in “Interval”. E.g “Interval” is “5” for quality control of goods reception means that this QCT should be triggered for each 5th purchase order SPO) item. First time it’s triggered, “RemainingInterval” is counted down to “4”. Next time to “3” etc. When it’s triggered 5 times, it’s reset to “5”

>{Integer}</Remaining>
19
          </Interval>
20
          <Upcoming>
21
               <Next
Next

The number of new objects for which the quality control trigger will be triggered

>{Integer}</Next>
22
               <Remaining
Remaining

The remaining number of new objects for which the quality control trigger will be triggered. This is a number that will be counted down based on the number that is set up in “Next”. E.g “Next” is “20”, means that this QCT should be triggered for the next 20 order items. First time it’s triggered, “RemainingNext” is counted down to “19”. Next time to “18” etc. When it’s triggered 20 times, it doesn’t apply any more.

>{Integer}</Remaining>
23
          </Upcoming>
24
          <UserId
UserId

User identifier

>{Integer}</UserId>
25
          <Name
Name

Name of the user

>{String}</Name>
26
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
27
          <UserLink
UserLink

User reference

>{String}</UserLink>
28
     </Frequency>
29
     <Validity>
30
          <EffectiveDate
EffectiveDate

The date the quality control trigger is effective from

>{Date}</EffectiveDate>
31
          <ExpirationDate
ExpirationDate

The date when the quality control trigger expires

>{Date}</ExpirationDate>
32
     </Validity>
33
     <Notification>
34
          <MessageToController
MessageToController

Message with additional informaation for a quality control trigger. Text to be copied to transatcion document when a notification is added due to this trigger.

>
35
               <NotificationTypeId
NotificationTypeId

Notification type identifier

>{Integer}</NotificationTypeId>
36
               <TranslatedMessage
TranslatedMessage

The notification definition message in user language.

>{String}</TranslatedMessage>
37
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

>{String}</NotificationTypeLink>
38
          </MessageToController>
39
     </Notification>
40
</QualityControlTrigger>
1
{
2
     "qualityControlTrigger": {
3
          "qualityControlTriggerId
QualityControlTriggerId

Quality control trigger identifier

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

Status of quality control trigger

Possible domain values can be found here

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

Date and time of creation

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

Name of quality control trigger

": "{String}",
7
          "isRestrictedLocationExisting
IsRestrictedLocationExisting

True if restricted location exists for the quality control trigger

": "{Boolean}",
8
          "isRestrictedSupplierIncluded
IsRestrictedSupplierIncluded

True if it exists restricted supplier that applies to the quality control trigger

": "{Boolean}",
9
          "isRestrictedSupplierExcluded
IsRestrictedSupplierExcluded

True if it exists restricted supplier that does not applies to the quality control trigger

": "{Boolean}",
10
          "isRestrictedSupplierClassificationExisting
IsRestrictedSupplierClassificationExisting

True if restricted supplier classification exists for the quality control trigger

": "{Boolean}",
11
          "hasDocumentationRequirement
HasDocumentationRequirement

If “true” it means that by attempt to register SSA, it will be checked if the SPO item which the SSA item origins from do have “documentation requirements” (in RQM) and if they are fullfilled or not.

": "{Boolean}",
12
          "triggerFor": {
13
               "objectType
ObjectType

The document type like SPO, ...

Possible domain values can be found here

": "{String}",
14
               "objectStatus
ObjectStatus

Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status

Possible domain values can be found here

": "{Integer}"
15
          },
16
          "frequency": {
17
               "interval": {
18
                    "threshold
Threshold

Interval in which the object item receives a quality control notification. . For QCT for goods reception e.g value "5" means that every fifth SPO item that matches the criterias for location, product and account will get a notification because of this trigger.

": "{Integer}",
19
                    "remaining
Remaining

Remaning interval in which the object item receives a quality control notification. This is a number that will be counted down based on the number that is set up in “Interval”. E.g “Interval” is “5” for quality control of goods reception means that this QCT should be triggered for each 5th purchase order SPO) item. First time it’s triggered, “RemainingInterval” is counted down to “4”. Next time to “3” etc. When it’s triggered 5 times, it’s reset to “5”

": "{Integer}"
20
               },
21
               "upcoming": {
22
                    "next
Next

The number of new objects for which the quality control trigger will be triggered

": "{Integer}",
23
                    "remaining
Remaining

The remaining number of new objects for which the quality control trigger will be triggered. This is a number that will be counted down based on the number that is set up in “Next”. E.g “Next” is “20”, means that this QCT should be triggered for the next 20 order items. First time it’s triggered, “RemainingNext” is counted down to “19”. Next time to “18” etc. When it’s triggered 20 times, it doesn’t apply any more.

": "{Integer}"
24
               },
25
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
27
               "firstName
FirstName

First name of the user

": "{String}",
28
               "userLink
UserLink

User reference

": "{String}"
29
          },
30
          "validity": {
31
               "effectiveDate
EffectiveDate

The date the quality control trigger is effective from

": "{Date}",
32
               "expirationDate
ExpirationDate

The date when the quality control trigger expires

": "{Date}"
33
          },
34
          "notification": {
35
               "messageToController
MessageToController

Message with additional informaation for a quality control trigger. Text to be copied to transatcion document when a notification is added due to this trigger.

": {
36
                    "notificationTypeId
NotificationTypeId

Notification type identifier

": "{Integer}",
37
                    "translatedMessage
TranslatedMessage

The notification definition message in user language.

": "{String}",
38
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

": "{String}"
39
               }
40
          }
41
     }
42
}

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 101079 HTTP 400 Mismatch in size of revision parameters
Error 101551 HTTP 404 Object {0} not found
Error 100147 HTTP 404 Notification type not found
Error 109473 HTTP 400 Valid from date must be set to todays date or later
Error 109469 HTTP 400 Valid to date cannot come before valid from date
Error 109885 HTTP 400 Documentation requirement can only be set when notification type is DMS/241