Upload files as attribute values
Upload a file and set it as the value of an attribute.
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
To upload a file as the value of an attribute, you need to find out the ID of the attribute definition to which you want to attach the file. You can find out its ID by making a GET call to the following endpoint, and then writing down the ID of the appropriate attribute definition in the response: <protocol>://<ws-host>:<ws-port>/ws-api/v2/attributeDefinitions?token=<sessionId>&resourceType=<value>
resourceType=TASK). Its ID is highlighted in the response:API call
Details
- POST method
- Content-Type in the header:
application/json - Mandatory body type:
form-data, with a file as its content (a property key namedfileand the file that you want to upload as its value) - Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header), the file (in the
form-databody) and the ID of the attribute definition to which you want to attach the file (as a URI parameter)
Response
Error messages
| Message | Status code |
|---|---|
| No session token provided or invalid token | 401 Unauthorized |
Resource ATTRIBUTE_DEFINITION (ID) not found | 404 Not Found |
Internal Server Error:
| 500 Internal Server Error |