This API retrieves the idents of a project from Smart Materials. You can either retrieve a single ident using ident Id or all the idents 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’)/Idents({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 ident.
To retrieve all the idents of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Idents
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Idents(3086370)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "http://localhost:59387/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/Idents/$entity",
"Ident": 3086370,
"IdentCode": "C2KRHV",
"ProjId": "PG",
"ShortDescription": "- Sev serv ctrl valve\nI_Valve_Material: , Duplex\nI_Diameter: , 3/4 inch\nI_Rating: ,6000#\nI_Handwheel:,Without handwheel\nI_Solenoid_Valve: , With solenoid/switch\n",
"CommodityId": 924526,
"Input1": "0",
"Input2": "0",
"Input3": "0",
"Input4": "0",
"Input5": "0",
"TagNumber": null
}
Element |
Description |
Type |
---|---|---|
Ident |
Unique ID of the retrieved ident |
Integer |
IdentCode |
Code of the ident created by the ident generation |
String |
ProjId |
Unique ID of the Project. Retrieved ident belongs to this Project. |
String |
CommodityId |
Unique ID of the commodity. Retrieved ident belongs to this commodity. |
Integer |
Input (1-5) |
Represents sizes of the ident |
String |
TagNumber |
Tag number associated with the retrieved ident |
String |
ShortDescription |
Short description of the ident |
String |