API

Production APIs

POST system/api/api-operations/100296

See AOP

HTTP method POST
URI https://api.rambase.net/system/api/api-operations/100296
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 2437, 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.

Format:
1
<Parameters
Parameters

This field is optional.

>
2
     <ReleaseForProduction
ReleaseForProduction

If true, the orders should be released for production (batch parameter, not dictionary field).

This field is optional.

>{Boolean}</ReleaseForProduction>
3
     <NewScheduledStartDate
NewScheduledStartDate

Specifies a new scheduled start date on the production work order beeing splitted.

This field is optional.

>{Date}</NewScheduledStartDate>
4
     <ProductionWorkOrders
ProductionWorkOrders

This field is optional.

>
5
          <ProductionWorkOrder
ProductionWorkOrder

This field is optional.

>
6
               <ScheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

This field is optional.

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

The quantity that will be (or has been) produced

This field is optional.

>{Decimal}</Quantity>
8
          </ProductionWorkOrder>
9
     </ProductionWorkOrders>
10
</Parameters>
1
{
2
     "parameters
Parameters

This field is optional.

": {
3
          "releaseForProduction
ReleaseForProduction

If true, the orders should be released for production (batch parameter, not dictionary field).

This field is optional.

": "{Boolean}",
4
          "newScheduledStartDate
NewScheduledStartDate

Specifies a new scheduled start date on the production work order beeing splitted.

This field is optional.

": "{Date}",
5
          "productionWorkOrders
ProductionWorkOrders

This field is optional.

": [
6
               {
7
                    "scheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

This field is optional.

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

The quantity that will be (or has been) produced

This field is optional.

": "{Decimal}"
9
               }
10
          ]
11
     }
12
}

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]

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 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 104580 HTTP 400 This product should be produced in multiplies of {0}.
Error 106539 HTTP 400 Quantity of splitted units can not be greater than remaining number of units to produce