Export projects
Create export jobs for certain projects.
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/projects/export?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)
- ids (in the JSON body): the IDs of the projects that you want to export
- type (in the JSON body):
WSXZ(you can only export .wsxz packages)
Request body example
Response
The response status can be:
- OK: All the projects have been exported.
- PARTIAL_SUCCESS: Some of the projects have been exported.
- ERROR: None of the projects has been exported.
Error messages
| Message | Status code |
|---|---|
| Invalid JSON request model | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |
| Resource project (ID) not found | 404 Not Found |
| Invalid type 'given_type' for ExportType | 500 Internal Server Error |
| No project Ids were specified (Null Pointer Exception) | 500 Internal Server Error |