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 100178 HTTP 404 Dimension not found
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 105970 HTTP 400 End date is required
Error 106563 HTTP 400 This product is blocked for shipping
Error 100199 HTTP 404 Location not found
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}