API

Logistics APIs

GET logistics/assignments

Logistics assignments from all assignment registers

HTTP method GET
URI https://api.rambase.net/logistics/assignments
Supported formats Xml, Html, Json, Json stream (ex. $format=jsonstream)
Maximum page size ($top) 50000
Successful HTTP status code 200
API resource identifier 5023, version 2

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.

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

AssignedToItemId Integer Assignment item identifier.
AssignedToObjectId Integer Assignment document identifier.
AssignedToObjectType String Archive of the document.
AssignmentId Integer Allocation identifier.
AssignmentRegisterId Integer Assignment register identifier.
AssignmentRegisterStatus Integer Status of assignment register.
LocationShortName String Unique abbreviation/short name of the location.
OwnerObjectId Integer Identifier of the document.
OwnerObjectItemId Integer Line number of the document item.
OwnerObjectType String Archive of the document.
OwnerType String Type of assignment register.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Decimal Quantity assigned.

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

AssignedToObjectType String Archive of the document
AssignmentRegisterStatus Integer Status of assignment register
LocationShortName String Unique abbreviation/short name of the location
OwnerObjectId Integer Identifier of the document
OwnerObjectItemId Integer Line number of the document item
OwnerObjectType String Archive of the document
OwnerType String Type of assignment register
ProductId Integer Product identifier
ProductName String Name of the 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
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

Identifier of the object

>{String}</ObjectLink>
10
          </AssignedTo>
11
          <ProductStructureAssignment
ProductStructureAssignment

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

>
12
               <ProductStructureMaterial
ProductStructureMaterial

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

>
13
                    <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

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

>{Integer}</ProductStructureMaterialId>
14
                    <ProductStructureOperation
ProductStructureOperation

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

>
15
                         <SequenceNumber
SequenceNumber

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

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

>{Integer}</SequenceNumber>
16
                    </ProductStructureOperation>
17
                    <ProductStructureVersion
ProductStructureVersion

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

>
18
                         <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

>{Integer}</ProductStructureVersionId>
19
                         <ProductStructureVersionLink
ProductStructureVersionLink

Product structure reference

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

>{String}</ProductStructureVersionLink>
20
                    </ProductStructureVersion>
21
               </ProductStructureMaterial>
22
               <ProductStructureOperation
ProductStructureOperation

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

>
23
                    <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

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

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

>{Integer}</SequenceNumber>
25
                    <ProductStructureVersion
ProductStructureVersion

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

>
26
                         <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

>{Integer}</ProductStructureVersionId>
27
                         <ProductStructureVersionLink
ProductStructureVersionLink

Product structure reference

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

>{String}</ProductStructureVersionLink>
28
                    </ProductStructureVersion>
29
               </ProductStructureOperation>
30
          </ProductStructureAssignment>
31
          <AssignmentRegister>
32
               <AssignmentRegisterId
AssignmentRegisterId

Assignment register identifier

>{Integer}</AssignmentRegisterId>
33
               <Status
Status

Status of assignment register

>{Integer}</Status>
34
               <Owner>
35
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
36
                    <Object>
37
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

Identifier of the object

>{String}</ObjectLink>
40
                    </Object>
41
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
42
               </Owner>
43
               <Location
Location

The location of the assignment register. The location is either from the owner item, or from the initial demand.

>
44
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
45
               </Location>
46
               <Product
Product

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

>
47
                    <ProductId
ProductId

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

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

Name of the product

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

Product reference

>{String}</ProductLink>
50
               </Product>
51
               <AssignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

>{String}</AssignmentRegisterLink>
52
          </AssignmentRegister>
53
     </Assignment>
54
     <Paging
Paging

Detailed paging information for this list.

>
55
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
58
          <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>
59
          <FirstPage
FirstPage

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

>{String}</FirstPage>
60
          <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>
61
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
62
          <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>
63
          <NextPage
NextPage

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

>{String}</NextPage>
64
          <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>
65
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
67
     </Paging>
68
</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
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

Identifier of the object

": "{String}"
11
               },
12
               "productStructureAssignment
ProductStructureAssignment

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

": {
13
                    "productStructureMaterial
ProductStructureMaterial

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

": {
14
                         "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

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

": "{Integer}",
15
                         "productStructureOperation
ProductStructureOperation

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

": {
16
                              "sequenceNumber
SequenceNumber

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

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

": "{Integer}"
17
                         },
18
                         "productStructureVersion
ProductStructureVersion

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

": {
19
                              "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

": "{Integer}",
20
                              "productStructureVersionLink
ProductStructureVersionLink

Product structure reference

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

": "{String}"
21
                         }
22
                    },
23
                    "productStructureOperation
ProductStructureOperation

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

": {
24
                         "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

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

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

": "{Integer}",
26
                         "productStructureVersion
ProductStructureVersion

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

": {
27
                              "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

": "{Integer}",
28
                              "productStructureVersionLink
ProductStructureVersionLink

Product structure reference

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

": "{String}"
29
                         }
30
                    }
31
               },
32
               "assignmentRegister": {
33
                    "assignmentRegisterId
AssignmentRegisterId

Assignment register identifier

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

Status of assignment register

": "{Integer}",
35
                    "owner": {
36
                         "itemId
ItemId

Item-number of the object

": "{Integer}",
37
                         "object": {
38
                              "objectId
ObjectId

Identifier of the object

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

Type of object

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

Identifier of the object

": "{String}"
41
                         },
42
                         "itemLink
ItemLink

API reference to the item

": "{String}"
43
                    },
44
                    "location
Location

The location of the assignment register. The location is either from the owner item, or from the initial demand.

": {
45
                         "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
46
                    },
47
                    "product
Product

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

": {
48
                         "productId
ProductId

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

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

Name of the product

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

Product reference

": "{String}"
51
                    },
52
                    "assignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

": "{String}"
53
               }
54
          }
55
     ],
56
     "paging
Paging

Detailed paging information for this list.

": {
57
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
60
          "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}",
61
          "firstPage
FirstPage

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

": "{String}",
62
          "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}",
63
          "previousPage
PreviousPage

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

": "{String}",
64
          "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}",
65
          "nextPage
NextPage

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

": "{String}",
66
          "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}",
67
          "lastPage
LastPage

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

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

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

": "{Integer}"
69
     }
70
}

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: