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