Documentation Center

Creating project groups

Before creating a new project group, you need to prepare a JSON request body that includes the ID of the project type, client, and locales that you want to use, as well as the internalName of each asset that you want to be translated as part of the project group.

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 that shows the process of creating project groups.

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. Create the request model for your new project group.
    You need to include the following information as part of a JSON request body:
    • The ID of the project type that you want to use.A screen shot that highlights the ID of the project type in the response to the Get information about a specific project type call.
    • The ID of the client that you want to use. Make sure that the project type you selected is available for that particular client and that the current user (the one identified by the sessionId) is a member of that client.A screen shot that highlights the ID of the client in the response to the Get information about a specific client call.
    • The IDs of the locales that you want to use, separated by comma. The locales you specify in the request body should be available as target locales for the project type you selected earlier.
    • The internalName of each asset that you want to be translated as part of this project group, separated by comma.
  3. Create the project group.

Results

The ID of your new project group is returned.