API

Production APIs

PUT production/work-order-operations/{workOrderOperationId}

Update work order operation details for provided identifier

HTTP method PUT
URI https://api.rambase.net/production/work-order-operations/{workOrderOperationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workOrderOperationId} Production work order operation identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2887, version 6

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

This field is optional.

>
2
     <CompletedQuantity
CompletedQuantity

Quantity completed in this work order operation

Minimum value: 0

This field is optional.

>
{Decimal}</CompletedQuantity>
3
     <ScrappedQuantity
ScrappedQuantity

Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.

Minimum value: 0

This field is optional.

>
{Decimal}</ScrappedQuantity>
4
     <ProductPlacement
ProductPlacement

The placement of the product after completed work order operation

This field is optional.

>
{String}</ProductPlacement>
5
     <HasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

This field is optional.

>
{Boolean}</HasPriority>
6
     <Note
Note

Text field used by operators to write information

This field is optional.

>
{String}</Note>
7
</WorkOrderOperation>
1
{
2
     "workOrderOperation
WorkOrderOperation

This field is optional.

":
{
3
          "completedQuantity
CompletedQuantity

Quantity completed in this work order operation

Minimum value: 0

This field is optional.

":
"{Decimal}",
4
          "scrappedQuantity
ScrappedQuantity

Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.

Minimum value: 0

This field is optional.

":
"{Decimal}",
5
          "productPlacement
ProductPlacement

The placement of the product after completed work order operation

This field is optional.

":
"{String}",
6
          "hasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

This field is optional.

":
"{Boolean}",
7
          "note
Note

Text field used by operators to write information

This field is optional.

":
"{String}"
8
     }
9
}

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.
$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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found