Upload assets

Upload project assets to WorldServer. You can then use these assets to create project groups.

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/files?token=<sessionId>

Details

  • POST method
  • Content-Type in the header: application/json
  • Mandatory body type: form-data, with a file as its content (a property key named file and the file that you want to upload as its value)
  • Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)
  • Optional parameter: expandZip—If you set it to true and you upload a .zip file, WorldServer automatically extracts the assets included in the .zip file.

Form-data example

A screen shot that shows the form-data body required to make this call.

Response

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

Error messages

No session token provided (401 Unauthorized). This message is also displayed if you do not select a file.