API

Product APIs

GET product/structure-versions/{productStructureVersionId}/operations/{productStructureOperationId}

Details for provided product structure version's operation

HTTP method GET
URI https://api.rambase.net/product/structure-versions/{productStructureVersionId}/operations/{productStructureOperationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productStructureVersionId} Product structure identifier
Integer, minimum 100000
- URI parameter {productStructureOperationId} Product structure operation identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3951, version 16

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable 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
     <NoteToOperator
NoteToOperator

Operation information to operator

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

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

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

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
13
     </Changeover>
14
     <ProductionOperation>
15
          <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Type of operation

Possible domain values can be found here

>{String}</Type>
18
          <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>
19
          <RequireSerialNumberBeforeCompletion
RequireSerialNumberBeforeCompletion

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

>{Boolean}</RequireSerialNumberBeforeCompletion>
20
          <SetNextOperationReadyTrigger>
21
               <Value
Value

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

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

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

>{String}</Unit>
23
          </SetNextOperationReadyTrigger>
24
          <ProductForOutsourcedOperation>
25
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Product identifier

>{String}</ProductLink>
28
          </ProductForOutsourcedOperation>
29
          <Checkpoint>
30
               <HasCheckpoint
HasCheckpoint

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

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

The checkpoint text

>{String}</Description>
32
          </Checkpoint>
33
          <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
34
     </ProductionOperation>
35
     <OutsourcedOperation>
36
          <IsOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

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

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

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

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

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

Material lead time in days for external operations

>{Integer}</LeadTime>
40
          <Procurement>
41
               <NumberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.NumberOfPurchaseQuotes in your request URI to get this field

>{Integer}</NumberOfPurchaseQuotes>
42
               <NumberOfPurchaseQuoteRequests
NumberOfPurchaseQuoteRequests

Number of purchase quote requests

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.NumberOfPurchaseQuoteRequests in your request URI to get this field

>{Integer}</NumberOfPurchaseQuoteRequests>
43
               <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

>
44
                    <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

>{Integer}</EmployeeId>
45
                    <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

>{String}</FirstName>
46
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

>{String}</LastName>
47
                    <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

>{String}</EmployeeLink>
48
               </PurchaseResponsible>
49
          </Procurement>
50
     </OutsourcedOperation>
51
     <ProductionResourceGroup>
52
          <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Production resource group reference

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

Production resource identifier

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

Production resource reference

>{String}</ProductionResourceLink>
58
     </ProductionResource>
59
</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
          "noteToOperator
NoteToOperator

Operation information to operator

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

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

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

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

": "{Decimal}"
14
          },
15
          "productionOperation": {
16
               "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Type of operation

Possible domain values can be found here

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

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

": "{Boolean}",
21
               "setNextOperationReadyTrigger": {
22
                    "value
Value

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

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

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

": "{String}"
24
               },
25
               "productForOutsourcedOperation": {
26
                    "productId
ProductId

Product identifier

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

Name of the product

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

Product identifier

": "{String}"
29
               },
30
               "checkpoint": {
31
                    "hasCheckpoint
HasCheckpoint

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

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

The checkpoint text

": "{String}"
33
               },
34
               "productionOperationLink
ProductionOperationLink

Production operation reference

": "{String}"
35
          },
36
          "outsourcedOperation": {
37
               "isOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

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

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

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

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

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

Material lead time in days for external operations

": "{Integer}",
41
               "procurement": {
42
                    "numberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.NumberOfPurchaseQuotes in your request URI to get this field

": "{Integer}",
43
                    "numberOfPurchaseQuoteRequests
NumberOfPurchaseQuoteRequests

Number of purchase quote requests

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.NumberOfPurchaseQuoteRequests in your request URI to get this field

": "{Integer}",
44
                    "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

": {
45
                         "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

": "{Integer}",
46
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

": "{String}",
47
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

": "{String}",
48
                         "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=OutsourcedOperation.Procurement.PurchaseResponsible in your request URI to get this field

": "{String}"
49
                    }
50
               }
51
          },
52
          "productionResourceGroup": {
53
               "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Production resource group reference

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

Production resource identifier

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

Production resource reference

": "{String}"
59
          }
60
     }
61
}

Possible error codes the response might return:

Error 103366 HTTP 404 Production resource group not found.
Error 100207 HTTP 404 Production resource not found {0}