API

Production APIs

POST production/resources

Creates new production resource

HTTP method POST
URI https://api.rambase.net/production/resources
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 3300, version 18

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

Required/mandatory field

Name of production resource

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

Short name of production resource

This field is optional.

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

Description of production resource

This field is optional.

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

Defines the CLASS of the resource.

Applicable domain values can be found here

This field is optional.

>
{String}</Type>
6
     <AllowManHours
AllowManHours

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

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

>
{Boolean}</CalculateCostByPlannedHours>
9
     <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.

Default value: False

This field is optional.

>
{Boolean}</AssignToRestrictedStockLocations>
10
     <WorkOrderOperationGrouping
WorkOrderOperationGrouping

This field is optional.

>
11
          <AllowGrouping
AllowGrouping

Allows resource to use work order operation grouping

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

>
{Boolean}</DistributeHours>
13
     </WorkOrderOperationGrouping>
14
     <HourlyRates
HourlyRates

This field is optional.

>
15
          <Setup
Setup

Rate per hour for operations setup step.

Minimum value: 0

This field is optional.

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

Rate per hour for operations step

Minimum value: 0

This field is optional.

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

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

Minimum value: 0

This field is optional.

>
{Decimal}</CleanUp>
18
     </HourlyRates>
19
     <ProductionResourceGroup
ProductionResourceGroup

This field is optional.

>
20
          <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ProductionResourceGroupId>
21
     </ProductionResourceGroup>
22
</ProductionResource>
1
{
2
     "productionResource": {
3
          "name
Name

Required/mandatory field

Name of production resource

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

Short name of production resource

This field is optional.

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

Description of production resource

This field is optional.

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

Defines the CLASS of the resource.

Applicable domain values can be found here

This field is optional.

":
"{String}",
7
          "allowManHours
AllowManHours

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

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

":
"{Boolean}",
10
          "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.

Default value: False

This field is optional.

":
"{Boolean}",
11
          "workOrderOperationGrouping
WorkOrderOperationGrouping

This field is optional.

":
{
12
               "allowGrouping
AllowGrouping

Allows resource to use work order operation grouping

Default value: False

This field is optional.

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

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

Default value: False

This field is optional.

":
"{Boolean}"
14
          },
15
          "hourlyRates
HourlyRates

This field is optional.

":
{
16
               "setup
Setup

Rate per hour for operations setup step.

Minimum value: 0

This field is optional.

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

Rate per hour for operations step

Minimum value: 0

This field is optional.

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

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

Minimum value: 0

This field is optional.

":
"{Decimal}"
19
          },
20
          "productionResourceGroup
ProductionResourceGroup

This field is optional.

":
{
21
               "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
22
          }
23
     }
24
}

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

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
     <AllowManHours
AllowManHours

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

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

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

>
{Boolean}</AllowMultipleOperators>
11
     <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>
12
     <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>
13
     <WorkOrderOperationGrouping>
14
          <AllowGrouping
AllowGrouping

Allows resource to use work order operation grouping

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

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

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

Three character code following the ISO 4217 standard

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

Rate per hour for operations setup step.

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

Rate per hour for operations step

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

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

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

Production resource group identifier

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

Name of production resource group

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

Production resource group reference

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

Production work order operation identifier

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

Date and time work order operation actually started

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

Date and time of completion

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

Work order operation reference

>
{String}</WorkOrderOperationLink>
31
     </ProductionResourceGroup>
32
     <Condition>
33
          <Code
Code

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

Possible domain values can be found here

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

A description which explains a reason for setting production resource state

>
{String}</Note>
35
     </Condition>
36
</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
          "allowManHours
AllowManHours

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

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

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

":
"{Boolean}",
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}",
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}",
14
          "workOrderOperationGrouping": {
15
               "allowGrouping
AllowGrouping

Allows resource to use work order operation grouping

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

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

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

Three character code following the ISO 4217 standard

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

Rate per hour for operations setup step.

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

Rate per hour for operations step

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

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

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

Production resource group identifier

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

Name of production resource group

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

Production resource group reference

":
"{String}",
28
               "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Date and time work order operation actually started

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

Date and time of completion

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

Work order operation reference

":
"{String}"
32
          },
33
          "condition": {
34
               "code
Code

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

Possible domain values can be found here

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

A description which explains a reason for setting production resource state

":
"{String}"
36
          }
37
     }
38
}

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 106127 HTTP 404 Resource Hour Rate not found
Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 103379 HTTP 400 Update not allowed on active resource.
Error 103424 HTTP 400 Not a valid resource to update.
Error 100924 HTTP 400 Please remove all members before changing category
Error 103374 HTTP 400 Name for resource must be unique.
Error 103435 HTTP 400 You can only add a member that has an active status
Error 104093 HTTP 400 Cannot add resource group as member of resource group.
Error 104092 HTTP 404 Resource group does not exist.
Error 104541 HTTP 400 You cannot disable this setting when production resource has got at least one active work order operation group
Error 105799 HTTP 400 You cannot disable this setting when distirbute time on grouping is active
Error 105783 HTTP 400 You cannot enable this setting when production resource allowgrouping is not set
Error 104370 HTTP 400 Rate value should be greater or equal to zero