Production APIs
Key figures for production work orders
HTTP method | GET |
URI | https://api.rambase.net/production/work-orders/key-figures?groupBy={groupBy} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 3775, version 9 |
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.
groupBy String, optional |
GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)
Default: Status |
$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.
ForwardedFromObjectId Integer | The preceding/previous/source item. |
ForwardedFromObjectType String | The preceding/previous/source item. |
HasPriority String | Production Work Order priority. |
IsOnHold Boolean | Flag to indicate if production work order is on hold. |
LocationShortName String | Unique abbreviation/short name of the location. |
ManufacturingAreaId Integer | Manufacturing area identifier. |
ManufacturingAreaName String | Name of manufacturing area. |
PlannerId Integer | Employee identifier. Available macros: currentUser() |
PlanningCategory String | Planning category. |
ProductionWorkOrderId Integer | Production work order identifier. |
ProductName String | Name of the product. |
Quantity Decimal | The quantity that will be (or has been) produced. |
RemainingQuantity Decimal | Remaining number of units to produce. |
ScheduledStartDate Date | Scheduled/planned date of production start. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
ScrapReason Integer | Reason for scrapping. |
Status Integer | Status of production work order. |
Type String | Type of production work order. |
Read more about filters and sorting on how to use sortable parameters
ForwardedFromObjectId Integer | The preceding/previous/source item. |
ForwardedFromObjectType String | The preceding/previous/source item. |
HasPriority String | Production Work Order priority |
IsOnHold Boolean | Flag to indicate if production work order is on hold |
ManufacturingAreaId Integer | Manufacturing area identifier |
PlannerId Integer | Employee identifier |
PlanningCategory String | Planning category |
Quantity Decimal | The quantity that will be (or has been) produced |
RemainingQuantity Decimal | Remaining number of units to produce |
ScheduledStartDate Date | Scheduled/planned date of production start |
ScrapReason Integer | Reason for scrapping |
Type String | Type of production work order |
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.
Key
GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)
>{String}</Key>Description
Description of the key.
>{String}</Description>Occurrences
Number of occurrences with the specified key.
>{Integer}</Occurrences>TotalRemainingQuantity
Sum of the net quantity of selected production work orders
>{Decimal}</TotalRemainingQuantity>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Key
GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)
": "{String}",Description
Description of the key.
": "{String}",Occurrences
Number of occurrences with the specified key.
": "{Integer}",TotalRemainingQuantity
Sum of the net quantity of selected production work orders
": "{Decimal}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 103241 HTTP 400 | Invalid group by |