API

Product APIs

PUT product/quality-control-triggers/{qualityControlTriggerId}

Update quallity control trigger details for provided identifier

HTTP method PUT
URI https://api.rambase.net/product/quality-control-triggers/{qualityControlTriggerId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityControlTriggerId} Quality control trigger identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6673, 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
QualityControlTrigger

This field is optional.

>
2
     <Name
Name

Name of quality control trigger

This field is optional.

>{String}</Name>
3
     <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.

This field is optional.

>{Boolean}</HasDocumentationRequirement>
4
     <TriggerFor
TriggerFor

This field is optional.

>
5
          <ObjectType
ObjectType

The document type like SPO, ...

This field is optional.

>{String}</ObjectType>
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}</ObjectStatus>
7
     </TriggerFor>
8
     <Frequency
Frequency

This field is optional.

>
9
          <Interval
Interval

This field is optional.

>
10
               <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.

Minimum value: 0

This field is optional.

>{Integer}</Threshold>
11
          </Interval>
12
          <Upcoming
Upcoming

This field is optional.

>
13
               <Next
Next

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

Minimum value: 0

This field is optional.

>{Integer}</Next>
14
          </Upcoming>
15
     </Frequency>
16
     <Validity
Validity

This field is optional.

>
17
          <EffectiveDate
EffectiveDate

The date the quality control trigger is effective from

This field is optional.

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

The date when the quality control trigger expires

This field is optional.

>{Date}</ExpirationDate>
19
     </Validity>
20
     <Notification
Notification

This field is optional.

>
21
          <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>
22
          <NotificationType
NotificationType

This field is optional.

>
23
               <NotificationTypeId
NotificationTypeId

Notification type identifier

Minimum value: 100

This field is optional.

>{Integer}</NotificationTypeId>
24
          </NotificationType>
25
     </Notification>
26
</QualityControlTrigger>
1
{
2
     "qualityControlTrigger
QualityControlTrigger

This field is optional.

": {
3
          "name
Name

Name of quality control trigger

This field is optional.

": "{String}",
4
          "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.

This field is optional.

": "{Boolean}",
5
          "triggerFor
TriggerFor

This field is optional.

": {
6
               "objectType
ObjectType

The document type like SPO, ...

This field is optional.

": "{String}",
7
               "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}"
8
          },
9
          "frequency
Frequency

This field is optional.

": {
10
               "interval
Interval

This field is optional.

": {
11
                    "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.

Minimum value: 0

This field is optional.

": "{Integer}"
12
               },
13
               "upcoming
Upcoming

This field is optional.

": {
14
                    "next
Next

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

Minimum value: 0

This field is optional.

": "{Integer}"
15
               }
16
          },
17
          "validity
Validity

This field is optional.

": {
18
               "effectiveDate
EffectiveDate

The date the quality control trigger is effective from

This field is optional.

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

The date when the quality control trigger expires

This field is optional.

": "{Date}"
20
          },
21
          "notification
Notification

This field is optional.

": {
22
               "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}",
23
               "notificationType
NotificationType

This field is optional.

": {
24
                    "notificationTypeId
NotificationTypeId

Notification type identifier

Minimum value: 100

This field is optional.

": "{Integer}"
25
               }
26
          }
27
     }
28
}

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 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