Production APIs
Production resource group details
| HTTP method | GET |
| URI | https://api.rambase.net/production/resource-groups/{productionResourceGroupId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionResourceGroupId} |
Production resource group identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2857, version 17 |
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.
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. |
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.
ProductionResourceGroupId
Production resource group identifier
>{Integer}</ProductionResourceGroupId>Status
Status of production resource group
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of production resource group
>{String}</Name>ShortName
Shortname for resource group.
>{String}</ShortName>Description
Description of production resource group
>{String}</Description>Type
Defines the CLASS of the resource group
Possible domain values can be found here
>{String}</Type>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>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Setup
Estimated rate per hour for operations setup step, given in system currency.
>{Decimal}</Setup>Processing
Estimated rate per hour for operations main step, given in system currency.
>{Decimal}</Processing>CleanUp
Estimated rate per hour for operations post step, given in system currency.
>{Decimal}</CleanUp>ProductionResourceGroupId
Production resource group identifier
": "{Integer}",Status
Status of production resource group
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of production resource group
": "{String}",ShortName
Shortname for resource group.
": "{String}",Description
Description of production resource group
": "{String}",Type
Defines the CLASS of the resource group
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}",Currency
Three character code following the ISO 4217 standard
": "{String}",Setup
Estimated rate per hour for operations setup step, given in system currency.
": "{Decimal}",Processing
Estimated rate per hour for operations main step, given in system currency.
": "{Decimal}",CleanUp
Estimated rate per hour for operations post step, given in system currency.
": "{Decimal}"
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 103366 HTTP 404 | Production resource group not found. |