This API retrieves the delivery designations of a project from Smart Materials. You can either retrieve a single delivery designation using delivery designation Id or all the delivery designations of a project.
Required Privilege: API_READONLY
Headers
Header Name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/DeliveryDesignations({key})
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the delivery designation Id (DdId).
To retrieve all the delivery designations of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/DeliveryDesignations
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/DeliveryDesignations(5000)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/DeliveryDesignations",
"value":[
{
"DdId":5000,
"DdCode":"DUMMY",
"ProjId":"PG",
"DtpId":5000
}]
}
Element |
Description |
Type |
---|---|---|
DdId |
Unique ID of the retrieved delivery designation |
Integer |
DdCode |
Name of the delivery designation |
String |
ProjId |
Unique ID of the Project. Retrieved delivery designation belongs to this Project. |
String |
DtpId |
Unique ID of the delivery type of the retrieved delivery designation |
Integer |