Documentation Center

Get attribute values

Get the attribute values of a specific resource.

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>&resourceType=<resourceType>&resourceId=<resourceId>

Details

  • GET method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token, the resourceType, and the resourceId (all as query string parameters; the session token can also be a key-value pair in the header)

The resourceType parameter can have the following values: VENDOR, PROJECT, TASK, USER, TM_TRANSLATION, TD_ENTRY, TD_TERM, WORKFLOW_ROLE, WORKGROUP, TM_GROUP, TD_GROUP, WORKFLOW, ISSUE, COST_MODEL, CLIENT, RFQ, REVIEW_MODEL, or TD_LANGUAGE.

The resourceId is the ID of the resource whose values you want to get, depending on the resource type you specified. For example, if you specify PROJECT as your resource type and 1059 as your resource ID, you will get the attribute values of the project whose ID is 1059.

Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeValues?token=<sessionId>&resourceType=PROJECT&resourceId=3492
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/attributeValues?token=<sessionId>&resourceType=TASK&resourceId=1025

Response

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

Error messages

MessageStatus code
Required filter resourceType not provided, or invalid400 Bad Request
Required filter resourceId not provided, or invalid400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource PROJECT (ID) not found404 Not Found
Project Id is not a valid number (This also applies to other invalid resource IDs.)500 Internal Server Error