API

Production APIs

GET production/resource-groups/{productionResourceGroupId}/work-order-operations

Gets a list of work orders assigned to the production work group

HTTP method GET
URI https://api.rambase.net/production/resource-groups/{productionResourceGroupId}/work-order-operations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceGroupId} Production resource group identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3425, version 24

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.

Ready() Named filter Ready work order operations
Waiting() Named filter Waiting work order operations
ConfirmedCompletionDate Date The confirmed date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsProcessingCompleted Boolean True if processing is completed.
Location String Unique abbreviation/short name of the location.
PlannedFinishedAt Datetime Date and time planned to finish. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PlannedStartAt Datetime Date and time planned to start. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductDescription String Description of the product.
ProductName String Name of the product.
Quantity Decimal Quantity of the work order operation.
RequestedCompletionDate Date The requested date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SerialNumber String Serial number of the product unit.
Status Integer Production work order operation status.
WorkOrderOperationId Integer Production work order operation identifier.

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

ConfirmedCompletionDate Date The confirmed date of completion for the production work order
IsProcessingCompleted Boolean True if processing is completed
Location String Unique abbreviation/short name of the location
PlannedFinishedAt Datetime Date and time planned to finish. Specified by the planned work order operation.
PlannedStartAt Datetime Date and time planned to start. Specified by the planned work order operation.
ProductDescription String Description of the product
ProductName String Name of the product
Quantity Decimal Quantity of the work order operation
RequestedCompletionDate Date The requested date of completion for the production work order.
Status Integer Production work order operation status
WorkOrderOperationId Integer Production work order operation identifier

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
<ResourceGroupWorkOrderOperations>
2
     <ResourceGroupWorkOrderOperation>
3
          <LatestWorkOrderProductOperation>
4
               <ProductUnit>
5
                    <SerialNumber
SerialNumber

Serial number of the product unit

>{String}</SerialNumber>
6
               </ProductUnit>
7
          </LatestWorkOrderProductOperation>
8
          <WorkOrderOperation>
9
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

>{Integer}</WorkOrderOperationId>
10
               <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>{String}</WorkOrderOperationLink>
11
               <Status
Status

Production work order operation status

Possible domain values can be found here

>{Integer}</Status>
12
               <PlannedStartAt
PlannedStartAt

Date and time planned to start. Specified by the planned work order operation.

>{Datetime}</PlannedStartAt>
13
               <PlannedFinishedAt
PlannedFinishedAt

Date and time planned to finish. Specified by the planned work order operation.

>{Datetime}</PlannedFinishedAt>
14
               <Quantity
Quantity

Quantity of the work order operation

>{Decimal}</Quantity>
15
               <Processing>
16
                    <IsProcessingCompleted
IsProcessingCompleted

True if processing is completed

>{Boolean}</IsProcessingCompleted>
17
                    <PlannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

>{Decimal}</PlannedRunTime>
18
                    <RunTime
RunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</RunTime>
19
               </Processing>
20
               <Changeover>
21
                    <IsSetupCompleted
IsSetupCompleted

True if setup changeover is completed

>{Boolean}</IsSetupCompleted>
22
                    <SetupTime
SetupTime

Time in hours used for setup changeover

>{Decimal}</SetupTime>
23
                    <IsCleanupCompleted
IsCleanupCompleted

True if cleanup changeover is completed

>{Boolean}</IsCleanupCompleted>
24
                    <CleanupTime
CleanupTime

Time in hours used for cleanup changeover

>{Decimal}</CleanupTime>
25
               </Changeover>
26
               <ProductionWorkOrder>
27
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
28
                    <CustomersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

>{String}</CustomersReferenceNumber>
29
                    <RequestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

>{Date}</RequestedCompletionDate>
30
                    <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

>{Date}</ConfirmedCompletionDate>
31
                    <ProductionFor>
32
                         <Object>
33
                              <Customer>
34
                                   <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
35
                                   <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ResourceGroupWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.ProductionFor.Object.Customer.Name in your request URI to get this field

>{String}</Name>
36
                                   <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
37
                              </Customer>
38
                         </Object>
39
                    </ProductionFor>
40
                    <Location
Location

The location of the production.

>
41
                         <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
42
                    </Location>
43
                    <Product>
44
                         <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
45
                         <Name
Name

Name of the product

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

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceGroupWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.Product.Description in your request URI to get this field

>{String}</Description>
47
                         <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
48
                    </Product>
49
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
50
               </ProductionWorkOrder>
51
               <ProductStructureOperation>
52
                    <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

>{Integer}</SequenceNumber>
53
                    <WaitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

>{Decimal}</WaitTime>
54
                    <Changeover>
55
                         <SetupTime
SetupTime

Changeover pre/setup time in hours

>{Decimal}</SetupTime>
56
                         <CleanupTime
CleanupTime

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
57
                    </Changeover>
58
                    <ProductionOperation>
59
                         <ProductionOperationId
ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>
60
                         <Name
Name

Name of production operation

>{String}</Name>
61
                         <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
62
                    </ProductionOperation>
63
               </ProductStructureOperation>
64
          </WorkOrderOperation>
65
     </ResourceGroupWorkOrderOperation>
66
     <Paging
Paging

Detailed paging information for this list.

>
67
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
70
          <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>
71
          <FirstPage
FirstPage

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

>{String}</FirstPage>
72
          <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>
73
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
74
          <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>
75
          <NextPage
NextPage

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

>{String}</NextPage>
76
          <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>
77
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
79
     </Paging>
80
</ResourceGroupWorkOrderOperations>
1
{
2
     "resourceGroupWorkOrderOperations": [
3
          {
4
               "latestWorkOrderProductOperation": {
5
                    "productUnit": {
6
                         "serialNumber
SerialNumber

Serial number of the product unit

": "{String}"
7
                    }
8
               },
9
               "workOrderOperation": {
10
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

": "{Integer}",
11
                    "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

": "{String}",
12
                    "status
Status

Production work order operation status

Possible domain values can be found here

": "{Integer}",
13
                    "plannedStartAt
PlannedStartAt

Date and time planned to start. Specified by the planned work order operation.

": "{Datetime}",
14
                    "plannedFinishedAt
PlannedFinishedAt

Date and time planned to finish. Specified by the planned work order operation.

": "{Datetime}",
15
                    "quantity
Quantity

Quantity of the work order operation

": "{Decimal}",
16
                    "processing": {
17
                         "isProcessingCompleted
IsProcessingCompleted

True if processing is completed

": "{Boolean}",
18
                         "plannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

": "{Decimal}",
19
                         "runTime
RunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}"
20
                    },
21
                    "changeover": {
22
                         "isSetupCompleted
IsSetupCompleted

True if setup changeover is completed

": "{Boolean}",
23
                         "setupTime
SetupTime

Time in hours used for setup changeover

": "{Decimal}",
24
                         "isCleanupCompleted
IsCleanupCompleted

True if cleanup changeover is completed

": "{Boolean}",
25
                         "cleanupTime
CleanupTime

Time in hours used for cleanup changeover

": "{Decimal}"
26
                    },
27
                    "productionWorkOrder": {
28
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
29
                         "customersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

": "{String}",
30
                         "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

": "{Date}",
31
                         "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

": "{Date}",
32
                         "productionFor": {
33
                              "object": {
34
                                   "customer": {
35
                                        "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ResourceGroupWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.ProductionFor.Object.Customer.Name in your request URI to get this field

": "{String}",
37
                                        "customerLink
CustomerLink

Customer reference

": "{String}"
38
                                   }
39
                              }
40
                         },
41
                         "location
Location

The location of the production.

": {
42
                              "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
43
                         },
44
                         "product": {
45
                              "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceGroupWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.Product.Description in your request URI to get this field

": "{String}",
48
                              "productLink
ProductLink

Product reference

": "{String}"
49
                         },
50
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
51
                    },
52
                    "productStructureOperation": {
53
                         "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

": "{Integer}",
54
                         "waitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

": "{Decimal}",
55
                         "changeover": {
56
                              "setupTime
SetupTime

Changeover pre/setup time in hours

": "{Decimal}",
57
                              "cleanupTime
CleanupTime

Changeover post/cleanup time in hours

": "{Decimal}"
58
                         },
59
                         "productionOperation": {
60
                              "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

": "{String}",
62
                              "productionOperationLink
ProductionOperationLink

Production operation reference

": "{String}"
63
                         }
64
                    }
65
               }
66
          }
67
     ],
68
     "paging
Paging

Detailed paging information for this list.

": {
69
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
72
          "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}",
73
          "firstPage
FirstPage

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

": "{String}",
74
          "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}",
75
          "previousPage
PreviousPage

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

": "{String}",
76
          "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}",
77
          "nextPage
NextPage

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

": "{String}",
78
          "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}",
79
          "lastPage
LastPage

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

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

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

": "{Integer}"
81
     }
82
}

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 99946 HTTP 400 {0}: Missing mandatory arguments {1}
Error 100207 HTTP 404 Production resource not found {0}