Documentation Center

Tutorial: Full project completion scenario

A scenario that follows a project throughout its entire life cycle, from its creation to its completion.

Before you begin

Make sure that you have the appropriate permissions to create project groups. Otherwise, WorldServer will return a 403 Forbidden status code.A screen shot that highlights one of the permissions required to create project groups through the WorldServer API.

Also, you need to use already uploaded assets or to upload new assets. If you want to use already uploaded assets, you need the internalName of each file. If you want to use new assets, upload them into WorldServer.

After you upload an asset through the API, the response includes an internalName property. Take a screen shot of it or write down its value. You will need it in all operations involving uploaded assets.A screen shot that highlights the internalName of an asset.

About this task

A diagram showing the process that a project goes through, from its creation to its completion.

Procedure

  1. Create a new project group.
    You can find the ID of your new project group in the response.
  2. Translate the project.
    Your project group can have one or more projects in it, depending on the number of target locales you selected when creating it. To get the IDs of all the projects in your project group, make a GET call to the following endpoint and write down the appropriate IDs in the response: <protocol>://<ws-host>:<ws-port>/ws-api/v1/<projectGroupId>?token=<sessionId>
  3. Download the translated assets.
    In the request body, include the ID of the project group, PROJECT_GROUP as the resource type, and TARGET as the asset location type.
  4. Complete the project.