API

Production APIs

POST production/task-triggers

Creates a new production task trigger

HTTP method POST
URI https://api.rambase.net/production/task-triggers
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5575, version 1

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

Required/mandatory field

Name of the production task trigger

>{String}</Name>
3
     <Description
Description

Description of the production task trigger

This field is optional.

>{String}</Description>
4
     <Location
Location

This field is optional.

>
5
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
6
     </Location>
7
     <TaskProcessTemplate
TaskProcessTemplate

Task process template the tasks should be created from

This field is optional.

>
8
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

Minimum value: 100000

This field is optional.

>{Integer}</TaskProcessTemplateId>
9
     </TaskProcessTemplate>
10
     <RetriggerSettings
RetriggerSettings

This field is optional.

>
11
          <Level
Level

Degree of details. State if the task should be triggered based on only product id or in addition one or more varaiables.

Applicable domain values can be found here

This field is optional.

>{Integer}</Level>
12
          <IntervalDays
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.

Minimum value: 0

This field is optional.

>{Integer}</IntervalDays>
13
          <CheckQualityIssues
CheckQualityIssues

Check for quality issues. If quality issue since last time trigger, re trigger

Default value: False

This field is optional.

>{Boolean}</CheckQualityIssues>
14
     </RetriggerSettings>
15
</ProductionTaskTrigger>
1
{
2
     "productionTaskTrigger": {
3
          "name
Name

Required/mandatory field

Name of the production task trigger

": "{String}",
4
          "description
Description

Description of the production task trigger

This field is optional.

": "{String}",
5
          "location
Location

This field is optional.

": {
6
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
7
          },
8
          "taskProcessTemplate
TaskProcessTemplate

Task process template the tasks should be created from

This field is optional.

": {
9
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

Minimum value: 100000

This field is optional.

": "{Integer}"
10
          },
11
          "retriggerSettings
RetriggerSettings

This field is optional.

": {
12
               "level
Level

Degree of details. State if the task should be triggered based on only product id or in addition one or more varaiables.

Applicable domain values can be found here

This field is optional.

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

Minimum value: 0

This field is optional.

": "{Integer}",
14
               "checkQualityIssues
CheckQualityIssues

Check for quality issues. If quality issue since last time trigger, re trigger

Default value: False

This field is optional.

": "{Boolean}"
15
          }
16
     }
17
}

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
<ProductionTaskTrigger>
2
     <ProductionTaskTriggerId
ProductionTaskTriggerId

Production task trigger id

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

Status of the production task trigger

Possible domain values can be found here

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

Name of the production task trigger

>{String}</Name>
5
     <Description
Description

Description of the production task trigger

>{String}</Description>
6
     <Location>
7
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
8
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
9
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
10
     </Location>
11
     <TaskProcessTemplate
TaskProcessTemplate

Task process template the tasks should be created from

>
12
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

>{Integer}</TaskProcessTemplateId>
13
          <Name
Name

Name of the task process template

>{String}</Name>
14
          <TaskProcessTemplateLink
TaskProcessTemplateLink

Task process template reference

>{String}</TaskProcessTemplateLink>
15
     </TaskProcessTemplate>
16
     <RetriggerSettings>
17
          <Level
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>
18
          <IntervalDays
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.

>{Integer}</IntervalDays>
19
          <CheckQualityIssues
CheckQualityIssues

Check for quality issues. If quality issue since last time trigger, re trigger

>{Boolean}</CheckQualityIssues>
20
     </RetriggerSettings>
21
</ProductionTaskTrigger>
1
{
2
     "productionTaskTrigger": {
3
          "productionTaskTriggerId
ProductionTaskTriggerId

Production task trigger id

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

Status of the production task trigger

Possible domain values can be found here

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

Name of the production task trigger

": "{String}",
6
          "description
Description

Description of the production task trigger

": "{String}",
7
          "location": {
8
               "locationId
LocationId

Location identifier

": "{Integer}",
9
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
10
               "locationLink
LocationLink

Location reference

": "{String}"
11
          },
12
          "taskProcessTemplate
TaskProcessTemplate

Task process template the tasks should be created from

": {
13
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

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

Name of the task process template

": "{String}",
15
               "taskProcessTemplateLink
TaskProcessTemplateLink

Task process template reference

": "{String}"
16
          },
17
          "retriggerSettings": {
18
               "level
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}",
19
               "intervalDays
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.

": "{Integer}",
20
               "checkQualityIssues
CheckQualityIssues

Check for quality issues. If quality issue since last time trigger, re trigger

": "{Boolean}"
21
          }
22
     }
23
}

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
Error 101551 HTTP 404 Object {0} not found