This API retrieves the Projects from Smart Materials. You can either retrieve a single Project using Project Id or all the Projects.
-
No privilege is required to access the project details.
-
Only projects that are assigned to the logged-in user are retrieved.
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(':key')
Specify values for project and key parameter in the URL. The key parameter defines the Project Id (ProjId).
To retrieve all the Projects of Smart Materials, use the following URL:
GET https://{host}/Smat/V1/Projects
Sample Code
GET https://{host}/Smat/V1/Projects(DOCU)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects",
"value":[
{
"ProjId":"DOCU",
"Description":"NEW PROJECT",
"PgCode":"PG"
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
ProjId |
Unique ID of the Project |
String |
|
Description |
Description related to the Project |
String |
|
PgCode |
Name of the Product Group. Retrieved Project belongs to this Product Group. |
String |