API

Product APIs

POST product/structure-versions/{productStructureVersionId}/operations

API resource to append a new product structure operation

HTTP method POST
URI https://api.rambase.net/product/structure-versions/{productStructureVersionId}/operations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productStructureVersionId} Product structure identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 7087, version 7

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
<ProductStructureOperation>
2
     <SequenceNumber
SequenceNumber

Required/mandatory field

Sequence number of the product structure operation. Unique within a product structure.

Minimum value: 1

>{Integer}</SequenceNumber>
3
     <WaitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

Minimum value: 0

This field is optional.

>{Decimal}</WaitTime>
4
     <Note
Note

Note for product structure operation

This field is optional.

>{String}</Note>
5
     <NoteToOperator
NoteToOperator

Operation information to operator

This field is optional.

>{String}</NoteToOperator>
6
     <Processing
Processing

This field is optional.

>
7
          <RunTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

Minimum value: 0

This field is optional.

>{Decimal}</RunTime>
8
     </Processing>
9
     <Changeover
Changeover

This field is optional.

>
10
          <SetupTime
SetupTime

Changeover pre/setup time in hours

Minimum value: 0

This field is optional.

>{Decimal}</SetupTime>
11
          <CleanupTime
CleanupTime

Changeover post/cleanup time in hours

Minimum value: 0

This field is optional.

>{Decimal}</CleanupTime>
12
     </Changeover>
13
     <ManHours
ManHours

This field is optional.

>
14
          <TotalTime
TotalTime

Planned man hours for product structure operation

Minimum value: 0

This field is optional.

>{Decimal}</TotalTime>
15
     </ManHours>
16
     <ProductionOperation>
17
          <ProductionOperationId
ProductionOperationId

Required/mandatory field

Production operation identifier

Minimum value: 1000

>{Integer}</ProductionOperationId>
18
          <Checkpoint
Checkpoint

This field is optional.

>
19
               <HasCheckpoint
HasCheckpoint

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

Default value: False

This field is optional.

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

The checkpoint text

This field is optional.

>{String}</Description>
21
          </Checkpoint>
22
     </ProductionOperation>
23
</ProductStructureOperation>
1
{
2
     "productStructureOperation": {
3
          "sequenceNumber
SequenceNumber

Required/mandatory field

Sequence number of the product structure operation. Unique within a product structure.

Minimum value: 1

": "{Integer}",
4
          "waitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

Minimum value: 0

This field is optional.

": "{Decimal}",
5
          "note
Note

Note for product structure operation

This field is optional.

": "{String}",
6
          "noteToOperator
NoteToOperator

Operation information to operator

This field is optional.

": "{String}",
7
          "processing
Processing

This field is optional.

": {
8
               "runTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

Minimum value: 0

This field is optional.

": "{Decimal}"
9
          },
10
          "changeover
Changeover

This field is optional.

": {
11
               "setupTime
SetupTime

Changeover pre/setup time in hours

Minimum value: 0

This field is optional.

": "{Decimal}",
12
               "cleanupTime
CleanupTime

Changeover post/cleanup time in hours

Minimum value: 0

This field is optional.

": "{Decimal}"
13
          },
14
          "manHours
ManHours

This field is optional.

": {
15
               "totalTime
TotalTime

Planned man hours for product structure operation

Minimum value: 0

This field is optional.

": "{Decimal}"
16
          },
17
          "productionOperation": {
18
               "productionOperationId
ProductionOperationId

Required/mandatory field

Production operation identifier

Minimum value: 1000

": "{Integer}",
19
               "checkpoint
Checkpoint

This field is optional.

": {
20
                    "hasCheckpoint
HasCheckpoint

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

Default value: False

This field is optional.

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

The checkpoint text

This field is optional.

": "{String}"
22
               }
23
          }
24
     }
25
}

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]

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
<ProductStructureOperation>
2
     <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

>{Integer}</ProductStructureOperationId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

>{Integer}</SequenceNumber>
5
     <WaitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

>{Decimal}</WaitTime>
6
     <Note
Note

Note for product structure operation

>{String}</Note>
7
     <NoteToOperator
NoteToOperator

Operation information to operator

>{String}</NoteToOperator>
8
     <Processing>
9
          <RunTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

>{Decimal}</RunTime>
10
     </Processing>
11
     <Changeover>
12
          <SetupTime
SetupTime

Changeover pre/setup time in hours

>{Decimal}</SetupTime>
13
          <CleanupTime
CleanupTime

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
14
     </Changeover>
15
     <ManHours>
16
          <TotalTime
TotalTime

Planned man hours for product structure operation

>{Decimal}</TotalTime>
17
     </ManHours>
18
     <ProductionOperation>
19
          <ProductionOperationId
ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>
20
          <Name
Name

Name of production operation

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

Type of operation

Possible domain values can be found here

>{String}</Type>
22
          <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>
23
          <RequireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

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

>{Boolean}</RequireSerialNumberBeforeCompletion>
24
          <SetNextOperationReadyTrigger>
25
               <Value
Value

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

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

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

>{String}</Unit>
27
          </SetNextOperationReadyTrigger>
28
          <ProductForOutsourcedOperation>
29
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Product identifier

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

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

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

The checkpoint text

>{String}</Description>
36
          </Checkpoint>
37
          <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
38
     </ProductionOperation>
39
     <OutsourcedOperation>
40
          <IsOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

>{Boolean}</IsOutsourced>
41
          <Note
Note

Purchase order note for external operation, copied to the Note field at PO item

>{String}</Note>
42
          <IsPerformedOnSite
IsPerformedOnSite

Flag to indicate if product structure's operation is performed in house

>{Boolean}</IsPerformedOnSite>
43
          <LeadTime
LeadTime

Material lead time in days for external operations

>{Integer}</LeadTime>
44
          <UnitPrice
UnitPrice

Unit price of outsource operation

>
45
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
46
               <NetPrice
NetPrice

Net price for external operation

>{Decimal}</NetPrice>
47
          </UnitPrice>
48
          <Procurement>{}</Procurement>
49
     </OutsourcedOperation>
50
     <ProductionResourceGroup>
51
          <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

>{Integer}</ProductionResourceGroupId>
52
          <ProductionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

>{String}</ProductionResourceGroupLink>
53
     </ProductionResourceGroup>
54
     <ProductionResource>
55
          <ProductionResourceId
ProductionResourceId

Production resource identifier

>{Integer}</ProductionResourceId>
56
          <ProductionResourceLink
ProductionResourceLink

Production resource reference

>{String}</ProductionResourceLink>
57
     </ProductionResource>
58
</ProductStructureOperation>
1
{
2
     "productStructureOperation": {
3
          "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

Date and time of creation

": "{Datetime}",
5
          "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

": "{Integer}",
6
          "waitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

": "{Decimal}",
7
          "note
Note

Note for product structure operation

": "{String}",
8
          "noteToOperator
NoteToOperator

Operation information to operator

": "{String}",
9
          "processing": {
10
               "runTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

": "{Decimal}"
11
          },
12
          "changeover": {
13
               "setupTime
SetupTime

Changeover pre/setup time in hours

": "{Decimal}",
14
               "cleanupTime
CleanupTime

Changeover post/cleanup time in hours

": "{Decimal}"
15
          },
16
          "manHours": {
17
               "totalTime
TotalTime

Planned man hours for product structure operation

": "{Decimal}"
18
          },
19
          "productionOperation": {
20
               "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Type of operation

Possible domain values can be found here

": "{String}",
23
               "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}",
24
               "requireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

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

": "{Boolean}",
25
               "setNextOperationReadyTrigger": {
26
                    "value
Value

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

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

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

": "{String}"
28
               },
29
               "productForOutsourcedOperation": {
30
                    "productId
ProductId

Product identifier

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

Name of the product

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

Product identifier

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

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

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

The checkpoint text

": "{String}"
37
               },
38
               "productionOperationLink
ProductionOperationLink

Production operation reference

": "{String}"
39
          },
40
          "outsourcedOperation": {
41
               "isOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

": "{Boolean}",
42
               "note
Note

Purchase order note for external operation, copied to the Note field at PO item

": "{String}",
43
               "isPerformedOnSite
IsPerformedOnSite

Flag to indicate if product structure's operation is performed in house

": "{Boolean}",
44
               "leadTime
LeadTime

Material lead time in days for external operations

": "{Integer}",
45
               "unitPrice
UnitPrice

Unit price of outsource operation

": {
46
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
47
                    "netPrice
NetPrice

Net price for external operation

": "{Decimal}"
48
               },
49
               "procurement": "{}"
50
          },
51
          "productionResourceGroup": {
52
               "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

": "{Integer}",
53
               "productionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

": "{String}"
54
          },
55
          "productionResource": {
56
               "productionResourceId
ProductionResourceId

Production resource identifier

": "{Integer}",
57
               "productionResourceLink
ProductionResourceLink

Production resource reference

": "{String}"
58
          }
59
     }
60
}

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 104266 HTTP 403 Manufacturers product not found
Error 103016 HTTP 400 Maximum number of decimals allowed for quantity is {0}
Error 101492 HTTP 400 Illegal VAT code: VAT value > 0 is not allowed on this document
Error 101493 HTTP 400 Illegal update: New VAT code has VAT percentage different from old VAT code.
Error 101494 HTTP 400 Illegal VAT code: Vat code and document has different VAT number
Error 101496 HTTP 400 Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod
Error 101495 HTTP 400 Illegal VAT code: {0}
Error 107641 HTTP 400 VAT code {0} has not an active VAT code setup
Error 100984 HTTP 400 Illegal update. The General ledger posting has ST>4
Error 100985 HTTP 400 Illegal update. The General ledger posting has AGIO-calculation
Error 100047 HTTP 404 Supplier not found
Error 101097 HTTP 404 Given currency {0} mismatch with currencies of supplier {1}