API

Procurement APIs

GET procurement/quote-requests/{purchaseQuoteRequestId}/items/{itemId}

Details about a specific item of an purchase quote request

HTTP method GET
URI https://api.rambase.net/procurement/quote-requests/{purchaseQuoteRequestId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseQuoteRequestId} Purchase quote request identifier
Integer, minimum 100000
- URI parameter {itemId} Purchase quote request item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2330, version 18

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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

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

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<PurchaseQuoteRequestItem>
2
     <PurchaseQuoteRequestItemId
PurchaseQuoteRequestItemId

Purchase quote request item identifier

>{Integer}</PurchaseQuoteRequestItemId>
3
     <Status
Status

Status of item

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
6
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

>{Date}</RequestedDeliveryDate>
7
     <SuppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

>{String}</SuppliersProductName>
8
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>{String}</EquivalentProductName>
9
     <RequestedProductStructureRevision
RequestedProductStructureRevision

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

>{String}</RequestedProductStructureRevision>
10
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
11
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
12
     <Quantity
Quantity

Requested quantity for quote

>{Decimal}</Quantity>
13
     <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

>{Decimal}</RemainingQuantity>
14
     <Price>
15
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
16
          <TargetPrice
TargetPrice

The requested target price for this item

>{Decimal}</TargetPrice>
17
     </Price>
18
     <PriceConverted
PriceConverted

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

>
19
          <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=PriceConverted in your request URI to get this field

>{String}</Currency>
20
          <TargetPrice
TargetPrice

The requested target price for this item

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

>{Decimal}</TargetPrice>
21
     </PriceConverted>
22
     <Totals>
23
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
24
          <TargetAmount
TargetAmount

The total item amount. Calculated by multiplying target price with quantity.

>{Decimal}</TargetAmount>
25
     </Totals>
26
     <TotalsConverted
TotalsConverted

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

>
27
          <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=TotalsConverted in your request URI to get this field

>{String}</Currency>
28
          <TargetAmount
TargetAmount

The total item amount. Calculated by multiplying target price with quantity.

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

>{Decimal}</TargetAmount>
29
     </TotalsConverted>
30
     <MeasurementUnit>
31
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

>{String}</Unit>
33
          <Precision
Precision

The precision/accuracy of the measurement (number of decimals)

>{Integer}</Precision>
34
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
35
     </MeasurementUnit>
36
     <Product>
37
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
40
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>
41
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>
42
          <ProductClassification>
43
               <ProductClassificationId
ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>
44
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>
45
          </ProductClassification>
46
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
47
     </Product>
48
     <Manufacturer>
49
          <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
50
          <Name
Name

Company name of the manufacturer.

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

>{String}</Name>
51
          <ShortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
53
     </Manufacturer>
54
     <ManufacturersProduct
ManufacturersProduct

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

>
55
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
56
          <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=ManufacturersProduct in your request URI to get this field

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
58
     </ManufacturersProduct>
59
     <SalesCase>
60
          <Database
Database

Database of the object

>{String}</Database>
61
          <ItemId
ItemId

Item-number of the object

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

Type of item

>{String}</ItemType>
63
          <Status
Status

Status of the sales item

>{Integer}</Status>
64
          <Quantity
Quantity

Quantity of the sales item

>{Decimal}</Quantity>
65
          <Seller
Seller

Reference to the seller of the item

>
66
               <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
70
          </Seller>
71
          <Object>
72
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
73
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
74
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
75
               <Assignee
Assignee

The user who has been assigned to work with this object.

>
76
                    <UserId
UserId

User identifier

>{Integer}</UserId>
77
                    <Name
Name

Name of the user

>{String}</Name>
78
                    <FirstName
FirstName

First name of the user

>{String}</FirstName>
79
                    <UserLink
UserLink

User reference

>{String}</UserLink>
80
               </Assignee>
81
               <Customer>
82
                    <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
84
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
85
               </Customer>
86
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
87
          </Object>
88
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
90
     </SalesCase>
91
     <ForwardedTo
ForwardedTo

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

>
92
          <OpenForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

>{Decimal}</OpenForwardedQuantity>
93
          <ForwardedToItems
ForwardedToItems

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

>
94
               <Item
Item

Item this item was forwarded to.

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

>
95
                    <ItemId
ItemId

Identifier of the object

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

>{Integer}</ItemId>
96
                    <Object
Object

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

>
97
                         <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
100
                    </Object>
101
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

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

API reference to the item

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

>{String}</ItemLink>
103
               </Item>
104
          </ForwardedToItems>
105
     </ForwardedTo>
106
     <HighlightedNotification
HighlightedNotification

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

>
107
          <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

>{Datetime}</CreatedAt>
110
          <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=HighlightedNotification in your request URI to get this field

>{String}</Message>
111
          <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=HighlightedNotification in your request URI to get this field

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

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

>
113
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
114
               <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=HighlightedNotification in your request URI to get this field

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

Notification type reference

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

>{String}</NotificationTypeLink>
116
          </NotificationType>
117
          <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
118
     </HighlightedNotification>
119
</PurchaseQuoteRequestItem>
1
{
2
     "purchaseQuoteRequestItem": {
3
          "purchaseQuoteRequestItemId
PurchaseQuoteRequestItemId

Purchase quote request item identifier

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

Status of item

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
7
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

": "{Date}",
8
          "suppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

": "{String}",
9
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

": "{String}",
10
          "requestedProductStructureRevision
RequestedProductStructureRevision

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

": "{String}",
11
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
12
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
13
          "quantity
Quantity

Requested quantity for quote

": "{Decimal}",
14
          "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

": "{Decimal}",
15
          "price": {
16
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
17
               "targetPrice
TargetPrice

The requested target price for this item

": "{Decimal}"
18
          },
19
          "priceConverted
PriceConverted

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

": {
20
               "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=PriceConverted in your request URI to get this field

": "{String}",
21
               "targetPrice
TargetPrice

The requested target price for this item

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

": "{Decimal}"
22
          },
23
          "totals": {
24
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
25
               "targetAmount
TargetAmount

The total item amount. Calculated by multiplying target price with quantity.

": "{Decimal}"
26
          },
27
          "totalsConverted
TotalsConverted

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

": {
28
               "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=TotalsConverted in your request URI to get this field

": "{String}",
29
               "targetAmount
TargetAmount

The total item amount. Calculated by multiplying target price with quantity.

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

": "{Decimal}"
30
          },
31
          "measurementUnit": {
32
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

": "{String}",
34
               "precision
Precision

The precision/accuracy of the measurement (number of decimals)

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

Material unit reference

": "{String}"
36
          },
37
          "product": {
38
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
41
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
42
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
43
               "productClassification": {
44
                    "productClassificationId
ProductClassificationId

Product classification identifier

": "{String}",
45
                    "productClassificationLink
ProductClassificationLink

Product classification reference

": "{String}"
46
               },
47
               "productLink
ProductLink

Product reference

": "{String}"
48
          },
49
          "manufacturer": {
50
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

": "{String}",
52
               "shortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
54
          },
55
          "manufacturersProduct
ManufacturersProduct

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

": {
56
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

": "{Integer}",
57
               "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=ManufacturersProduct in your request URI to get this field

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

Manufacturers product reference

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

": "{String}"
59
          },
60
          "salesCase": {
61
               "database
Database

Database of the object

": "{String}",
62
               "itemId
ItemId

Item-number of the object

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

Type of item

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

Status of the sales item

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

Quantity of the sales item

": "{Decimal}",
66
               "seller
Seller

Reference to the seller of the item

": {
67
                    "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
71
               },
72
               "object": {
73
                    "objectType
ObjectType

Type of object

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

Identifier of the object

": "{Integer}",
75
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
76
                    "assignee
Assignee

The user who has been assigned to work with this object.

": {
77
                         "userId
UserId

User identifier

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

Name of the user

": "{String}",
79
                         "firstName
FirstName

First name of the user

": "{String}",
80
                         "userLink
UserLink

User reference

": "{String}"
81
                    },
82
                    "customer": {
83
                         "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
86
                    },
87
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
88
               },
89
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
90
               "itemLink
ItemLink

API reference to the item

": "{String}"
91
          },
92
          "forwardedTo
ForwardedTo

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

": {
93
               "openForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

": "{Decimal}",
94
               "forwardedToItems
ForwardedToItems

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

": [
95
                    {
96
                         "itemId
ItemId

Identifier of the object

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

": "{Integer}",
97
                         "object
Object

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

": {
98
                              "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
101
                         },
102
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

": "{String}",
103
                         "itemLink
ItemLink

API reference to the item

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

": "{String}"
104
                    }
105
               ]
106
          },
107
          "highlightedNotification
HighlightedNotification

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

": {
108
               "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

": "{Datetime}",
111
               "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=HighlightedNotification in your request URI to get this field

": "{String}",
112
               "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=HighlightedNotification in your request URI to get this field

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

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

": {
114
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
115
                    "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=HighlightedNotification in your request URI to get this field

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

Notification type reference

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

": "{String}"
117
               },
118
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
119
          }
120
     }
121
}

Possible error codes the response might return:

Error 100147 HTTP 404 Notification type not found
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required