Production APIs
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.
Name
Required/mandatory field
Name of production resource
>{String}</Name>ShortName
Short name of production resource
This field is optional.
>{String}</ShortName>Description
Description of production resource
This field is optional.
>{String}</Description>Type
Defines the CLASS of the resource.
Applicable domain values can be found here
This field is optional.
>{String}</Type>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>AllowMultipleOperators
True if multiple operators can work with one work order operation.
Default value: False
This field is optional.
>{Boolean}</AllowMultipleOperators>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>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>WorkOrderOperationGrouping
This field is optional.
>AllowGrouping
Allows resource to use work order operation grouping
Default value: False
This field is optional.
>{Boolean}</AllowGrouping>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>HourlyRates
This field is optional.
>Setup
Rate per hour for operations setup step.
Minimum value: 0
This field is optional.
>{Decimal}</Setup>Processing
Rate per hour for operations step
Minimum value: 0
This field is optional.
>{Decimal}</Processing>CleanUp
Rate per hour for operations post step, given in system currency.
Minimum value: 0
This field is optional.
>{Decimal}</CleanUp>ProductionResourceGroup
This field is optional.
>ProductionResourceGroupId
Production resource group identifier
Minimum value: 100000
This field is optional.
>{Integer}</ProductionResourceGroupId>Name
Required/mandatory field
Name of production resource
": "{String}",ShortName
Short name of production resource
This field is optional.
": "{String}",Description
Description of production resource
This field is optional.
": "{String}",Type
Defines the CLASS of the resource.
Applicable domain values can be found here
This field is optional.
": "{String}",AllowManHours
True if man hours can be added to the work log of work order operations
Default value: False
This field is optional.
": "{Boolean}",AllowMultipleOperators
True if multiple operators can work with one work order operation.
Default value: False
This field is optional.
": "{Boolean}",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}",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}",WorkOrderOperationGrouping
This field is optional.
": {AllowGrouping
Allows resource to use work order operation grouping
Default value: False
This field is optional.
": "{Boolean}",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}"HourlyRates
This field is optional.
": {Setup
Rate per hour for operations setup step.
Minimum value: 0
This field is optional.
": "{Decimal}",Processing
Rate per hour for operations step
Minimum value: 0
This field is optional.
": "{Decimal}",CleanUp
Rate per hour for operations post step, given in system currency.
Minimum value: 0
This field is optional.
": "{Decimal}"ProductionResourceGroup
This field is optional.
": {ProductionResourceGroupId
Production resource group identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
ProductionResourceId
Production resource identifier
>{Integer}</ProductionResourceId>Status
Status of production resource
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of production resource
>{String}</Name>ShortName
Short name of production resource
>{String}</ShortName>Description
Description of production resource
>{String}</Description>AllowManHours
True if man hours can be added to the work log of work order operations
>{Boolean}</AllowManHours>AllowMultipleOperators
True if multiple operators can work with one work order operation.
>{Boolean}</AllowMultipleOperators>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>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>AllowGrouping
Allows resource to use work order operation grouping
>{Boolean}</AllowGrouping>DistributeHours
If set to 1 the time logged on the operation is distributed on all woo's.
>{Boolean}</DistributeHours>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Setup
Rate per hour for operations setup step.
>{Decimal}</Setup>Processing
Rate per hour for operations step
>{Decimal}</Processing>CleanUp
Rate per hour for operations post step, given in system currency.
>{Decimal}</CleanUp>ProductionResourceGroupId
Production resource group identifier
>{Integer}</ProductionResourceGroupId>Name
Name of production resource group
>{String}</Name>ProductionResourceGroupLink
Production resource group reference
>{String}</ProductionResourceGroupLink>WorkOrderOperationId
Production work order operation identifier
>{Integer}</WorkOrderOperationId>StartedAt
Date and time work order operation actually started
>{Datetime}</StartedAt>FinishedAt
Date and time of completion
>{Datetime}</FinishedAt>WorkOrderOperationLink
Work order operation reference
>{String}</WorkOrderOperationLink>Code
A number which indicates production resource state, 0=OK, 10=warning, 20=stopped
Possible domain values can be found here
>{Integer}</Code>Note
A description which explains a reason for setting production resource state
>{String}</Note>ProductionResourceId
Production resource identifier
": "{Integer}",Status
Status of production resource
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of production resource
": "{String}",ShortName
Short name of production resource
": "{String}",Description
Description of production resource
": "{String}",Type
Defines the CLASS of the resource.
Possible domain values can be found here
": "{String}",AllowManHours
True if man hours can be added to the work log of work order operations
": "{Boolean}",AllowMultipleOperators
True if multiple operators can work with one work order operation.
": "{Boolean}",CalculateCostByPlannedHours
(RW) Value = 1: Operation cost is calculated based on planned operation hours. Value = 0 (default): Operation cost is calculated by logged hours.
": "{Boolean}",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}",AllowGrouping
Allows resource to use work order operation grouping
": "{Boolean}",DistributeHours
If set to 1 the time logged on the operation is distributed on all woo's.
": "{Boolean}"Currency
Three character code following the ISO 4217 standard
": "{String}",Setup
Rate per hour for operations setup step.
": "{Decimal}",Processing
Rate per hour for operations step
": "{Decimal}",CleanUp
Rate per hour for operations post step, given in system currency.
": "{Decimal}"ProductionResourceGroupId
Production resource group identifier
": "{Integer}",Name
Name of production resource group
": "{String}",ProductionResourceGroupLink
Production resource group reference
": "{String}",WorkOrderOperationId
Production work order operation identifier
": "{Integer}",StartedAt
Date and time work order operation actually started
": "{Datetime}",FinishedAt
Date and time of completion
": "{Datetime}",WorkOrderOperationLink
Work order operation reference
": "{String}"Code
A number which indicates production resource state, 0=OK, 10=warning, 20=stopped
Possible domain values can be found here
": "{Integer}",Note
A description which explains a reason for setting production resource state
": "{String}"
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 |