Get project attributes
Get the custom project attributes defined for a certain project type.
For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
Prerequisites
You need to find out the ID of the project type whose project attributes you want to obtain. To do so, make a GET call to the /projectTypes endpoint.
API call
<protocol>://<ws-host>:<ws-port>/ws-api/v1/projectAttributes?token=<sessionId>&projectTypeId=<projectTypeId>
Details
- GET method
- Content-Type in the header:
application/json - Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header) and the projectTypeId (as a query string parameter)
Response
Error messages
| Message | Status code |
|---|---|
| No session token provided or invalid token | 401 Unauthorized |
| Resource PROJECT_TYPE (ID) not found | 404 Not Found |
| Required int parameter 'projectTypeId' is not present | 500 Internal Server Error |
| Failed to convert value of type [...] (If the ID you entered is not a valid number.) | 500 Internal Server Error |