API

Production APIs

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

List of assignments related to this production work order

HTTP method GET
URI https://api.rambase.net/production/work-orders/{productionWorkOrderId}/assignments
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionWorkOrderId} Production work order identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2086, version 35

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Confirmed() Named filter Confirmed delivery date
ExcludeStock() Named filter Type of assignment register
InStock() Named filter Stock entries with quantity in stock
OnlyConsumptionParts() Named filter Type of product
PendingPurchase() Named filter Purchase orders pending purchase order response (status 3).
Unconfirmed() Named filter Purchase order items whithout confirmed delivery date
AssignedToItemId Integer Item-number of the object.
AssignmentId Integer Allocation identifier.
AssignmentRegisterId Integer Assignment register identifier.
AssignmentRegisterOwnerType String Type of assignment register.
ConfirmedDeliveryDate Date The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
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.
ProductStructureId Integer Assignment register identifier.
ProductStructureOperationId Integer Product structure operation identifier.
ProductType String Type of product.
Quantity Decimal Quantity assigned.

Read more about filters and sorting on how to use sortable parameters

AssignedToItemId Integer Item-number of the object
AssignmentId Integer Allocation identifier
AssignmentRegisterId Integer Assignment register identifier
AssignmentRegisterOwnerType String Type of assignment register
ConfirmedDeliveryDate Date The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.
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
ProductStructureId Integer Assignment register identifier
ProductStructureOperationId Integer Product structure operation identifier
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

Allocation 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

>
{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
               <RemainingQuantity
RemainingQuantity

The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.

>
{Decimal}</RemainingQuantity>
44
               <AvailableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.

>
{Decimal}</AvailableQuantity>
45
               <OwnerType
OwnerType

Type of assignment register

Possible domain values can be found here

>
{String}</OwnerType>
46
               <Owner>
47
                    <ItemId
ItemId

Item-number of the object

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

Type of item

>
{String}</ItemType>
49
                    <RequestedDeliveryDate
RequestedDeliveryDate

The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field.

>
{Date}</RequestedDeliveryDate>
50
                    <ConfirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.

>
{Date}</ConfirmedDeliveryDate>
51
                    <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>
52
                    <PriceConverted
PriceConverted

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

>
53
                         <Currency
Currency

Three character code following the ISO 4217 standard

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

>
{String}</Currency>
54
                         <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>
{Decimal}</GrossPrice>
55
                         <NetPrice
NetPrice

Final price per unit after deducting all discounts.

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

>
{Decimal}</NetPrice>
56
                    </PriceConverted>
57
                    <MeasurementUnit>
58
                         <MeasurementUnitId
MeasurementUnitId

Material unit reference

>
{Integer}</MeasurementUnitId>
59
                         <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>
{String}</Unit>
60
                         <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>
{String}</MeasurementUnitLink>
61
                    </MeasurementUnit>
62
                    <ManufacturersProduct
ManufacturersProduct

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

>
63
                         <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>
{Integer}</ManufacturersProductId>
64
                         <Name
Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

>
{String}</Name>
65
                         <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

>
{String}</ManufacturersProductLink>
66
                    </ManufacturersProduct>
67
                    <Object>
68
                         <Database
Database

Database of the object

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

Identifier of the object

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

Type of object

>
{String}</ObjectType>
71
                         <Status
Status

Status of the item/object.

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

>
{Integer}</Status>
72
                         <Supplier
Supplier

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

>
73
                              <SupplierId
SupplierId

RamBase supplier identifier

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

>
{Integer}</SupplierId>
74
                              <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

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

>
{String}</Name>
75
                              <SupplierLink
SupplierLink

Supplier reference

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

>
{String}</SupplierLink>
76
                         </Supplier>
77
                         <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
78
                    </Object>
79
                    <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
81
               </Owner>
82
               <Product>
83
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

>
{String}</Description>
87
                    <Manufacturer
Manufacturer

Manufacturer of the product

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

>
88
                         <ManufacturerId
ManufacturerId

Manufacturer identifier

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

>
{Integer}</ManufacturerId>
89
                         <ShortName
ShortName

Shortname/code of the manufacturer

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

>
{String}</ShortName>
90
                         <ManufacturerLink
ManufacturerLink

Manufacturer reference

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

>
{String}</ManufacturerLink>
91
                    </Manufacturer>
92
                    <LatestProductRevision
LatestProductRevision

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

>
93
                         <Revision
Revision

Revision number

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

>
{String}</Revision>
94
                    </LatestProductRevision>
95
                    <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
96
               </Product>
97
               <AssignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

>
{String}</AssignmentRegisterLink>
98
          </AssignmentRegister>
99
          <AssignmentLink
AssignmentLink

Assignment reference

>
{String}</AssignmentLink>
100
     </Assignment>
101
     <Paging
Paging

Detailed paging information for this list.

>
102
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>
{Integer}</PageSize>
103
          <Position
Position

Position of the first element in the list

>
{Integer}</Position>
104
          <Page
Page

Page index

>
{Integer}</Page>
105
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>
{String}</FirstPageKey>
106
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>
{String}</FirstPage>
107
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>
{String}</PreviousPageKey>
108
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>
{String}</PreviousPage>
109
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>
{String}</NextPageKey>
110
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>
{String}</NextPage>
111
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>
{String}</LastPageKey>
112
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>
{String}</LastPage>
113
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>
{Integer}</Size>
114
     </Paging>
115
</Assignments>
1
{
2
     "assignments": [
3
          {
4
               "assignmentId
AssignmentId

Allocation 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

":
"{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
                    "remainingQuantity
RemainingQuantity

The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.

":
"{Decimal}",
45
                    "availableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.

":
"{Decimal}",
46
                    "ownerType
OwnerType

Type of assignment register

Possible domain values can be found here

":
"{String}",
47
                    "owner": {
48
                         "itemId
ItemId

Item-number of the object

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

Type of item

":
"{String}",
50
                         "requestedDeliveryDate
RequestedDeliveryDate

The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field.

":
"{Date}",
51
                         "confirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.

":
"{Date}",
52
                         "productStructureRevision
ProductStructureRevision

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

":
"{String}",
53
                         "priceConverted
PriceConverted

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

":
{
54
                              "currency
Currency

Three character code following the ISO 4217 standard

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

":
"{String}",
55
                              "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

":
"{Decimal}",
56
                              "netPrice
NetPrice

Final price per unit after deducting all discounts.

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

":
"{Decimal}"
57
                         },
58
                         "measurementUnit": {
59
                              "measurementUnitId
MeasurementUnitId

Material unit reference

":
"{Integer}",
60
                              "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

":
"{String}",
61
                              "measurementUnitLink
MeasurementUnitLink

Material unit reference

":
"{String}"
62
                         },
63
                         "manufacturersProduct
ManufacturersProduct

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

":
{
64
                              "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

":
"{String}",
66
                              "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

":
"{String}"
67
                         },
68
                         "object": {
69
                              "database
Database

Database of the object

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

Identifier of the object

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

Type of object

":
"{String}",
72
                              "status
Status

Status of the item/object.

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

":
"{Integer}",
73
                              "supplier
Supplier

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

":
{
74
                                   "supplierId
SupplierId

RamBase supplier identifier

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

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

Name of supplier (name of company or surname/familyname/lastname of a person)

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

":
"{String}",
76
                                   "supplierLink
SupplierLink

Supplier reference

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

":
"{String}"
77
                              },
78
                              "objectLink
ObjectLink

API reference to the object

":
"{String}"
79
                         },
80
                         "itemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

":
"{String}"
82
                    },
83
                    "product": {
84
                         "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

":
"{String}",
88
                         "manufacturer
Manufacturer

Manufacturer of the product

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

":
{
89
                              "manufacturerId
ManufacturerId

Manufacturer identifier

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

":
"{Integer}",
90
                              "shortName
ShortName

Shortname/code of the manufacturer

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

":
"{String}",
91
                              "manufacturerLink
ManufacturerLink

Manufacturer reference

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

":
"{String}"
92
                         },
93
                         "latestProductRevision
LatestProductRevision

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

":
{
94
                              "revision
Revision

Revision number

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

":
"{String}"
95
                         },
96
                         "productLink
ProductLink

Product reference

":
"{String}"
97
                    },
98
                    "assignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

":
"{String}"
99
               },
100
               "assignmentLink
AssignmentLink

Assignment reference

":
"{String}"
101
          }
102
     ],
103
     "paging
Paging

Detailed paging information for this list.

":
{
104
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

":
"{Integer}",
105
          "position
Position

Position of the first element in the list

":
"{Integer}",
106
          "page
Page

Page index

":
"{Integer}",
107
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

":
"{String}",
108
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

":
"{String}",
109
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

":
"{String}",
110
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

":
"{String}",
111
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

":
"{String}",
112
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

":
"{String}",
113
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

":
"{String}",
114
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

":
"{String}",
115
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

":
"{Integer}"
116
     }
117
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101420 HTTP 404 Setting definition not found
Error 102189 HTTP 400 Missing mandatory parameter for goods reception item id