Purchasing - REST API icon

Purchasing - REST API

1.3.x
(0 reviews)

API Specification

Table of contents :

The Analytics API supports the following endpoints :

Purchasing organisations

GET /rest/v1/purchasing-organisations

Headers

This endpoint requires the next HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
X-Webhook-Correlation-Id: {Optional header parameter provided by the client in case of webhook usage}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Response

The payload returned by the GET operation has the following format:

{
    "header": {},
    "data": {},
    "error": {}
}

Query parameters

parameter nametypecan be a list *accept wildcard *
purchasingOrganisationstringyesno
companyCodestringyesno
plantNumberstringyesno

Example of use

/rest/v1/purchasing-groups?purchasingGroupCode=0*,1*,2*,3*,4*,5*,6*,7*,8*,9*

Purchasing groups

GET /rest/v1/purchasing-groups

Headers

This endpoint requires the next HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Response

The payload returned by the GET operation has the following format:

{
    "header": {},
    "data": {},
    "error": {}
}

Query parameters

parameter nametypecan be a list *accept wildcard *
purchasingGroupCodestringyesyes

Example of use

/rest/v1/purchasing-organisations?purchasingOrganisation=1600,8000

Purchasing assets

GET /rest/v1/purchasing-assets

Headers

This endpoint requires the next HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Response

The payload returned by the GET operation has the following format:

{
    "header": {},
    "data": {},
    "error": {}
}

Query parameters

parameter nametypecan be a list *accept wildcard *
purchasingOrganisationstringyesno
companyCodestringyesno
assetNumberstringyesno
projectNumberstringyesno
analyticalUnitstringyesno
createdOnstringnono
changedOnstringnono

Example of use

/rest/v1/purchasing-assets?purchasingOrganisation=1600,8000=2021-04-28
can be a list

Means that a list of parameters can be passed separated by a comma as followed :

(example: 1600,8000,9000)

accept wildcard

Means that a wildcard ca be passed as followed :

(example: 1*)

Reviews