API

Production APIs

PUT production/work-orders/{productionWorkOrderId}

Updates the production work order data

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

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

This field is optional.

>
2
     <RequestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

This field is optional.

>{Date}</RequestedCompletionDate>
3
     <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

This field is optional.

>{Date}</ConfirmedCompletionDate>
4
     <IsConfirmedCompletionDateLocked
IsConfirmedCompletionDateLocked

If true, confirmed delivery date is locked.

This field is optional.

>{Boolean}</IsConfirmedCompletionDateLocked>
5
     <ScheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

This field is optional.

>{Date}</ScheduledStartDate>
6
     <ScheduledCompletionDate
ScheduledCompletionDate

Scheduled/planned date of production completion

This field is optional.

>{Date}</ScheduledCompletionDate>
7
     <Quantity
Quantity

The quantity that will be (or has been) produced

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
8
     <IsManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

This field is optional.

>{Boolean}</IsManufacturedInBatches>
9
     <ManufacturedProductName
ManufacturedProductName

Name of production work order item

This field is optional.

>{String}</ManufacturedProductName>
10
     <ProductUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

This field is optional.

>{String}</ProductUnitMarkingSpecification>
11
     <Department
Department

This field is optional.

>
12
          <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>{Integer}</DepartmentId>
13
     </Department>
14
     <FinanceProject
FinanceProject

This field is optional.

>
15
          <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>{Integer}</FinanceProjectId>
16
     </FinanceProject>
17
     <ProductionPlanner
ProductionPlanner

This field is optional.

>
18
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
19
     </ProductionPlanner>
20
     <Management
Management

This field is optional.

>
21
          <ProjectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

This field is optional.

>
22
               <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
23
          </ProjectLeader>
24
          <DocumentController
DocumentController

Reference to the employee who is a production management document controller.

This field is optional.

>
25
               <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
26
          </DocumentController>
27
     </Management>
28
</ProductionWorkOrder>
1
{
2
     "productionWorkOrder
ProductionWorkOrder

This field is optional.

": {
3
          "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

This field is optional.

": "{Date}",
4
          "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

This field is optional.

": "{Date}",
5
          "isConfirmedCompletionDateLocked
IsConfirmedCompletionDateLocked

If true, confirmed delivery date is locked.

This field is optional.

": "{Boolean}",
6
          "scheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

This field is optional.

": "{Date}",
7
          "scheduledCompletionDate
ScheduledCompletionDate

Scheduled/planned date of production completion

This field is optional.

": "{Date}",
8
          "quantity
Quantity

The quantity that will be (or has been) produced

Minimum value: 0

This field is optional.

": "{Decimal}",
9
          "isManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

This field is optional.

": "{Boolean}",
10
          "manufacturedProductName
ManufacturedProductName

Name of production work order item

This field is optional.

": "{String}",
11
          "productUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

This field is optional.

": "{String}",
12
          "department
Department

This field is optional.

": {
13
               "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

": "{Integer}"
14
          },
15
          "financeProject
FinanceProject

This field is optional.

": {
16
               "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

": "{Integer}"
17
          },
18
          "productionPlanner
ProductionPlanner

This field is optional.

": {
19
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
20
          },
21
          "management
Management

This field is optional.

": {
22
               "projectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

This field is optional.

": {
23
                    "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
24
               },
25
               "documentController
DocumentController

Reference to the employee who is a production management document controller.

This field is optional.

": {
26
                    "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
27
               }
28
          }
29
     }
30
}

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 100191 HTTP 404 Vatcode not found
Error 100475 HTTP 400 Project number is mandatory on all items.
Error 101488 HTTP 400 Illegal general ledger account : {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}