Transperfectconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 84 actions for the Transperfectconnector v1.0.

Authorization

POST Authorize Local

/oauth/token

Authorize the local instance by exchanging credentials for an access token. Use this action to authenticate before making other API calls.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The media type of the request body, typically set to application/x-www-form-urlencoded.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Grant Type`	The OAuth grant type to use, such as password for resource owner password credentials flow.
`Username`	The username of the Transperfect account to authenticate.
`Password`	The password of the Transperfect account to authenticate.

Cancel

POST Cancel items

/rest/v0/submissions/cancel/{sub_id}

This resource allows you to cancel any items you need: submissions, documents or targets.
Documents and targets are specified in the request body in JSON format:
{
"targetIds": [

123,124,125

],
"documentIds": [

20,21,22

],
}
If the request body is empty, the whole submission will be cancelled.
You need to make sure that the targetIds and/or documentIds belong to the specified submission.

IMPORTANT NOTE: it's not possible to cancel documents/targets from on hold submissions.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission to cancel.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Targetids`	An array of target IDs to cancel within the submission; if omitted, the entire submission is canceled.

Claim (3)

POST Claim - LANGUAGE

/rest/v0/submissions/claim

Claim a submission for a specific language and phase. Use this to assign work to a translator or reviewer.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Submissionid`	The ID of the submission to claim.
`Phasename`	The name of the phase to claim, such as translation or review.
`Languages`	An array of language codes to claim within the submission.

GET Get claimable submissions - FILE

/rest/v0/submissions/claimable/{sub_id}/targets

Retrieve a list of claimable target items for a specific submission. Use to see which targets are available for claiming.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Phasename`	The name of the phase for which to list claimable targets.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get claimable submissions - LANGUAGE & BATCH

/rest/v0/submissions/claimable

Retrieve all claimable submissions across languages and batches. Use to find work that can be claimed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Phasename`	The name of the phase for which to list claimable submissions.
`Response Type`	The response format expected from the API (e.g. application/json).

Create submission (9)

POST Analyze submission

/rest/v0/submissions/{sub_id}/analyze

Trigger an analysis of a submission to calculate word counts and other metrics. Use before saving or starting a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission to analyze.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Check async status

/rest/v0/submissions/{sub_id}/status

Async operations, like uploading a file or analyzing a submission, can take some time. You can call this resource to check if the async operation you started on a submission is already completed.
It will return "status": "PROCESSED" if the operation is finished or "status": "PROCESSING" if it's not.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission whose status to check.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create submission

/rest/v0/submissions/create

NOTES:

"dueDate" is expressed as Unix timestamp in milliseconds.
If you're connecting to a box in TPT mode, you'll need to add the "paClientId" parameter with the correct value.
If you want to upload a non-parsable file, set the "targetFormat" value to "NON_PARSABLE". Then, when you call POST /upload, leave the "fileFormatName" parameter blank.
"targetFormat" can be "TXML", "TXLF" or "NON_PARSABLE", according to the type of conversion that PD will make.
If the project has mandatory custom attributes, you need to specify them when you call POST /create, otherwise the call will be rejected. E.g.:

"customAttributes": [
{
"name": "myAttributeName",
"value": "myValue"
}
]

If you want PD to return webhooks for your submission, you need to add the relevant metadata fields (metadata URL and scope) when the submission is created, as in the example below. Note that webhook metadata can be added at any point during the submission lifecycle, although adding it during creation is the most common scenario. For more information, please check: https://onlinehelp.translations.com/PD/5.16/en/API-Developer/GlobalLink_Project_Director_Help.htm?tab=05_Webhooks#section/Enable-delivery-webhooks-for-a-specific-submission

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Projectid`	The ID of the project to associate with the submission.
`Paclientid`	The ID of the client in the PA system.
`Duedate`	The due date for the submission, provided as a Unix timestamp.
`Sourcelanguage`	The source language code for the submission.
`Claimscope`	The scope of claiming, such as LANGUAGE or FILE.
`Name`	A descriptive name for the submission.

POST Get wordcount

/rest/v0/submissions/{sub_id}/wordcount

Note: This resource is only available in PD 5.14 and later.

If the request body is empty, PD will return the aggregate wordcount for the whole submission.
You can also retrieve wordcounts for specific items in the submission, namely wordcount for a specific target language, a document, a target or a batch as follows:

{
"targetLanguage": "string"
}

---------

{
"documentId": 0
}

---------

{
"targetId": 0
}

---------

{
"batchName": "string"
}

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Save submission

/rest/v0/submissions/{sub_id}/save

If you set the "autoStart" parameter in the request body to "true", PD will automatically analyze and start the submission (if possible).
If you set it to "false", you'll need to manually call POST /analyze and POST /start.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission to save.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Autostart`	If true, the submission will automatically start after saving.

POST Start submission

/rest/v0/submissions/{sub_id}/start

Start a submission to begin processing. Use after saving and uploading all required files.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission to start.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload collateral

/rest/v0/submissions/{sub_id}/upload/collateral

Available in PD 5.19 and newer.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`File`	The file content to upload.
`Submissionlevel`	If true, the collateral applies to the entire submission; if false, it applies to a specific target.
`Extractarchive`	If true, archives are extracted and files are processed individually.

POST Upload reference

/rest/v0/submissions/{sub_id}/upload/reference

When you upload a reference file, you can make it available at the submission level (i.e. for all languages) by setting "submissionLevel" to "true".
If you want to make it available only to some specific languages, you can specify these languages (as a comma-separated list) in the "targetLanguageLevel" parameter.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The media type of the file being uploaded, such as multipart/form-data.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	The file content to upload.
`Submissionlevel`	If true, the reference applies to the entire submission; if false, to a specific target.

POST Upload source

/rest/v0/submissions/{sub_id}/upload/source

Upload the source file to be translated. Use to provide the document that needs translation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`File`	The source file content to upload.
`Batchname`	An optional name for the batch if uploading multiple source files.
`Fileformatname`	The format of the source file, such as docx or xlsx.
`Extractarchive`	If true, archives are extracted and files are processed individually.

Custom attributes (6)

POST Add custom attribute

/rest/v0/submissions/{sub_id}/customattributes/

This resource lets you add a custom attribute value to a submission.
The custom attribute name must be defined in the project.
The attribute name and value are sent in the request body in JSON format as shown in the example.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The name of the custom attribute.
`Value`	The value of the custom attribute.

DELETE Delete custom attr by name

/rest/v0/submissions/{sub_id}/customattributes/MyAttributeName

This resource lets you delete one custom attribute from a submission (specified in the URL).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete custom attribute

/rest/v0/submissions/{sub_id}/customattributes/

This resource lets you delete all custom attributes in a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit custom attribute

/rest/v0/submissions/{sub_id}/customattributes/MyAttributeName

Modify the value of a custom attribute on a submission by specifying the attribute name directly in the endpoint path.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Value`	The value of the custom attribute.

GET Get custom attrib by field name

/rest/v0/submissions/{sub_id}/customattributes/MyAttributeName

Add the attribute name to the URL. In this example it's called "MyAttributeName".

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get custom attributes

/rest/v0/submissions/{sub_id}/customattributes

Retrieve all custom attributes and their values associated with a given submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Document (2)

GET Get Documents by Document Id

/rest/v0/submissions/{sub_id}/documents/{document_id}

Fetch details of a specific document within a submission using the document's unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Document Id`	The unique identifier of the document to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Submission Documents

/rest/v0/submissions/{sub_id}/documents

This resource returns all the source documents of a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Download submission (4)

GET Download All Sources

/rest/v0/submissions/{sub_id}/download

The download process works in 3 steps:
1. You call GET /download with the appropriate URL parameters (sourceFiles=true in this example); PD will start preparing the file for download an return a downloadId
2. You call GET /download with the downloadId you got in #1 to verify if the file is actually ready for download (see "Download - Check Availability" below)
3. Once you get a "processingFinished":"true" value in #2, you call GET /download again with the downloadId to retrieve the actual file (see "Download Content" below)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sourcefiles`	Whether to include source files in the download; set to true to include them.
`Deliverabletargetids`	Comma-separated list of deliverable target IDs to restrict the download to specific deliverables.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Download Content

/rest/v0/submissions/download/{download_activity_id}

The final step in the download process is calling this resource. PD will return the content you requested in zip format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Download Activity Id`	The unique identifier of the download activity whose content should be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Download References Lang Level

/rest/v0/submissions/123/download

This example shows how to download the language-level reference files from a submission. You can specify several languages separated by commas.
Check "Download All Sources" for detailed instructions on how to download content from PD.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Languagereferencefiles`	The language code or identifier for which reference files are requested.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET TMs by Project (only client mode)

Retrieve translation memories for a project when operating in client mode; this endpoint has no parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Download

GET Download Asset

x-oneteg-downloader-path-with-authorization

Download an asset using a custom download path and authorization, with configurable timeout and retry settings.

Parameters

Parameter Name	Description
`HTTP Method`	The HTTP method (e.g., GET) to use for the download request.
`Download Url`	The full URL from which the asset should be downloaded.
`Asset Name`	The name of the asset being downloaded, used for identification.
`Try Count`	Number of retry attempts if the download fails, expressed as a string.
`Read Timeout (seconds)`	Maximum time in seconds to wait for data during the download.
`Connection Timeout (seconds)`	Maximum time in seconds to wait for the connection to be established.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.

Glossary Profiles (5)

GET Get Glossaries by Project (client mode only) [5.13+]

/rest/v0/organizations/projects/{project_id}/glossaries

This resource returns the list of Term Manager connections available for the specified project.
This resource is only available for PD instances running in client mode (i.e. non-TPT mode).
Calling this resource on an instance running in TPT mode will generate an error.
This resource is only available in PD 5.13+

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project whose glossaries should be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Glossaries by ProjectA Client (TPT mode only) [5.13+]

/rest/v0/paclients/{paclient_id}/glossaries

This resource returns the list of Term Manager connections available for the specified ProjectA client.
This resource is only available for PD instances running in TPT mode.
Calling this resource on an instance running in client mode will generate an error.
This resource is only available in PD 5.13+

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Paclient Id`	The unique identifier of the PAClient whose glossaries should be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Glossaries by submission Id

/rest/v0/submissions/{sub_id}/glossaries

Only available in PD 5.20+.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Glossary by Name and Project

/rest/v0/organizations/project/{project_id}/glossary/{glossary_name}

Retrieve a specific glossary by its name and associated project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Glossary Name`	The name of the glossary to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Glossary by Org, PAClient and Name

/rest/v0/organizations/{org_id}/paclients/{paclient_id}/glossary/{glossary_name}

Retrieve a specific glossary by its organization, PAClient, and name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Org Id`	The unique identifier of the organization that owns the glossary.
`Paclient Id`	The unique identifier of the PAClient associated with the glossary.
`Glossary Name`	The name of the glossary to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

MT Information

POST New Request

/rest/v0/submissions/{sub_id}/targets/{get_targets_subid}/editorinfo/phase

Returns the Machine Translation profile info of the specified target at the current phase as stored in PD.

In order to use it, a valid editor name must be specified in the request body.

If you need to use this endpoint for your integration, please get in touch with the PD PDM team.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Get Targets Subid`	The submission ID for which the target's editor information phase should be updated.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Editor`	The editor identifier to assign for the MT request, provided as a string value.

Metadata (6)

POST Add metadata

/rest/v0/submissions/{sub_id}/metadata

Add a metadata key-value pair to a submission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Key`	The metadata key to be added or updated on the submission.
`Value`	The value of the custom attribute.

DELETE Delete metadata

/rest/v0/submissions/{sub_id}/metadata

Deletes all metadata associated with a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete metadata by key

/rest/v0/submissions/{sub_id}/metadata/MyMetadataName

Deletes a specific metadata entry by its key from a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit metadata

/rest/v0/submissions/{sub_id}/metadata/MyMetadataName

Updates or creates a specific metadata entry by key for a submission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Value`	The value of the custom attribute.

GET Get metadata

/rest/v0/submissions/{sub_id}/metadata

Retrieves all metadata for a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get metadata by key

/rest/v0/submissions/{sub_id}/metadata/MyMetadataName

Retrieves a specific metadata entry by key from a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Organizations (3)

GET [Organizations] - Get organization PA clients

/rest/v0/organizations/{organization_id}/paclients

Retrieves the list of PA clients associated with a specific organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The unique identifier of the organization whose PA clients are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET [Organizations] - Get organization by Id

/rest/v0/organizations/{organization_id}

Retrieves details of a specific organization by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The unique identifier of the organization to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET [Organizations] - Get organizations

/rest/v0/organizations

Retrieves a list of all organizations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PA Clients (2)

GET Get PA Client by Id

/rest/v0/paclients/{paclient_id}

Retrieves details of a specific PA client by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Paclient Id`	The unique identifier of the PAClient associated with the glossary.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get PA Clients

/rest/v0/paclients

Retrieves a list of all PA clients.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Projects (9)

GET Get MSLA levels

/rest/v0/projects/{project_id}/mslalevels

Retrieves the MSLA (Master Service Level Agreement) levels for a specific project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get custom attributes

/rest/v0/projects/{project_id}/customattributes

Retrieves the custom attributes defined for a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get file formats

/rest/v0/projects/{project_id}/fileformats

Retrieves the file formats supported by a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get language directions

/rest/v0/projects/{project_id}/languagedirections

Retrieves the language directions (source to target) configured for a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get organization users

/rest/v0/projects/{project_id}/users/org

Retrieves the list of users belonging to the organization that owns the project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get project by Id

/rest/v0/projects/{project_id}

Retrieves details of a specific project by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get projects

/rest/v0/projects

The "shortCode" parameter is only available in PD 5.20+.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get workflow by Id

/rest/v0/projects/{project_id}/workflows/{workflow_id}

Retrieves details of a specific workflow within a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Workflow Id`	The unique identifier of the workflow to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get workflows

/rest/v0/projects/{project_id}/workflows

Retrieves a list of all workflows for a project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Quotes (3)

POST Approve Quote

/rest/v0/submissions/{sub_id}/quote/approve

Approves a quote for a submission, optionally with a comment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Comment`	A comment to include with the quote approval.

POST Download Quote Report

/rest/v0/submissions/{sub_id}/quote/report

Generates and downloads a quote report for a submission with configurable options.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Approvedquotesselected`	Indicates whether to include approved quotes in the report.
`Providedquotesselected`	Indicates whether to include provided quotes in the report.
`Emailenabled`	Indicates whether to send the report via email.
`Outputformat`	The output format for the report, such as PDF or Excel.

GET Review Quotes

/rest/v0/submissions/{sub_id}/quote/review

Retrieves the review information for quotes associated with a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Submission (7)

GET Get Submission Owner

/rest/v0/submissions/{sub_id}/owners

Retrieves the owner(s) of a submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get background for all submissions

/rest/v0/submissions/background

This resource returns the background info of all available submissions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get instructions for all submissions

/rest/v0/submissions/instructions

This resource returns the instructions of all available submissions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get submission background

/rest/v0/submissions/{sub_id}/background

This resource returns the background info of the specified submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get submission by Id

/rest/v0/submissions/{sub_id}

Retrieve a specific submission using its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get submission instructions

/rest/v0/submissions/{sub_id}/instructions

This resource returns the instructions of the specified submission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get submissions

/rest/v0/submissions

Retrieve a list of submissions, optionally filtered by one or more submission IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Submissionids`	Comma-separated list of submission IDs to filter the results.
`Response Type`	The response format expected from the API (e.g. application/json).

TM Profiles (5)

GET GET TMs by Project (client mode only) [5.13+]

/rest/v0/organizations/project/{project_id}/tms

This resource returns the list of TM strings available for the specified project.
This resource is only available for PD instances running in client mode (i.e. non-TPT mode).
Calling this resource on an instance running in TPT mode will generate an error.
This resource is only available in PD 5.13+

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET TMs by ProjectA Client (TPT mode only) [5.13+]

/rest/v0/paclients/{paclient_id}/tms

This resource returns the list of TM strings available for the specified ProjectA client.
This resource is only available for PD instances running in TPT mode.
Calling this resource on an instance running in client mode will generate an error.
This resource is only available in PD 5.13+

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Paclient Id`	The unique identifier of the PAClient associated with the glossary.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get TM by Name and Project

/rest/v0/organizations/project/{project_id}/tm/{tm_name}

Retrieve a translation memory profile by project ID and TM name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Project Id`	The unique identifier of the project that the glossary belongs to.
`Tm Name`	Name of the translation memory to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get TM by Org, PAClient and Name

/rest/v0/organizations/{organization_id}/paclients/{paclient_id}/tm/{tm_name}

Retrieve a translation memory profile by organization, PAClient, and TM name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The unique identifier of the organization to retrieve.
`Paclient Id`	The unique identifier of the PAClient associated with the glossary.
`Tm Name`	Name of the translation memory to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get TMs by submission Id

/rest/v0/submissions/{sub_id}/tms

Only available in PD 5.20+.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Targets (4)

POST Add metadata to target

/rest/v0/submissions/{get_targets_subid}/targets/metadata

Add metadata to one or more targets in a submission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Get Targets Subid`	The submission ID for which the target's editor information phase should be updated.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Targetids`	Array of target IDs to which metadata will be added.

GET Get Completed Targets by Submission

/rest/v0/targets

NOTES:

Only available in PD 5.20+.
You can use this endpoint to retrieve targets in any status, not only completed (e.g. cancelled or delivered). For a list of possible statuses, please check the online help.
The submissionIds parameter takes a comma-separated list of submissionIds, so you can specify as many subs as you need.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Targetstatus`	Status value to filter completed targets (e.g., "COMPLETED").
`Submissionids`	Comma-separated list of submission IDs to filter targets.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Targets by Document

/rest/v0/submissions/{sub_id}/documents/{document_id}/targets

This request is only available in PD 6.2+

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Document Id`	The unique identifier of the document to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Targets by Submission

/rest/v0/submissions/{sub_id}/targets

Starting with PD 5.15, you can use the "status" parameter to retrieve only targets in a specific status (e.g. only completed targets).

The possible values for the "status" parameter are:

COMPLETED - equivalent to PROCESSED status in the DB, target has been completed but not delivered
DELIVERED - target has been delivered to the client
READY - target has been analyzed, equivalent to READY status in DB
IN_PROCESS - target has been claimed, equivalent to IN_PROCESS status in DB
WAITING - target has been created, not analyzed, it's in On Hold, equivalent to WAITING status in DB

In PD 5.20 the "targetLanguage" is added. It lets users retrieve only targets for a specific language. It can be combined e.g. with the "status" parameter to retrieve only completed targets for a certain target language.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Unclaim (3)

GET Get claimed submissions - FILE

/rest/v0/submissions/claimed/{sub_id}/targets

Retrieve the targets of a claimed submission (FILE type) by submission ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Phasename`	The name of the phase for which to list claimable submissions.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get claimed submissions - LANGUAGE & BATCH

/rest/v0/submissions/claimed

Retrieve all claimed submissions (LANGUAGE and BATCH types).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Phasename`	The name of the phase for which to list claimable submissions.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Unclaim - LANGUAGE

/rest/v0/submissions/unclaim

Unclaim a submission for a language.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Submissionid`	The ID of the submission to claim.
`Phasename`	The name of the phase to claim, such as translation or review.
`Languages`	An array of language codes to claim within the submission.

Upload Files (3)

POST Mark as delivered

/rest/v0/submissions/{sub_id}/targets/delivered

Once you download some deliverable targets, you can call this resource to mark them as delivered in PD.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Targetids`	An array of target IDs to cancel within the submission; if omitted, the entire submission is canceled.

POST Upload Translatable

/rest/v0/submissions/{sub_id}/upload/translatable

Upload a translatable file to a submission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	The source file content to upload.
`Extractarchive`	If true, archives are extracted and files are processed individually.

GET Upload file - Verify

/rest/v0/submissions/{sub_id}/upload/translatable/{upload_process_id}

After uploading a translatable file (or files), call this resource to check if the file(s) were successfully uploaded. If the was any error, PD will return the corresponding error message(s).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Upload Process Id`	Unique identifier of the upload process to verify.
`Response Type`	The response format expected from the API (e.g. application/json).

Webhooks (3)

POST Reset failed webhooks

/rest/v0/webhooks/reset

Note: This resource is only available in PD 5.14 and later.
For more information on how to retrieve failed webhooks, check: https://onlinehelp.translations.com/PD/5.16/en/API-Developer/GlobalLink_Project_Director_Help.htm?tab=05_Webhooks#section/Enable-delivery-webhooks-for-a-specific-submission

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Submissionids`	Array of submission IDs for which to reset failed webhooks.

GET Retrieve failed webhooks

/rest/v0/webhooks/failed

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Set webhook URL

/rest/v0/submissions/{sub_id}/metadata/

NOTE: Normally, you'd want to define the webhook metadata when the submission is created (see POST /create above). However, you can set it at any point during the submission lifecycle. This endpoint should only be used to add webhook information if you have not set those values when the submission was created. If you added webhook metadata when the submission was created, you don't need to use this endpoint.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Key`	The metadata key to be added or updated on the submission.
`Value`	The value of the custom attribute.

Workflow (3)

POST Complete phase

/rest/v0/submissions/{sub_id}/phases/Translation/complete

Note that, in the URL, you need to specify the phase your target is in. In this example, the phase is "Translation".
The phase you want to transition your target(s) to, along with the targetIds, is specified in the request body in JSON format.
Remember that phase names are case-sensitive.
Currently, phases with spaces in the name are not supported (to be fixed in an upcoming release).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Targetids`	An array of target IDs to cancel within the submission; if omitted, the entire submission is canceled.
`Transition`	The transition to apply when completing the phase, such as 'approve' or 'reject'.

GET Get phase info

/rest/v0/submissions/{sub_id}/phases

Retrieve information about the phases of a submission, including their status and available transitions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get phase info for single target

/rest/v0/submissions/{sub_id}/targets/{get_targets_targetid}/phase

Available only in PD 5.20+.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sub Id`	The unique identifier of the submission.
`Get Targets Targetid`	The identifier of the target language for which to retrieve phase details.
`Response Type`	The response format expected from the API (e.g. application/json).