Product APIs

GET product/quality-control-triggers

List of all quality control triggers

HTTP method	GET
URI	https://api.rambase.net/product/quality-control-triggers
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	6674, version 28

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:

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)
AccountClassification String	Classification of the supplier.
AccountId Integer	RamBase supplier identifier.
CreatedAt Datetime	Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer	User identifier.
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()
HasDocumentationRequirement Boolean	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.
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.
LocationId Integer	Location identifier.
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.
ObjectType String	The document type like SPO, ...
ObjectValidateStatus Integer	Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status.
ProductClassification String	Product classification identifier.
ProductId Integer	Product 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

AccountClassification String	Classification of the supplier
AccountId Integer	RamBase supplier identifier
CreatedAt Datetime	Date and time of creation
CreatedBy Integer	User identifier
EffectiveDate Date	The date the quality control trigger is effective from
ExpirationDate Date	The date when the quality control trigger expires
HasDocumentationRequirement Boolean	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.
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.
LocationId Integer	Location identifier
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
ObjectType String	The document type like SPO, ...
ObjectValidateStatus Integer	Quality control will be triggered by attempt to register goods reception (SSA) from this status to next status
ProductClassification String	Product classification identifier
ProductId Integer	Product 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:

                                        <QualityControlTriggers>
                                    

                                             <QualityControlTrigger>
                                    

<QualityControlTriggerId

QualityControlTriggerId

Quality control trigger identifier

>{Integer}</QualityControlTriggerId>

<Status

Status

Status of quality control trigger

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Name

Name

Name of quality control trigger

>{String}</Name>

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

<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

<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

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

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

                                                       </Interval>
                                    

<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

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

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

                                                       </Upcoming>
                                    

                                                  </Frequency>
                                    

                                                  <Validity>
                                    

<EffectiveDate

EffectiveDate

The date the quality control trigger is effective from

>{Date}</EffectiveDate>

<ExpirationDate

ExpirationDate

The date when the quality control trigger expires

>{Date}</ExpirationDate>

                                                  </Validity>
                                    

                                                  <Notification>
                                    

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

<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

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

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

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

                                                       </NotificationType>
                                    

                                                  </Notification>
                                    

<QualityControlTriggerLink

QualityControlTriggerLink

Quality control triggers reference

>{String}</QualityControlTriggerLink>

                                             </QualityControlTrigger>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

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

<FirstPage

FirstPage

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

>{String}</FirstPage>

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

<PreviousPage

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

>{String}</PreviousPage>

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

<NextPage

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

>{String}</NextPage>

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

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </QualityControlTriggers>
                                    

{

                                             "qualityControlTriggers": [
                                    

{

"qualityControlTriggerId

QualityControlTriggerId

Quality control trigger identifier

": "{Integer}",

"status

Status

Status of quality control trigger

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"name

Name

Name of quality control trigger

": "{String}",

"hasDocumentationRequirement

HasDocumentationRequirement

": "{Boolean}",

"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

": {

"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

": {

"threshold

Threshold

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

Remaining

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

},

"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

": {

"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}",

"remaining

Remaining

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

}

},

                                                       "validity": {
                                    

"effectiveDate

EffectiveDate

The date the quality control trigger is effective from

": "{Date}",

"expirationDate

ExpirationDate

The date when the quality control trigger expires

": "{Date}"

},

                                                       "notification": {
                                    

"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}",

"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

": {

"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}",

"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}",

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

}

},

"qualityControlTriggerLink

QualityControlTriggerLink

Quality control triggers reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

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

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"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}",

"firstPage

FirstPage

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

": "{String}",

"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}",

"previousPage

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

": "{String}",

"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}",

"nextPage

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

": "{String}",

"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}",

"lastPage

LastPage

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

": "{String}",

"size

Size

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

": "{Integer}"

}

}

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