API

Production APIs

GET production/resources/{productionResourceId}

Production resource details for provided identifier

HTTP method GET
URI https://api.rambase.net/production/resources/{productionResourceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceId} Production resource identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 556, version 33

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<ProductionResource>
2
     <ProductionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of production resource

>{String}</Name>
6
     <ShortName
ShortName

Short name of production resource

>{String}</ShortName>
7
     <Description
Description

Description of production resource

>{String}</Description>
8
     <Type
Type

Defines the CLASS of the resource.

Possible domain values can be found here

>{String}</Type>
9
     <LoadPercent
LoadPercent

Calculated load in percent of the production resource for current date

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

>{Decimal}</LoadPercent>
10
     <AllowManHours
AllowManHours

True if man hours can be added to the work log of work order operations

>{Boolean}</AllowManHours>
11
     <AllowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

>{Boolean}</AllowMultipleOperators>
12
     <CalculateCostByPlannedHours
CalculateCostByPlannedHours

(RW) Value = 1: Operation cost is calculated based on planned operation hours. Value = 0 (default): Operation cost is calculated by logged hours.

>{Boolean}</CalculateCostByPlannedHours>
13
     <AssignToRestrictedStockLocations
AssignToRestrictedStockLocations

If is set to 1 then the program will check if the production work order are assigned to goods reception items in the restricted stock locations. If not then a “swap” in assignments is done to a goods reception item which has enough goods in the restricted stock locations. If this can not be done then an error message is displayed.

>{Boolean}</AssignToRestrictedStockLocations>
14
     <WorkOrderOperationGrouping>
15
          <AllowGrouping
AllowGrouping

Allows resource to use work order operation grouping

>{Boolean}</AllowGrouping>
16
          <DistributeHours
DistributeHours

If set to 1 the time logged on the operation is distributed on all woo's.

>{Boolean}</DistributeHours>
17
     </WorkOrderOperationGrouping>
18
     <HourlyRates>
19
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
20
          <Setup
Setup

Rate per hour for operations setup step.

>{Decimal}</Setup>
21
          <Processing
Processing

Rate per hour for operations step

>{Decimal}</Processing>
22
          <CleanUp
CleanUp

Rate per hour for operations post step, given in system currency.

>{Decimal}</CleanUp>
23
     </HourlyRates>
24
     <ProductionResourceGroup>
25
          <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

>{Integer}</ProductionResourceGroupId>
26
          <Name
Name

Name of production resource group

>{String}</Name>
27
          <ProductionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

>{String}</ProductionResourceGroupLink>
28
     </ProductionResourceGroup>
29
     <LastWorkOrderOperation
LastWorkOrderOperation

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

>
30
          <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

>{Integer}</WorkOrderOperationId>
31
          <StartedAt
StartedAt

Date and time work order operation actually started

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

>{Datetime}</StartedAt>
32
          <FinishedAt
FinishedAt

Date and time of completion

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

>{Datetime}</FinishedAt>
33
          <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

>{String}</WorkOrderOperationLink>
34
     </LastWorkOrderOperation>
35
     <Condition>
36
          <Code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

>{Integer}</Code>
37
          <Note
Note

A description which explains a reason for setting production resource state

>{String}</Note>
38
     </Condition>
39
</ProductionResource>
1
{
2
     "productionResource": {
3
          "productionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of production resource

": "{String}",
7
          "shortName
ShortName

Short name of production resource

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

Description of production resource

": "{String}",
9
          "type
Type

Defines the CLASS of the resource.

Possible domain values can be found here

": "{String}",
10
          "loadPercent
LoadPercent

Calculated load in percent of the production resource for current date

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

": "{Decimal}",
11
          "allowManHours
AllowManHours

True if man hours can be added to the work log of work order operations

": "{Boolean}",
12
          "allowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

": "{Boolean}",
13
          "calculateCostByPlannedHours
CalculateCostByPlannedHours

(RW) Value = 1: Operation cost is calculated based on planned operation hours. Value = 0 (default): Operation cost is calculated by logged hours.

": "{Boolean}",
14
          "assignToRestrictedStockLocations
AssignToRestrictedStockLocations

If is set to 1 then the program will check if the production work order are assigned to goods reception items in the restricted stock locations. If not then a “swap” in assignments is done to a goods reception item which has enough goods in the restricted stock locations. If this can not be done then an error message is displayed.

": "{Boolean}",
15
          "workOrderOperationGrouping": {
16
               "allowGrouping
AllowGrouping

Allows resource to use work order operation grouping

": "{Boolean}",
17
               "distributeHours
DistributeHours

If set to 1 the time logged on the operation is distributed on all woo's.

": "{Boolean}"
18
          },
19
          "hourlyRates": {
20
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
21
               "setup
Setup

Rate per hour for operations setup step.

": "{Decimal}",
22
               "processing
Processing

Rate per hour for operations step

": "{Decimal}",
23
               "cleanUp
CleanUp

Rate per hour for operations post step, given in system currency.

": "{Decimal}"
24
          },
25
          "productionResourceGroup": {
26
               "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

": "{String}",
28
               "productionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

": "{String}"
29
          },
30
          "lastWorkOrderOperation
LastWorkOrderOperation

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

": {
31
               "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

": "{Integer}",
32
               "startedAt
StartedAt

Date and time work order operation actually started

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

": "{Datetime}",
33
               "finishedAt
FinishedAt

Date and time of completion

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

": "{Datetime}",
34
               "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

": "{String}"
35
          },
36
          "condition": {
37
               "code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

": "{Integer}",
38
               "note
Note

A description which explains a reason for setting production resource state

": "{String}"
39
          }
40
     }
41
}

Possible error codes the response might return:

Error 103366 HTTP 404 Production resource group not found.
Error 100207 HTTP 404 Production resource not found {0}