Production APIs
Local Rework Report
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/111152/result-set |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5641, version 3 |
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.
| $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.
| FinishedAt Datetime | Date and time of completion. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| OperationId Integer | Production operation identifier. |
| OperationName String | Name of production operation. |
| ProcessingCost Decimal | The cost required to process a piece or lot at a specific operation. |
| ProcessingRunTime Decimal | The time required to process a piece or lot at a specific operation. Specified in hours. |
| ProductId Integer | Product identifier. |
| ProductionWorkOrderId Integer | Production work order identifier. |
| ProductName String | Name of the product. |
| StartedAt Datetime | Date and time work order operation actually started. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| WorkOrderOperationId Integer | Production work order operation identifier. |
Read more about filters and sorting on how to use sortable parameters
| FinishedAt Datetime | Date and time of completion |
| OperationId Integer | Production operation identifier |
| OperationName String | Name of production operation |
| ProcessingCost Decimal | The cost required to process a piece or lot at a specific operation. |
| ProcessingRunTime Decimal | The time required to process a piece or lot at a specific operation. Specified in hours. |
| ProductId Integer | Product identifier |
| ProductionWorkOrderId Integer | Production work order identifier |
| ProductName String | Name of the product |
| StartedAt Datetime | Date and time work order operation actually started |
| WorkOrderOperationId Integer | Production work order operation identifier |
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.
ProductionWorkOrder
Production work order reference
>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>RemainingQuantity
Remaining number of units to produce
>{Decimal}</RemainingQuantity>ProductionOperation
Production operation reference
>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>StartedAt
Date and time work order operation actually started
>{Datetime}</StartedAt>FinishedAt
Date and time of completion
>{Datetime}</FinishedAt>ProcessingRunTime
The time required to process a piece or lot at a specific operation. Specified in hours.
>{Decimal}</ProcessingRunTime>ProcessingCost
The cost required to process a piece or lot at a specific operation.
>{Decimal}</ProcessingCost>ReopenedQuantity
Quantity that has been reopened for rework
ReopenReason
Description of the name/value/code/key
>{String}</ReopenReason>LoggedReopenHours
Hours logged for rework
>{Decimal}</LoggedReopenHours>TotalReworkCost
Total cost of rework
>{Decimal}</TotalReworkCost>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>ProductionWorkOrder
Production work order reference
": {ProductionWorkOrderId
Production work order identifier
": "{Integer}",ProductionWorkOrderLink
Production work order reference
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"RemainingQuantity
Remaining number of units to produce
": "{Decimal}",ProductionOperation
Production operation reference
": {ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"StartedAt
Date and time work order operation actually started
": "{Datetime}",FinishedAt
Date and time of completion
": "{Datetime}",ProcessingRunTime
The time required to process a piece or lot at a specific operation. Specified in hours.
": "{Decimal}",ProcessingCost
The cost required to process a piece or lot at a specific operation.
": "{Decimal}",ReopenedQuantity
Quantity that has been reopened for rework
ReopenReason
Description of the name/value/code/key
": "{String}",LoggedReopenHours
Hours logged for rework
": "{Decimal}",TotalReworkCost
Total cost of rework
": "{Decimal}",TargetApplication
Application reference when inspecting a line in a report.
": "{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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |