API

Production APIs

POST production/operations

Create new Production Operation

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

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
<ProductionOperation>
2
     <Name
Name

Required/mandatory field

Name of production operation

>{String}</Name>
3
     <Type
Type

Type of operation

Applicable domain values can be found here

This field is optional.

>{String}</Type>
4
     <Description
Description

Description of production operation

This field is optional.

>{String}</Description>
5
     <RequirePickingBeforeCompletion
RequirePickingBeforeCompletion

If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed

Default value: False

This field is optional.

>{Boolean}</RequirePickingBeforeCompletion>
6
     <RequireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

If this is checked, then all items in the tracelist for all product units needs to have serial number assigned

Default value: False

This field is optional.

>{Boolean}</RequireSerialNumberBeforeCompletion>
7
     <SetNextOperationReadyTrigger
SetNextOperationReadyTrigger

This field is optional.

>
8
          <Value
Value

Value for degree of completion you require in order to automatically set next operation as ready

Minimum value: 0

This field is optional.

>{Decimal}</Value>
9
          <Unit
Unit

Unit for degree of completion you require in order to automatically set next operation as ready

Applicable domain values can be found here

This field is optional.

>{String}</Unit>
10
     </SetNextOperationReadyTrigger>
11
     <AppliesTo
AppliesTo

Tells if the production operation applies to a production resource or production resource group

This field is optional.

>
12
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
13
          <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{String}</ObjectId>
14
     </AppliesTo>
15
     <Processing
Processing

This field is optional.

>
16
          <RunTime
RunTime

Planned run time in hours for the production operation

Minimum value: 0

This field is optional.

>{Decimal}</RunTime>
17
     </Processing>
18
     <Changeover
Changeover

This field is optional.

>
19
          <SetUpTime
SetUpTime

Planned setup time in hours for the production operation

Minimum value: 0

This field is optional.

>{Decimal}</SetUpTime>
20
          <CleanUpTime
CleanUpTime

Planned cleanup time in hours for the production operation

Minimum value: 0

This field is optional.

>{Decimal}</CleanUpTime>
21
     </Changeover>
22
     <Checkpoint
Checkpoint

This field is optional.

>
23
          <HasCheckpoint
HasCheckpoint

Has the value of 1 if the production operation has a checkpoint set

Default value: False

This field is optional.

>{Boolean}</HasCheckpoint>
24
          <Description
Description

The checkpoint text

This field is optional.

>{String}</Description>
25
     </Checkpoint>
26
     <ServiceInterval
ServiceInterval

This field is optional.

>
27
          <ServiceIntervalId
ServiceIntervalId

Service interval identifier

Minimum value: 100000

This field is optional.

>{Integer}</ServiceIntervalId>
28
     </ServiceInterval>
29
</ProductionOperation>
1
{
2
     "productionOperation": {
3
          "name
Name

Required/mandatory field

Name of production operation

": "{String}",
4
          "type
Type

Type of operation

Applicable domain values can be found here

This field is optional.

": "{String}",
5
          "description
Description

Description of production operation

This field is optional.

": "{String}",
6
          "requirePickingBeforeCompletion
RequirePickingBeforeCompletion

If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed

Default value: False

This field is optional.

": "{Boolean}",
7
          "requireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

If this is checked, then all items in the tracelist for all product units needs to have serial number assigned

Default value: False

This field is optional.

": "{Boolean}",
8
          "setNextOperationReadyTrigger
SetNextOperationReadyTrigger

This field is optional.

": {
9
               "value
Value

Value for degree of completion you require in order to automatically set next operation as ready

Minimum value: 0

This field is optional.

": "{Decimal}",
10
               "unit
Unit

Unit for degree of completion you require in order to automatically set next operation as ready

Applicable domain values can be found here

This field is optional.

": "{String}"
11
          },
12
          "appliesTo
AppliesTo

Tells if the production operation applies to a production resource or production resource group

This field is optional.

": {
13
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}",
14
               "objectId
ObjectId

Identifier of the object

This field is optional.

": "{String}"
15
          },
16
          "processing
Processing

This field is optional.

": {
17
               "runTime
RunTime

Planned run time in hours for the production operation

Minimum value: 0

This field is optional.

": "{Decimal}"
18
          },
19
          "changeover
Changeover

This field is optional.

": {
20
               "setUpTime
SetUpTime

Planned setup time in hours for the production operation

Minimum value: 0

This field is optional.

": "{Decimal}",
21
               "cleanUpTime
CleanUpTime

Planned cleanup time in hours for the production operation

Minimum value: 0

This field is optional.

": "{Decimal}"
22
          },
23
          "checkpoint
Checkpoint

This field is optional.

": {
24
               "hasCheckpoint
HasCheckpoint

Has the value of 1 if the production operation has a checkpoint set

Default value: False

This field is optional.

": "{Boolean}",
25
               "description
Description

The checkpoint text

This field is optional.

": "{String}"
26
          },
27
          "serviceInterval
ServiceInterval

This field is optional.

": {
28
               "serviceIntervalId
ServiceIntervalId

Service interval identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
29
          }
30
     }
31
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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
<ProductionOperation>
2
     <ProductionOperationId
ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>
3
     <Status
Status

Status of production operation

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of production operation

>{String}</Name>
6
     <Type
Type

Type of operation

Possible domain values can be found here

>{String}</Type>
7
     <Description
Description

Description of production operation

>{String}</Description>
8
     <RequirePickingBeforeCompletion
RequirePickingBeforeCompletion

If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed

>{Boolean}</RequirePickingBeforeCompletion>
9
     <RequireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

If this is checked, then all items in the tracelist for all product units needs to have serial number assigned

>{Boolean}</RequireSerialNumberBeforeCompletion>
10
     <SetNextOperationReadyTrigger>
11
          <Value
Value

Value for degree of completion you require in order to automatically set next operation as ready

>{Decimal}</Value>
12
          <Unit
Unit

Unit for degree of completion you require in order to automatically set next operation as ready

Possible domain values can be found here

>{String}</Unit>
13
     </SetNextOperationReadyTrigger>
14
     <AppliesTo
AppliesTo

Tells if the production operation applies to a production resource or production resource group

>
15
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
16
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
17
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
18
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
19
     </AppliesTo>
20
     <Processing>
21
          <RunTime
RunTime

Planned run time in hours for the production operation

>{Decimal}</RunTime>
22
     </Processing>
23
     <Changeover>
24
          <SetUpTime
SetUpTime

Planned setup time in hours for the production operation

>{Decimal}</SetUpTime>
25
          <CleanUpTime
CleanUpTime

Planned cleanup time in hours for the production operation

>{Decimal}</CleanUpTime>
26
     </Changeover>
27
     <ProductForOutsourcedOperation
ProductForOutsourcedOperation

Product reference that is used when purchasing the outsourced production operation

>
28
          <ProductId
ProductId

Product identifier

>{String}</ProductId>
29
          <Name
Name

Name of the product

>{String}</Name>
30
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
31
     </ProductForOutsourcedOperation>
32
     <Checkpoint>
33
          <HasCheckpoint
HasCheckpoint

Has the value of 1 if the production operation has a checkpoint set

>{Boolean}</HasCheckpoint>
34
          <Description
Description

The checkpoint text

>{String}</Description>
35
     </Checkpoint>
36
     <ServiceInterval>
37
          <ServiceIntervalId
ServiceIntervalId

Service interval identifier

>{Integer}</ServiceIntervalId>
38
          <Name
Name

Name of the service interval

>{String}</Name>
39
          <Interval>
40
               <Value
Value

Length/quantity/value of the interval

>{Decimal}</Value>
41
               <Unit
Unit

Unit of the interval

Possible domain values can be found here

>{String}</Unit>
42
          </Interval>
43
          <ServiceIntervalLink
ServiceIntervalLink

Service interval reference

>{String}</ServiceIntervalLink>
44
     </ServiceInterval>
45
</ProductionOperation>
1
{
2
     "productionOperation": {
3
          "productionOperationId
ProductionOperationId

Production operation identifier

": "{Integer}",
4
          "status
Status

Status of production operation

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of production operation

": "{String}",
7
          "type
Type

Type of operation

Possible domain values can be found here

": "{String}",
8
          "description
Description

Description of production operation

": "{String}",
9
          "requirePickingBeforeCompletion
RequirePickingBeforeCompletion

If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed

": "{Boolean}",
10
          "requireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

If this is checked, then all items in the tracelist for all product units needs to have serial number assigned

": "{Boolean}",
11
          "setNextOperationReadyTrigger": {
12
               "value
Value

Value for degree of completion you require in order to automatically set next operation as ready

": "{Decimal}",
13
               "unit
Unit

Unit for degree of completion you require in order to automatically set next operation as ready

Possible domain values can be found here

": "{String}"
14
          },
15
          "appliesTo
AppliesTo

Tells if the production operation applies to a production resource or production resource group

": {
16
               "objectType
ObjectType

Type of object

": "{String}",
17
               "objectId
ObjectId

Identifier of the object

": "{String}",
18
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
19
               "objectLink
ObjectLink

API reference to the object

": "{String}"
20
          },
21
          "processing": {
22
               "runTime
RunTime

Planned run time in hours for the production operation

": "{Decimal}"
23
          },
24
          "changeover": {
25
               "setUpTime
SetUpTime

Planned setup time in hours for the production operation

": "{Decimal}",
26
               "cleanUpTime
CleanUpTime

Planned cleanup time in hours for the production operation

": "{Decimal}"
27
          },
28
          "productForOutsourcedOperation
ProductForOutsourcedOperation

Product reference that is used when purchasing the outsourced production operation

": {
29
               "productId
ProductId

Product identifier

": "{String}",
30
               "name
Name

Name of the product

": "{String}",
31
               "productLink
ProductLink

Product reference

": "{String}"
32
          },
33
          "checkpoint": {
34
               "hasCheckpoint
HasCheckpoint

Has the value of 1 if the production operation has a checkpoint set

": "{Boolean}",
35
               "description
Description

The checkpoint text

": "{String}"
36
          },
37
          "serviceInterval": {
38
               "serviceIntervalId
ServiceIntervalId

Service interval identifier

": "{Integer}",
39
               "name
Name

Name of the service interval

": "{String}",
40
               "interval": {
41
                    "value
Value

Length/quantity/value of the interval

": "{Decimal}",
42
                    "unit
Unit

Unit of the interval

Possible domain values can be found here

": "{String}"
43
               },
44
               "serviceIntervalLink
ServiceIntervalLink

Service interval reference

": "{String}"
45
          }
46
     }
47
}

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 103158 HTTP 400 It is not allowed to change product in a shipping advice item
Error 107812 HTTP 400 End customer not found
Error 107813 HTTP 400 The end customer is not active
Error 100199 HTTP 404 Location is not found
Error 108137 HTTP 400 Standard ManhourRate is not set for Resource
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 109643 HTTP 400 Safetystock cannot be greater than maximumstock
Error 103478 HTTP 400 Purchase price is required
Error 102109 HTTP 400 Supplier is required
Error 100047 HTTP 404 Supplier not found
Error 101097 HTTP 404 Given currency {0} mismatch with currencies of supplier {1}
Error 103551 HTTP 400 IsManufacturedInBatches can only be changed on product structures
Error 103554 HTTP 400 AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures
Error 104253 HTTP 400 ProduceInMultipleOf can only be changed on product structures.
Error 107694 HTTP 400 Use line production can only be changed on product structeres
Error 106999 HTTP 400 Sub module 'Projectorder' is not activated in this company
Error 106436 HTTP 400 Unit can only be changed when status is equal to draft (status 1)
Error 100167 HTTP 404 Measurement unit not found
Error 104486 HTTP 400 Unit production is only allowed for measurment units (UNI) of type QTY
Error 100200 HTTP 404 Special handling code not found
Error 100092 HTTP 404 Service template not found
Error 103020 HTTP 404 Qcdoc not found
Error 101091 HTTP 404 Contry of origin is not valid: {0}
Error 101124 HTTP 400 Hardware code already exists
Error 106437 HTTP 400 Type can not be changed when status is not equal to draft (status 1)
Error 106680 HTTP 400 Not allowed when product is of subscription sales type
Error 101009 HTTP 400 The product has a structure. You can only change the product type to a type that can contain a structure.
Error 101010 HTTP 400 The product structure contains operations and can not be changed to become a phantom structure
Error 101008 HTTP 400 Cannot change product type from a physical type to a virtual type
Error 101007 HTTP 400 Cannot change product type from a virtual type to a physical type
Error 108988 HTTP 400 Sales type can not be changed when status is equal to completed(status 9)
Error 109184 HTTP 400 Sales type can not be changed to Subscription from other types.
Error 109185 HTTP 400 Sales type can not be changed to other types from Subscription.
Error 109180 HTTP 400 Sales type can not be changed from Rental/Sale to Sales
Error 103021 HTTP 400 Linkid must be a rental product
Error 104760 HTTP 400 Costing method can't be changed after product has been received
Error 104652 HTTP 400 Both minimum sales price and minimum sales price currency must be given
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 104653 HTTP 400 Minimum sales price can not be negative
Error 106506 HTTP 404 Image not found