API

Production APIs

POST production/work-orders

Create new production work order

HTTP method POST
URI https://api.rambase.net/production/work-orders
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 4856, version 4

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>
2
     <Product>
3
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>{Integer}</ProductId>
4
     </Product>
5
     <RequestedCompletionDate
RequestedCompletionDate

Required/mandatory field

The requested date of completion for the production work order.

>{Date}</RequestedCompletionDate>
6
     <Quantity
Quantity

Required/mandatory field

The quantity that will be (or has been) produced

Minimum value: 0

>{Decimal}</Quantity>
7
     <ManufacturingArea
ManufacturingArea

This field is optional.

>
8
          <ManufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturingAreaId>
9
     </ManufacturingArea>
10
     <Location
Location

The location of the production.

This field is optional.

>
11
          <ShortName
ShortName

Unique abbreviation/short name of the location

This field is optional.

>{String}</ShortName>
12
     </Location>
13
</ProductionWorkOrder>
1
{
2
     "productionWorkOrder": {
3
          "product": {
4
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

": "{Integer}"
5
          },
6
          "requestedCompletionDate
RequestedCompletionDate

Required/mandatory field

The requested date of completion for the production work order.

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

Required/mandatory field

The quantity that will be (or has been) produced

Minimum value: 0

": "{Decimal}",
8
          "manufacturingArea
ManufacturingArea

This field is optional.

": {
9
               "manufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
10
          },
11
          "location
Location

The location of the production.

This field is optional.

": {
12
               "shortName
ShortName

Unique abbreviation/short name of the location

This field is optional.

": "{String}"
13
          }
14
     }
15
}

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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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.

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 100089 HTTP 404 Product {0} 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 109539 HTTP 400 Dimension value {0} could not be used : Check its FromPeriod and ToPeriod.
Error 102486 HTTP 400 Invalid value for dimension {0}