API

Production APIs

GET production/scheduled-task-processes/{scheduledTaskProcessId}

Details of scheduled production task process

HTTP method GET
URI https://api.rambase.net/production/scheduled-task-processes/{scheduledTaskProcessId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {scheduledTaskProcessId} Scheduled production task process identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5908, version 7

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

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
<ScheduledTaskProcess>
2
     <ScheduledTaskProcessId
ScheduledTaskProcessId

Scheduled production task process identifier

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

Scheduled production task process status

Possible domain values can be found here

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

Type of scheduled production task process

Possible domain values can be found here

>{Integer}</Type>
5
     <PlannedStartDate
PlannedStartDate

Date when operation is expected to start

>{Date}</PlannedStartDate>
6
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
     <PlannedDeadLineDate
PlannedDeadLineDate

Planned deadline date for a task triggered by given scheduled production task process

>{Date}</PlannedDeadLineDate>
8
     <CreatedBy
CreatedBy

Information about the user who created the scheduled production task process

>
9
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
10
          <Name
Name

Last name of employee

>{String}</Name>
11
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
12
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
13
     </CreatedBy>
14
     <ProductionWorkOrder>
15
          <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
16
          <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
17
     </ProductionWorkOrder>
18
     <ProductStructureOperation>
19
          <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

>{Integer}</ProductStructureOperationId>
20
          <ProductionOperation>
21
               <Name
Name

Name of production operation

>{String}</Name>
22
          </ProductionOperation>
23
          <ProductStructureVersion>
24
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

>{Integer}</ProductStructureVersionId>
25
               <ProductStructureVersionLink
ProductStructureVersionLink

Product structure reference

>{String}</ProductStructureVersionLink>
26
          </ProductStructureVersion>
27
     </ProductStructureOperation>
28
     <TaskProcess>
29
          <TaskProcessId
TaskProcessId

Unique identifier for Process

>{Integer}</TaskProcessId>
30
          <AssignedTo
AssignedTo

The userId of the person this task process is assigned to

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

>
31
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
32
               <LastName
LastName

Last name of employee

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

>{String}</LastName>
33
               <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
34
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
35
          </AssignedTo>
36
          <TaskProcessLink
TaskProcessLink

Task-process reference

>{String}</TaskProcessLink>
37
     </TaskProcess>
38
     <TaskProcessTemplate>
39
          <TaskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

>{Integer}</TaskProcessTemplateId>
40
          <Description
Description

Description of a task-process template

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

Name of the task process template

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

Task process template reference

>{String}</TaskProcessTemplateLink>
43
     </TaskProcessTemplate>
44
</ScheduledTaskProcess>
1
{
2
     "scheduledTaskProcess": {
3
          "scheduledTaskProcessId
ScheduledTaskProcessId

Scheduled production task process identifier

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

Scheduled production task process status

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of scheduled production task process

Possible domain values can be found here

": "{Integer}",
6
          "plannedStartDate
PlannedStartDate

Date when operation is expected to start

": "{Date}",
7
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
          "plannedDeadLineDate
PlannedDeadLineDate

Planned deadline date for a task triggered by given scheduled production task process

": "{Date}",
9
          "createdBy
CreatedBy

Information about the user who created the scheduled production task process

": {
10
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

": "{String}",
12
               "firstName
FirstName

First name of employee

": "{String}",
13
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
14
          },
15
          "productionWorkOrder": {
16
               "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
17
               "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
18
          },
19
          "productStructureOperation": {
20
               "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

": "{Integer}",
21
               "productionOperation": {
22
                    "name
Name

Name of production operation

": "{String}"
23
               },
24
               "productStructureVersion": {
25
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

": "{Integer}",
26
                    "productStructureVersionLink
ProductStructureVersionLink

Product structure reference

": "{String}"
27
               }
28
          },
29
          "taskProcess": {
30
               "taskProcessId
TaskProcessId

Unique identifier for Process

": "{Integer}",
31
               "assignedTo
AssignedTo

The userId of the person this task process is assigned to

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

": {
32
                    "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
33
                    "lastName
LastName

Last name of employee

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

": "{String}",
34
                    "firstName
FirstName

First name of employee

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

": "{String}",
35
                    "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
36
               },
37
               "taskProcessLink
TaskProcessLink

Task-process reference

": "{String}"
38
          },
39
          "taskProcessTemplate": {
40
               "taskProcessTemplateId
TaskProcessTemplateId

Unique identifier for task process template

": "{Integer}",
41
               "description
Description

Description of a task-process template

": "{String}",
42
               "name
Name

Name of the task process template

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

Task process template reference

": "{String}"
44
          }
45
     }
46
}

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 108271 HTTP 403 You are not authorized to view this process