Documentation Center

Completing task steps

To complete a task step, you need to claim the task and find out the ID of the outbound transition to the next workflow step.

Before you begin

Make sure that you have the appropriate permissions to complete task steps. Otherwise, WorldServer will return a 403 Forbidden status code.A screen shot that highlights one of the permissions you need to complete task steps.

About this task

A diagram that shows the process of completing task steps.

Procedure

  1. Log in to the WorldServer API.
    A response similar to the following is returned. In the response, identify the value of the sessionId parameter. You will need this value in all the calls you make.A screen shot that highlights the sessionId in the response to the login call.
  2. Claim the task.
  3. Find out the ID of the transition to the next workflow step by doing the following:
    1. Get information about the task.
      The returned task information contains the ID of the workflow. You need this ID to find out the ID of the next outbound transition.A screen shot that highlights the ID of the workflow in the response to the task information request.
    2. Get information about the workflow.
      The returned workflow information contains the ID of the outbound transition. You need this ID to complete the task step.A screen shot that highlights the ID of the next outbound transition in the response to the workflow information request.
  4. Complete the task step.
    The JSON request body you use should be similar to the following:A screen shot that shows a possible JSON request body. In this case, id is the ID of the task whose step you want to complete, transitionId is the ID of the outbound transition to the next workflow step, and comment is optional.

What to do next

Unclaim the task, so that other users can pick it up and start working on it.