Documentation Center

Update attribute values

Update the values of certain attributes.

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 Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeValues?token=<sessionId>

Details

  • POST 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)
    • resource (in the JSON body): id
    • attribute (in the JSON body): id, name, resourceType, type, readOnly

Request body examples

Task and project attribute values:A screen shot that shows a typical request body for updating task and project attribute values.
Workgroup attribute values:A screen shot that shows a typical request body for updating workgroup attribute values.

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
Field attribute.name is not set400 Bad Request
Field attribute.type is not set400 Bad Request
No session token provided or invalid token401 Unauthorized
The resource Id is not found or is not a valid number (Null Pointer Exception)500 Internal Server Error
Resource Type is not set (Null Pointer Exception)500 Internal Server Error
Field readOnly is not provided (Null Pointer Exception)500 Internal Server Error
Field resource is not provided (Null Pointer Exception)500 Internal Server Error