GET production/work-orders/{productionWorkOrderId}/assignments

List of assignments related to this production work order

Note: Log in to check if your API client have access to run this resource
Version: 19
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{productionWorkOrderId} Integer Production work order identifier

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 is 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.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

ExcludeStock() Named filter Type of assignment register
OnlyConsumptionParts() Named filter Type of product
AssignedToItemId Integer Item-number of the object.
AssignmentId Integer Assignment identifier.
AssignmentRegisterId Integer Assignment register identifier.
AssignmentRegisterOwnerType String Type of assignment register.
OperationSequenceNumber Integer Sequence number of the production operation. Controls the sequence of all the operations in the product structre. Products beloning to each operation will have the same operation sequence number.
PickStatus Integer Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item..
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity assigned.

See the page about filters and sorting on how to use sortable parameters

AssignedToItemId Integer Item-number of the object
AssignmentId Integer Assignment identifier
AssignmentRegisterId Integer Assignment register identifier
AssignmentRegisterOwnerType String Type of assignment register
OperationSequenceNumber Integer Sequence number of the production operation. Controls the sequence of all the operations in the product structre. Products beloning to each operation will have the same operation sequence number.
PickStatus Integer Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity assigned

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
<Assignments>
2
     <Assignment>
3
          <AssignmentId
AssignmentId

Assignment identifier

>
{Integer}</AssignmentId>
4
          <Quantity
Quantity

Quantity assigned

>
{Decimal}</Quantity>
5
          <AssignedTo>
6
               <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
7
               <ItemType
ItemType

Type of item

>
{String}</ItemType>
8
               <PickOperation>
9
                    <PickOperationId
PickOperationId

Pick operation identifier

>
{Integer}</PickOperationId>
10
                    <PickOperationLink
PickOperationLink

Pick operation reference

>
{String}</PickOperationLink>
11
               </PickOperation>
12
               <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
13
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
14
          </AssignedTo>
15
          <ProductStructureAssignment>
16
               <ProductStructureMaterial>
17
                    <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

>
{Integer}</ProductStructureMaterialId>
18
                    <ProductStructureOperation>
19
                         <SequenceNumber
SequenceNumber

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

>
{Integer}</SequenceNumber>
20
                    </ProductStructureOperation>
21
                    <ProductStructure>
22
                         <ProductStructureId
ProductStructureId

Assignment register identifier

>
{Integer}</ProductStructureId>
23
                         <ProductStructureLink
ProductStructureLink

Assignment register identifier

>
{String}</ProductStructureLink>
24
                    </ProductStructure>
25
                    <ProductStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

>
{String}</ProductStructureMaterialLink>
26
               </ProductStructureMaterial>
27
               <ProductStructureOperation>
28
                    <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

>
{Integer}</ProductStructureOperationId>
29
                    <SequenceNumber
SequenceNumber

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

>
{Integer}</SequenceNumber>
30
                    <ProductStructure>
31
                         <ProductStructureId
ProductStructureId

Assignment register identifier

>
{Integer}</ProductStructureId>
32
                         <ProductStructureLink
ProductStructureLink

Assignment register identifier

>
{String}</ProductStructureLink>
33
                    </ProductStructure>
34
                    <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

>
{String}</ProductStructureOperationLink>
35
               </ProductStructureOperation>
36
          </ProductStructureAssignment>
37
          <Picking>
38
               <PickStatus
PickStatus

Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.

Possible domain values can be found here when logged in

>
{Integer}</PickStatus>
39
               <PickedQuantity
PickedQuantity

Total picked quantity of this assignment. Will not get a value before pick operation has started.

This field is greyed out because it is an expandable field. You have to add $expand=Assignment.Picking.PickedQuantity in your request URI to get this field

>
{Decimal}</PickedQuantity>
40
          </Picking>
41
          <AssignmentRegister>
42
               <AssignmentRegisterId
AssignmentRegisterId

Assignment register identifier

>
{Integer}</AssignmentRegisterId>
43
               <OwnerType
OwnerType

Type of assignment register

Possible domain values can be found here when logged in

>
{String}</OwnerType>
44
               <Owner>
45
                    <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
46
                    <ItemType
ItemType

Type of item

>
{String}</ItemType>
47
                    <ProductStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>
{String}</ProductStructureRevision>
48
                    <MeasurementUnit>
49
                         <MeasurementUnitId
MeasurementUnitId

Material unit reference

>
{Integer}</MeasurementUnitId>
50
                         <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>
{String}</MeasurementUnitLink>
51
                    </MeasurementUnit>
52
                    <Object>
53
                         <Database
Database

Database of the object

>
{String}</Database>
54
                         <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
55
                         <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
56
                         <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
57
                    </Object>
58
                    <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
59
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
60
               </Owner>
61
               <Product>
62
                    <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
63
                    <Name
Name

Name of the product

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

Type of product

Possible domain values can be found here when logged in

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

Description of the product

>
{String}</Description>
66
                    <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
67
               </Product>
68
               <AssignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

>
{String}</AssignmentRegisterLink>
69
          </AssignmentRegister>
70
          <AssignmentLink
AssignmentLink

Assignment reference

>
{String}</AssignmentLink>
71
     </Assignment>
72
</Assignments>
1
{
2
     "assignments": [
3
          {
4
               "assignmentId
AssignmentId

Assignment identifier

":
"{Integer}",
5
               "quantity
Quantity

Quantity assigned

":
"{Decimal}",
6
               "assignedTo": {
7
                    "itemId
ItemId

Item-number of the object

":
"{Integer}",
8
                    "itemType
ItemType

Type of item

":
"{String}",
9
                    "pickOperation": {
10
                         "pickOperationId
PickOperationId

Pick operation identifier

":
"{Integer}",
11
                         "pickOperationLink
PickOperationLink

Pick operation reference

":
"{String}"
12
                    },
13
                    "itemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

":
"{String}"
15
               },
16
               "productStructureAssignment": {
17
                    "productStructureMaterial": {
18
                         "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

":
"{Integer}",
19
                         "productStructureOperation": {
20
                              "sequenceNumber
SequenceNumber

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

":
"{Integer}"
21
                         },
22
                         "productStructure": {
23
                              "productStructureId
ProductStructureId

Assignment register identifier

":
"{Integer}",
24
                              "productStructureLink
ProductStructureLink

Assignment register identifier

":
"{String}"
25
                         },
26
                         "productStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

":
"{String}"
27
                    },
28
                    "productStructureOperation": {
29
                         "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

":
"{Integer}",
30
                         "sequenceNumber
SequenceNumber

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

":
"{Integer}",
31
                         "productStructure": {
32
                              "productStructureId
ProductStructureId

Assignment register identifier

":
"{Integer}",
33
                              "productStructureLink
ProductStructureLink

Assignment register identifier

":
"{String}"
34
                         },
35
                         "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

":
"{String}"
36
                    }
37
               },
38
               "picking": {
39
                    "pickStatus
PickStatus

Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.

Possible domain values can be found here when logged in

":
"{Integer}",
40
                    "pickedQuantity
PickedQuantity

Total picked quantity of this assignment. Will not get a value before pick operation has started.

This field is greyed out because it is an expandable field. You have to add $expand=Assignment.Picking.PickedQuantity in your request URI to get this field

":
"{Decimal}"
41
               },
42
               "assignmentRegister": {
43
                    "assignmentRegisterId
AssignmentRegisterId

Assignment register identifier

":
"{Integer}",
44
                    "ownerType
OwnerType

Type of assignment register

Possible domain values can be found here when logged in

":
"{String}",
45
                    "owner": {
46
                         "itemId
ItemId

Item-number of the object

":
"{Integer}",
47
                         "itemType
ItemType

Type of item

":
"{String}",
48
                         "productStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

":
"{String}",
49
                         "measurementUnit": {
50
                              "measurementUnitId
MeasurementUnitId

Material unit reference

":
"{Integer}",
51
                              "measurementUnitLink
MeasurementUnitLink

Material unit reference

":
"{String}"
52
                         },
53
                         "object": {
54
                              "database
Database

Database of the object

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

Identifier of the object

":
"{Integer}",
56
                              "objectType
ObjectType

Type of object

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

API reference to the object

":
"{String}"
58
                         },
59
                         "itemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

":
"{String}"
61
                    },
62
                    "product": {
63
                         "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here when logged in

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

Description of the product

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

Product reference

":
"{String}"
68
                    },
69
                    "assignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

":
"{String}"
70
               },
71
               "assignmentLink
AssignmentLink

Assignment reference

":
"{String}"
72
          }
73
     ]
74
}

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 100241 HTTP 404 Production work order not found
Error 102190 HTTP 404 Missing mandatory parameter for pick operation id
Error 102187 HTTP 400 Missing mandatory parameter for goods reception database
Error 102188 HTTP 400 Missing mandatory parameter for goods reception id
Error 102189 HTTP 400 Missing mandatory parameter for goods reception item id