This API retrieves the delivery types of a project from Smart Materials. You can either retrieve a single delivery type using delivery type Id or all the delivery types 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’)/DeliveryTypes({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 type Id (DtpId).
To retrieve all the delivery types of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/DeliveryTypes
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/DeliveryTypes(5100)
Success Response
Status:200OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/DeliveryTypes",
"value": [
{
"DtpId":5100,
"ProjId":"RS",
"DtpCode":"HHI",
"DpId":500017
}]
}
Element |
Description |
Type |
---|---|---|
DtpId |
Unique ID of the delivery type |
Integer |
ProjId |
Unique ID of the Project. Retrieved delivery type belongs to this Project. |
String |
DtpCode |
Name of the delivery type |
String |
DpId |
Unique ID of the Discipline. Retrieved delivery type belongs to this Discipline. |
Integer |