Get information about a specific attribute definition
Get information about an attribute based on its ID.
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.
API call
<protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeDefinitions/<attributeId>?token=<sessionId>
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 ID of the attribute definition (as a URI parameter)
Available filters
You can add the filters as query string parameters or as key-value pairs in the header:
| Filter | Description |
|---|---|
| fields=<fieldName1,fieldName2,...,fieldNameN> | The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter. |
| excludedFields=<fieldName1,fieldName2,…,fieldNameN> | The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter. |
Examples:
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeDefinitions/<attributeId>?token=<sessionId>&fields=id,name
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeDefinitions/<attributeId>?token=<sessionId>&excludedFields=name
Response
Error messages
| Message | Status code |
|---|---|
| No session provided or invalid session token | 401 Unauthorized |
| Resource ATTRIBUTE_DEFINITION (ID) not found | 404 Not Found |
| For input string: \<invalidId>\ (If the ID you entered is not a valid number.) | 500 Internal Server Error |