Production APIs
Details of production task trigger
| HTTP method | GET |
| URI | https://api.rambase.net/production/task-triggers/{productionTaskTriggerId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionTaskTriggerId} |
Production task trigger id
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 5508, version 10 |
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.
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
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.
ProductionTaskTriggerId
Production task trigger id
>{Integer}</ProductionTaskTriggerId>Status
Status of the production task trigger
Possible domain values can be found here
>{Integer}</Status>Name
Name of the production task trigger
>{String}</Name>Description
Description of the production task trigger
>{String}</Description>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>TaskProcessTemplate
Task process template the tasks should be created from
>TaskProcessTemplateId
Unique identifier for task process template
>{Integer}</TaskProcessTemplateId>Name
Name of the task process template
>{String}</Name>TaskProcessTemplateLink
Task process template reference
>{String}</TaskProcessTemplateLink>Level
Degree of details. State if the task should be triggered based on only product id or in addition one or more varaiables.
Possible domain values can be found here
>{Integer}</Level>IntervalDays
Number of days since last production before the task process will be re triggered based on the degree of details.
If never triggerd before it will do it the first time production runs.
CheckQualityIssues
Check for quality issues. If quality issue since last time trigger, re trigger
ProductionTaskTriggerId
Production task trigger id
": "{Integer}",Status
Status of the production task trigger
Possible domain values can be found here
": "{Integer}",Name
Name of the production task trigger
": "{String}",Description
Description of the production task trigger
": "{String}",LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"TaskProcessTemplate
Task process template the tasks should be created from
": {TaskProcessTemplateId
Unique identifier for task process template
": "{Integer}",Name
Name of the task process template
": "{String}",TaskProcessTemplateLink
Task process template reference
": "{String}"Level
Degree of details. State if the task should be triggered based on only product id or in addition one or more varaiables.
Possible domain values can be found here
": "{Integer}",IntervalDays
Number of days since last production before the task process will be re triggered based on the degree of details.
If never triggerd before it will do it the first time production runs.
CheckQualityIssues
Check for quality issues. If quality issue since last time trigger, re trigger
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 101606 HTTP 404 | Module not found |