Update segments
Update segments in a certain task. If the request is not valid (for example, if a segment placeholder cannot be validated), no segments are updated.
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/v2/segments?token=<sessionId>&taskId=<taskId>
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), the taskId (as a query string parameter), and a request body that includes at least the tag and the target parameters
Request body example
Response
Error messages
| Message | Status code |
|---|---|
| Target text placeholders are invalid for tag: string and list both null (If the target is not provided.) | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |
| Resource TASK (ID) not found | 404 Not Found |
| Resource TASK (ID) not valid (If the ID you entered is not a valid number.) | 500 Internal Server Error |
| Illegal segment tag null (If the request body does not contain the tag.) | 500 Internal Server Error |
| Provided segment tag not found (Null Pointer Exception) | 500 Internal Server Error |