API

Procurement APIs

GET procurement/purchase-requirements-by-quote-requests-for-material

List of all sales quote request items

HTTP method GET
URI https://api.rambase.net/procurement/purchase-requirements-by-quote-requests-for-material
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6665, version 19

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.

CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
ManufacturedProductId Integer Product identifier.
ManufacturedProductName String Name of the product.
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg).
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductName String Name of the product.
ProductType String Type of product.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RequiredQuantity Decimal Remaining number of units to be forwarded.
SalesQuoteRequestId Integer Sales quote request identifier.
SalesQuoteRequestItemId Integer Sales quote request item identifier.
Status Integer Status of the sales quote request item.

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

CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
ManufacturedProductId Integer Product identifier
ManufacturedProductName String Name of the product
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg)
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductName String Name of the product
ProductType String Type of product
RequestedDeliveryDate Date The delivery date as requested by the customer.
RequiredQuantity Decimal Remaining number of units to be forwarded.
SalesQuoteRequestId Integer Sales quote request identifier
SalesQuoteRequestItemId Integer Sales quote request item identifier
Status Integer Status of the sales quote request item

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
<PurchaseRequirementsByQuoteRequestForMaterial>
2
     <PurchaseRequirementByQuoteRequestForMaterial>
3
          <RequiredQuantity
RequiredQuantity

Required quantity

>{Decimal}</RequiredQuantity>
4
          <ProductStructureMaterial>
5
               <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

>{Integer}</ProductStructureMaterialId>
6
               <Product>
7
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
8
                    <HasPlannedFileRequirements
HasPlannedFileRequirements

Indicating this product have planned file requirements

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

>{Boolean}</HasPlannedFileRequirements>
9
                    <Name
Name

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

>{String}</Description>
12
                    <NumberOfNotes
NumberOfNotes

Number of notes

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

>{Integer}</NumberOfNotes>
13
                    <MeasurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

>
14
                         <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
17
                    </MeasurementUnit>
18
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
19
               </Product>
20
               <Procurement>
21
                    <NumberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

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

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

Number of purchase quote requests

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

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

User responsible for the procurement transaction

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

>
24
                         <EmployeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
28
                    </PurchaseResponsible>
29
               </Procurement>
30
          </ProductStructureMaterial>
31
          <SalesQuoteRequestItem>
32
               <SalesQuoteRequestItemId
SalesQuoteRequestItemId

Sales quote request item identifier

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

Status of the sales quote request item

Possible domain values can be found here

>{Integer}</Status>
34
               <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
35
               <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
36
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
37
               <Product>
38
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>{String}</ProductLink>
41
               </Product>
42
               <ProductStructure>
43
                    <ProductStructureId
ProductStructureId

Product structure reference

>{Integer}</ProductStructureId>
44
               </ProductStructure>
45
               <HighlightedNotification
HighlightedNotification

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

>
46
                    <NotificationId
NotificationId

Notification identifier

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

>{Integer}</NotificationId>
47
                    <Status
Status

Status of the notification

Possible domain values can be found here

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

>{Integer}</Status>
48
                    <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
49
                    <Message
Message

The message from the notification definition, expanded with parameters.

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

>{String}</Message>
50
                    <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

>{String}</TranslatedMessage>
51
                    <NotificationType
NotificationType

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

>
52
                         <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
53
                         <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

>{String}</Category>
54
                         <NotificationTypeLink
NotificationTypeLink

Notification type reference

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

>{String}</NotificationTypeLink>
55
                    </NotificationType>
56
                    <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
57
               </HighlightedNotification>
58
               <SalesQuoteRequest>
59
                    <SalesQuoteRequestId
SalesQuoteRequestId

Sales quote request identifier

>{Integer}</SalesQuoteRequestId>
60
                    <Customer>
61
                         <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
62
                         <Name
Name

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

>{String}</Name>
63
                         <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
64
                         <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
65
                    </Customer>
66
                    <SalesQuoteRequestLink
SalesQuoteRequestLink

Sales quote request reference

>{String}</SalesQuoteRequestLink>
67
               </SalesQuoteRequest>
68
               <SalesQuoteRequestItemLink
SalesQuoteRequestItemLink

Sales qoute request item reference

>{String}</SalesQuoteRequestItemLink>
69
          </SalesQuoteRequestItem>
70
     </PurchaseRequirementByQuoteRequestForMaterial>
71
     <Paging
Paging

Detailed paging information for this list.

>
72
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
75
          <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>
76
          <FirstPage
FirstPage

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

>{String}</FirstPage>
77
          <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>
78
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
79
          <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>
80
          <NextPage
NextPage

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

>{String}</NextPage>
81
          <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>
82
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
84
     </Paging>
85
</PurchaseRequirementsByQuoteRequestForMaterial>
1
{
2
     "purchaseRequirementsByQuoteRequestForMaterial": [
3
          {
4
               "requiredQuantity
RequiredQuantity

Required quantity

": "{Decimal}",
5
               "productStructureMaterial": {
6
                    "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

": "{Integer}",
7
                    "product": {
8
                         "productId
ProductId

Product identifier

": "{Integer}",
9
                         "hasPlannedFileRequirements
HasPlannedFileRequirements

Indicating this product have planned file requirements

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

": "{Boolean}",
10
                         "name
Name

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

": "{String}",
13
                         "numberOfNotes
NumberOfNotes

Number of notes

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

": "{Integer}",
14
                         "measurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

": {
15
                              "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

": "{String}"
18
                         },
19
                         "productLink
ProductLink

Product reference

": "{String}"
20
                    },
21
                    "procurement": {
22
                         "numberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

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

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

Number of purchase quote requests

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

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

User responsible for the procurement transaction

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

": {
25
                              "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

": "{String}"
29
                         }
30
                    }
31
               },
32
               "salesQuoteRequestItem": {
33
                    "salesQuoteRequestItemId
SalesQuoteRequestItemId

Sales quote request item identifier

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

Status of the sales quote request item

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
36
                    "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
37
                    "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
38
                    "product": {
39
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

": "{String}"
42
                    },
43
                    "productStructure": {
44
                         "productStructureId
ProductStructureId

Product structure reference

": "{Integer}"
45
                    },
46
                    "highlightedNotification
HighlightedNotification

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

": {
47
                         "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

": "{Datetime}",
50
                         "message
Message

The message from the notification definition, expanded with parameters.

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

": "{String}",
51
                         "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

": "{String}",
52
                         "notificationType
NotificationType

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

": {
53
                              "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
54
                              "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

": "{String}",
55
                              "notificationTypeLink
NotificationTypeLink

Notification type reference

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

": "{String}"
56
                         },
57
                         "notificationLink
NotificationLink

Notification reference

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

": "{String}"
58
                    },
59
                    "salesQuoteRequest": {
60
                         "salesQuoteRequestId
SalesQuoteRequestId

Sales quote request identifier

": "{Integer}",
61
                         "customer": {
62
                              "customerId
CustomerId

Customer identifier

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

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

": "{String}",
64
                              "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
65
                              "customerLink
CustomerLink

Customer reference

": "{String}"
66
                         },
67
                         "salesQuoteRequestLink
SalesQuoteRequestLink

Sales quote request reference

": "{String}"
68
                    },
69
                    "salesQuoteRequestItemLink
SalesQuoteRequestItemLink

Sales qoute request item reference

": "{String}"
70
               }
71
          }
72
     ],
73
     "paging
Paging

Detailed paging information for this list.

": {
74
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
86
     }
87
}

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 100147 HTTP 404 Notification type not found