API

Product APIs

GET product/products/{productId}/quality-control-triggers

List of all quality control triggers pr. product

HTTP method GET
URI https://api.rambase.net/product/products/{productId}/quality-control-triggers
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productId} Product identifier
Integer, minimum 10000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6919, 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:
1
1

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.

$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active quality control triggers (status 4)
EffectiveDate Date The date the quality control trigger is effective from. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpirationDate Date The date when the quality control trigger expires. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IntervalRemaining Integer 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”.
IntervalThreshold Integer 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.
MessageToController String 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.
Name String Name of quality control trigger.
NotificationTypeId Integer Notification type identifier.
QualityControlTriggerId Integer Quality control trigger identifier.
Status Integer Status of quality control trigger.
UpcomingNext Integer The number of new objects for which the quality control trigger will be triggered.
UpcomingRemaining Integer 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.

Read more about filters and sorting on how to use sortable parameters

EffectiveDate Date The date the quality control trigger is effective from
ExpirationDate Date The date when the quality control trigger expires
IntervalRemaining Integer 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”
IntervalThreshold Integer 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.
MessageToController String 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.
Name String Name of quality control trigger
NotificationTypeId Integer Notification type identifier
QualityControlTriggerId Integer Quality control trigger identifier
Status Integer Status of quality control trigger
UpcomingNext Integer The number of new objects for which the quality control trigger will be triggered
UpcomingRemaining Integer 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.

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
<QualityControlTriggers>
2
     <QualityControlTrigger>
3
          <QualityControlTriggerId
QualityControlTriggerId

Quality control trigger identifier

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

Status of quality control trigger

Possible domain values can be found here

>{Integer}</Status>
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
          <Frequency
Frequency

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>
11
               <Interval
Interval

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>{Integer}</Threshold>
13
                    <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”

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>{Integer}</Remaining>
14
               </Interval>
15
               <Upcoming
Upcoming

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>
16
                    <Next
Next

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>{Integer}</Next>
17
                    <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.

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

>{Integer}</Remaining>
18
               </Upcoming>
19
          </Frequency>
20
          <Validity>
21
               <EffectiveDate
EffectiveDate

The date the quality control trigger is effective from

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

The date when the quality control trigger expires

>{Date}</ExpirationDate>
23
          </Validity>
24
          <Notification>
25
               <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.

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

>
27
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

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

The notification definition message in user language.

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

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

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

>{String}</NotificationTypeLink>
30
               </NotificationType>
31
          </Notification>
32
          <QualityControlTriggerLink
QualityControlTriggerLink

Quality control triggers reference

>{String}</QualityControlTriggerLink>
33
     </QualityControlTrigger>
34
     <Paging
Paging

Detailed paging information for this list.

>
35
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
36
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
37
          <Page
Page

Page index

>{Integer}</Page>
38
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
39
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
40
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
41
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
42
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
43
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
44
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
45
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
46
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
47
     </Paging>
48
</QualityControlTriggers>
1
{
2
     "qualityControlTriggers": [
3
          {
4
               "qualityControlTriggerId
QualityControlTriggerId

Quality control trigger identifier

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

Status of quality control trigger

Possible domain values can be found here

": "{Integer}",
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
               "frequency
Frequency

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": {
12
                    "interval
Interval

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": "{Integer}",
14
                         "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”

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": "{Integer}"
15
                    },
16
                    "upcoming
Upcoming

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": {
17
                         "next
Next

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": "{Integer}",
18
                         "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.

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Frequency in your request URI to get this field

": "{Integer}"
19
                    }
20
               },
21
               "validity": {
22
                    "effectiveDate
EffectiveDate

The date the quality control trigger is effective from

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

The date when the quality control trigger expires

": "{Date}"
24
               },
25
               "notification": {
26
                    "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.

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

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

": {
28
                         "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

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

The notification definition message in user language.

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

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

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=QualityControlTrigger.Notification.NotificationType in your request URI to get this field

": "{String}"
31
                    }
32
               },
33
               "qualityControlTriggerLink
QualityControlTriggerLink

Quality control triggers reference

": "{String}"
34
          }
35
     ],
36
     "paging
Paging

Detailed paging information for this list.

": {
37
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
38
          "position
Position

Position of the first element in the list

": "{Integer}",
39
          "page
Page

Page index

": "{Integer}",
40
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
41
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
42
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
43
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
44
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
45
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
46
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
48
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
49
     }
50
}

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 100147 HTTP 404 Notification type not found
Error 100089 HTTP 404 Product {0} not found