Lionbridgeconnector v1

/jobs/{jobId}/archive

Archive a translation job. Once archived, a job and its underlying requests cannot be accessed, until it has been unarchived. This method is asynchronous.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

/jobs/{jobId}/unarchive

Unarchive a translation job. Unarchived jobs are returned when users query for a list of active jobs. This method is asynchronous.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

/jobs/{jobId}/sourcefiles

Adds a file to the specified jobId. This can then be used to create a translation request. Or it can be used as a support asset to a job that has not been submitted. This method is part of a 2-step process for transferring file to Lionbridge FMS, either using the TUS protocol or POSTing directly as multipart/form-data.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Filename`	Name of file, the max length is 250. This must include a file extension.
`Response Type`	N/A

/jobs/{jobId}/sourcefiles/{fmsFileId}

Retrieve the source content of translation request as a file. The method returns a 307 response code. Clients are expected to follow the url in the Location header. Most HTTP client libraries do this automatically or can be enabled by a configuration setting. For example, cURL has a -L option.

Note that this cannot be used for retrieving translated files. Use the GET /jobs/{jobId}/requests/{requestId}/retrievefile method instead.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Fmsfileid`	The FMS fileId.
`Response Type`	N/A

/jobs/{jobId}/requests/{requestId}/retrievefile

Retrieve the target content of translation request as a file. The method returns a 307 response code. Clients are expected to follow the url in the Location header. Most HTTP client libraries do this automatically or can be enabled by a configuration setting. For example, cURL has a -L option.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Requestid`	The ID of the translation request.
`Response Type`	N/A

/jobs/{jobId}/complete

Set job status to COMPLETED. Prevents further translations from being imported.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/jobs

Creates a new Translation job. This job acts as a container for translation requests.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (11)

Option Name	Description
`Jobname`	The name of the translation job.
`Description`	A description of the translation job.
`Poreference`	PO Reference of the translation job.
`Duedate`	Due date of the translation job. Expected format is defined by full-date ("yyyy-MM-dd") or date-time (e.g. "yyyy-MM-ddTHH:mm:ssZ") in RFC3339
`Customdata`	Deprecated. Please see extendedMetadata. User specified custom data.
`Shouldquote`	Request a quote for the job before translation proceeds. TODO - describe how quoting happens outside of REST API.
`Providerid`	The ID of the provider the job will be sent to. Requests under the job will be validated as they are created, prior to submission, if provider capabilities are defined. For more information, please refer to the Provider resource.
`Connectorname`	The official/descriptive name of the connector that is sending the job. If required, for connector certification, please contact Lionbridge connector support.
`Connectorversion`	The version number of the connector that is sending the job.
`Servicetype`	The type of service or workflow requested for the job.
`Globaltrackingid`	Reserved for Lionbridge internal services.

/jobs/{jobId}

Delete a translation job. This method should only be used as part of housekeeping activity after a job has been completed or cancelled. It is not intended for cancelling the job.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

/jobs/archived

This method returns a list of archived jobs.
The filter parameter can be used for querying with job fields. For example, to find jobs submitted to provider "my-provider-id" between May 24 and June 3, this filter can be used,

(providerId eq 'my-provider-id') AND (submittedDate lt '2021-06-03' and submittedDate gt '2021-05-24')

As another example, to find jobs not in COMPLETED OR CANCELED status and with dueDate before noon, June 21,

(statusCode ne 'CREATED' AND statusCode ne 'COMPLETED') and (dueDate lt '2021-06-21T12:00')

The following job fields are not supported on the filter and orderBy parameters,

description
latestErrorMessage
archived
extendedMetadata
requestStats

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Next

The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.

Fields

Comma-separated list of field names to include in response (e.g., "name,status,id"). JobId is always included in the response. If omitted then all the fields are included by default. Valid values are: activityDate, aggregateRequests, archiveStatus, archived, connectorName, connectorVersion, createdDate, creatorId, customData, description, dueDate, estimatedArchivalDate, extendedMetadata, globalTrackingId, hasError, jobName, labels, latestErrorMessage, modifiedDate, poReference, providerId, providerReference, requestStats, serviceType, shouldQuote, siteId, statusCode, submittedDate, submitterId

Filter

The filter parameter can be used to filter a collection of resources based on field values. Only items where the expression evaluates
to true are included in the query results. To reference a key within a Label, use dot notation, e.g. labels.env

The following operations are supported:

Operator	Description	Example
Comparison Operators
eq	Equal	hasError eq true
ne	Not equal	statusCode ne 'CREATED'
gt	Greater than	labels.pages gt 20
ge	Greater than or equal	labels.pages ge 10
lt	Less than	labels.pages lt 20
le	Less than or equal	labels.pages le 100
Logical Operators
and	Logical and	labels.pages le 200 and labels.pages gt 3.5
or	Logical or	labels.pages le 3.5 or labels.pages gt 200
not	Logical negation	not labels.pages le 3.5
Grouping Operators
( )	Precedence grouping	(labels.priority eq 1 or labels.env eq 'prod') and labels.pages gt 100

See method description for additional restrictions on fields.

Orderby

The orderBy parameter can be used to sort the results of a collection query based on field values. At most 1 field name can be specified. The parameter value may include the suffix "asc" for ascending or "desc" for descending, separated from the field name by space. If not included, "asc" is used by default. The parameter must be consistent across pagination. See method description for additional restrictions on fields.

Response Type

N/A

/jobs/{jobId}

Returns job data.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job being queried.
`Fetchtype`	Specifies what level of detail is returned for a job. The default is full if not specified. Note: FullWithStats is an experimental feature that is not yet supported.
`Response Type`	N/A

/jobs

This method returns information about Lionbridge translation
jobs. The response includes job IDs and detailed information of all active jobs
for the given user. Jobs are ordered by creation time, in reverse, by default.

The filter parameter can be used for querying with job fields. For example, to find jobs submitted to provider "my-provider-id" between May 24 and June 3, this filter can be used,

(providerId eq 'my-provider-id') AND (submittedDate lt '2021-06-03' and submittedDate gt '2021-05-24')

As another example, to find jobs not in COMPLETED OR CANCELED status and with dueDate before noon, June 21,

(statusCode ne 'CREATED' AND statusCode ne 'COMPLETED') and (dueDate lt '2021-06-21T12:00')

The following job fields are not supported on the filter and orderBy parameters,

description
latestErrorMessage
archived
extendedMetadata
requestStats

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Fetchtype

Specifies what level of detail is returned for a job. The default is full if not specified. Note: FullWithStats is an experimental feature that is not yet supported.

Next

The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.

Fields

Comma-separated list of field names to include in response (e.g., "name,status,id"). JobId is always included in the response. If omitted then all the fields are included by default. Valid values are: activityDate, aggregateRequests, archiveStatus, archived, connectorName, connectorVersion, createdDate, creatorId, customData, description, dueDate, estimatedArchivalDate, extendedMetadata, globalTrackingId, hasError, jobName, labels, latestErrorMessage, modifiedDate, poReference, providerId, providerReference, requestStats, serviceType, shouldQuote, siteId, statusCode, submittedDate, submitterId

Filter

The filter parameter can be used to filter a collection of resources based on field values. Only items where the expression evaluates
to true are included in the query results. To reference a key within a Label, use dot notation, e.g. labels.env

The following operations are supported:

Operator	Description	Example
Comparison Operators
eq	Equal	hasError eq true
ne	Not equal	statusCode ne 'CREATED'
gt	Greater than	labels.pages gt 20
ge	Greater than or equal	labels.pages ge 10
lt	Less than	labels.pages lt 20
le	Less than or equal	labels.pages le 100
Logical Operators
and	Logical and	labels.pages le 200 and labels.pages gt 3.5
or	Logical or	labels.pages le 3.5 or labels.pages gt 200
not	Logical negation	not labels.pages le 3.5
Grouping Operators
( )	Precedence grouping	(labels.priority eq 1 or labels.env eq 'prod') and labels.pages gt 100

See method description for additional restrictions on fields.

Orderby

The orderBy parameter can be used to sort the results of a collection query based on field values. At most 1 field name can be specified. The parameter value may include the suffix "asc" for ascending or "desc" for descending, separated from the field name by space. If not included, "asc" is used by default. The parameter must be consistent across pagination. See method description for additional restrictions on fields.

Response Type

N/A

/jobs/{jobId}/submit

Submit job to provider, when all translation requests have been added.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (1)

Option Name	Description
`Providerid`	Unique identifier representing a provider.

/jobs/{jobId}/intranslation

Set job status to IN_TRANSLATION. Allows further translations from being imported again. Only valid when job is currently COMPLETED.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/jobs/{jobId}

Update a job's information. Only jobs that have not been submitted can be updated.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job being updated.
`Response Type`	N/A

Options (11)

Option Name	Description
`Jobname`	The name of the translation job.
`Description`	A description of the translation job.
`Poreference`	PO Reference of the translation job.
`Duedate`	Due date of the translation job. Expected format is defined by full-date ("yyyy-MM-dd") or date-time (e.g. "yyyy-MM-ddTHH:mm:ssZ") in RFC3339
`Customdata`	Deprecated. Please see extendedMetadata. User specified custom data.
`Shouldquote`	Request a quote for the job before translation proceeds. TODO - describe how quoting happens outside of REST API.
`Providerid`	The ID of the provider the job will be sent to. Requests under the job will be validated as they are created, prior to submission, if provider capabilities are defined. For more information, please refer to the Provider resource.
`Connectorname`	The official/descriptive name of the connector that is sending the job. If required, for connector certification, please contact Lionbridge connector support.
`Connectorversion`	The version number of the connector that is sending the job.
`Servicetype`	The type of service or workflow requested for the job.
`Aggregaterequests`	Not Yet Implemented. Optional parameter to control how many requests with inline source content gets aggregated into one asset when submitting a job. In most cases, leave it unspecified.

/jobs/{jobId}

Please use PATCH /jobs/{jobId} instead.

Update a job's information. Only jobs that have not been submitted can
be updated.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job being updated.
`Response Type`	N/A

Options (10)

Option Name	Description
`Jobname`	The name of the translation job.
`Description`	A description of the translation job.
`Poreference`	PO Reference of the translation job.
`Duedate`	Due date of the translation job. Expected format is defined by full-date ("yyyy-MM-dd") or date-time (e.g. "yyyy-MM-ddTHH:mm:ssZ") in RFC3339
`Customdata`	Deprecated. Please see extendedMetadata. User specified custom data.
`Shouldquote`	Request a quote for the job before translation proceeds. TODO - describe how quoting happens outside of REST API.
`Providerid`	The ID of the provider the job will be sent to. Requests under the job will be validated as they are created, prior to submission, if provider capabilities are defined. For more information, please refer to the Provider resource.
`Connectorname`	The official/descriptive name of the connector that is sending the job. If required, for connector certification, please contact Lionbridge connector support.
`Connectorversion`	The version number of the connector that is sending the job.
`Servicetype`	The type of service or workflow requested for the job.

/statusupdates/listeners

Creates a listener for job or request event callbacks. User can specify the status(es) for triggering callbacks, and the URI for receiving HTTP requests from the API. Only 1 listener of each type is allowed. On successful creation, a secret is returned in the response. This can be used to verify the callback. For more information, please see the callback definitions for details.

The user-specified endpoint is expected to return 200 on success. If the callback delivery fails, the API retries
for up to 24 hours with an exponential backoff.

If callback retries exceed 24 hours and still cannot get successful response, callback retry will be stopped, and the listener will be marked as permanent probation. Under permanent probation, no further callbacks will be generated.
User can PATCH the existing listener with repaired endpoint address to reset the listener.

The recommended approach for integration is to always accept the callback upon receipt. A typical approach would be to:

1. Accept the payload and immediately return HTTP 200 OK, then
2. Perform business logic as necessary,
3. Or discard the event.

The endpoint may receive many requests depending on activities on the API. Consider separating the event ingestion in Step 1 and asynchronosly perform business logic in Step 2.

Due to the nature of webhook delivery, events are not guaranteed to be in order.
For example, a job was first set to COMPLETE status and subsequently archived.
Suppose the endpoint was not available when the COMPLETE webhook was sent, but recovered when the job was archived.
The archived webhook would arrived first, then later the COMPLETE webhook on the next retry.
Ensure the integration can handle out-of-order events gracefully.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Uri`	The URI that Lionbridge POSTs to once a specific event has fired. Only HTTPS is supported.
`Type`	The type of listener. JOB_STATUS_UPDATE will send events only about the job as a whole. REQUEST_STATUS_UPDATE will send events on request changes within the job.
`Statuscodes`	Status codes that result in a listener event.
`Authtype`	Authentication type for listener. LB_CONTENTAPI_SIGNATURE: HMAC signature in header
`Acknowledgestatusupdate`	Optional parameter to indicate if the corresponding StatusUpdate should be acknowledged automatically. Defaults to true if not specified. When set to false, the client is expected to acknowledge the StatusUpdate manually, to avoid running into quota limitation. For more information, please refer to the StatusUpdate resource.

/statusupdates/listeners/{listenerId}

Delete a Listener.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	The ID of the specified Listener.
`Response Type`	N/A

/statusupdates/listeners/{listenerId}/invocations/pending

List failed payloads that are currently being retried

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	The ID of the Listener.
`Earliest`	query the payloads after it. If not specified, only failures within the last 24 hours are returned.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/statusupdates/listeners/{listenerId}/invocations/failed

List failed payloads that are considered in error and not being retried

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	The ID of the Listener.
`Earliest`	query the payloads after it. If not specified, only failures within the last 24 hours are returned.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/statusupdates/listeners/{listenerId}

Modify attributes of an existing listener.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	The ID of the Listener being queried.
`Response Type`	N/A

Options (3)

Option Name	Description
`Uri`	The URI that Lionbridge POSTs to once a specific event has fired. Only HTTPS is supported.
`Statuscodes`	Status codes that result in a listener event.
`Acknowledgestatusupdate`	Optional parameter to indicate if the corresponding StatusUpdate should be acknowledged automatically. When set to false, the client is expected to acknowledge the StatusUpdate manually, to avoid running into quota limitation. For more information, please refer to the StatusUpdate resource.

/statusupdates/listeners

The Listeners endpoint returns information about the Listeners. The response includes listener IDs and detailed information of all listeners for the given user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/statusupdates/listeners/{listenerId}

Returns the listener specified by listenerId.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	The ID of the Listener being queried.
`Response Type`	N/A

/jobs/{jobId}/requests/updatecontent

This operation replaces existing source content reference on the specified translation requests.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (2)

Option Name	Description
`Sourcecontentid`	Id of source content.
`Requestids`	ID of translation request that will be retrieved. If none specified then all requests in jobId will be used.

/providers/{providerId}

Get a translation provider.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Providerid`	The ID of the translation provider.
`Response Type`	N/A

/providers

Get all configured translation providers.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Includedeletedones`	The default value is false, list Providers without deleted ones
`Response Type`	N/A

/quota

get the current quota.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/jobs/{jobId}/requests/approve

Approve translated content of specified request(s).

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (1)

Option Name	Description
`Requestids`	ID of translation request that will be retrieved.

/jobs/{jobId}/requests/addfile

Adds translation requests to a job based on a source file. If a fileId is specified, the file must be fully uploaded when this method invoked.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Response Type`	N/A

Options (7)

Option Name	Description
`Requestname`	Name of the translation request.
`Sourcenativeid`	Source ID of the request in the content system. This is intended to be used for accessing the objects within the CMS. What to actually store here is arbitrary; it serves as a locator for read/write by the API consumer. For example, in a file-based connector, the sourceNativeId can be a file path /foo/bar/catalog/laptop/en/dell/inspiron/17/5000/features.txt, and the targetNativeId as /foo/bar/catalog/laptop/fr/dell/inspiron/17/5000/features.txt. Then when the translated content is received, the targetNativeId can be used, to open the target file for writing back translations directly.
`Sourcenativelanguagecode`	Source language code of the request in the content system.
`Targetnativeids`	Target IDs of the requests in content system. Also see description of sourceNativeId.
`Targetnativelanguagecodes`	Target languages of requests for translation.
`Wordcount`	Word count in translation request. If provided, the value will be available when querying the request.
`Fmsfileid`	ID of source file

/jobs/{jobId}/requests/add

Create new translation requests in a job referencing a source file, or inline source content.
If a fileId is specified, the file must be fully uploaded when this method invoked. At most one of fileId
or sourcecontentId can be included. See FileTransfer and
TranslationContent for more information on fileId and sourcecontentId respectively.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (8)

Option Name	Description
`Sourcecontentid`	Id of source content.
`Requestname`	Name of the translation request.
`Sourcenativeid`	Source ID of the request in the content system. This is intended to be used for accessing the objects within the CMS. What to actually store here is arbitrary; it serves as a locator for read/write by the API consumer. For example, in a file-based connector, the sourceNativeId can be a file path /foo/bar/catalog/laptop/en/dell/inspiron/17/5000/features.txt, and the targetNativeId as /foo/bar/catalog/laptop/fr/dell/inspiron/17/5000/features.txt. Then when the translated content is received, the targetNativeId can be used, to open the target file for writing back translations directly.
`Sourcenativelanguagecode`	Source language code of the request in the content system.
`Targetnativeids`	Target IDs of the requests in content system. Also see description of sourceNativeId.
`Targetnativelanguagecodes`	Target languages of requests for translation.
`Wordcount`	Word count in translation request. If provided, the value will be available when querying the request.
`Fmsfileid`	ID of source file

/jobs/{jobId}/requests/{requestId}

Delete the translation request in a job identified by requestId

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Requestid`	The ID of the translation request.
`Response Type`	N/A

/jobs/{jobId}/requests

Get all translation requests in a job. The items are ordered by creation time, in reverse.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Status`	Get translation requests in a job with matching statusCode.
`Id`	Get specified translation requests in a job. Maximum of 50 items allowed per invocation. Bypass paging parameters when specified.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/jobs/{jobId}/requests/{requestId}

Get the translation request in a job identified by requestId.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Requestid`	The ID of the translation request.
`Response Type`	N/A

/jobs/{jobId}/requests/reject

Reject translated content of specified request(s). This method is used to support the process of reviewing translated content and communicating client feedback to translation provider. Once rejected, the provider may then send updated content based on client comments. Note that not all translation providers support rejection. Clients should discuss with translation provider on how rejections should be handled in advance.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (2)

Option Name	Description
`Requestids`	ID of translation request that will be retrieved.
`Note`	Note which explains the reason(s) for rejection.

/jobs/{jobId}/requests/updatefilecontent

Associates a file as the source content to existing translation requests. File must be fully uploaded when this method is invoked.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Response Type`	N/A

Options (2)

Option Name	Description
`Requestids`	ID of translation request that will be updated. If none specified then all requests in jobId will be used.
`Fmsfileid`	ID of source file

/jobs/{jobId}/requests/{requestId}

Update the translation request in a job identified by requestId. At most one of fileId or sourcecontentId can be included.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Requestid`	The ID of the translation request.
`Response Type`	N/A

Options (7)

Option Name	Description
`Requestname`	Name of the translation request.
`Sourcenativeid`	Source ID of the request in the content system. This is intended to be used for accessing the objects within the CMS. What to actually store here is arbitrary; it serves as a locator for read/write by the API consumer. For example, in a file-based connector, the sourceNativeId can be a file path /foo/bar/catalog/laptop/en/dell/inspiron/17/5000/features.txt, and the targetNativeId as /foo/bar/catalog/laptop/fr/dell/inspiron/17/5000/features.txt. Then when the translated content is received, the targetNativeId can be used, to open the target file for writing back translations directly.
`Sourcenativelanguagecode`	Source language code of the request in the content system.
`Fileid`	Id of source file.
`Sourcecontentid`	Id of source content.
`Targetnativeid`	Target ID of the request in the content system.
`Targetnativelanguagecode`	Target language code of the request in the content system.

/jobs/{jobId}/requests

Update the translation requests in a job identified by requestIds. At most one of fileId or sourcecontentId can be included.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Id`	Patch specified translation requests in a job. Maximum of 50 items allowed per invocation.
`Response Type`	N/A

Options (7)

Option Name	Description
`Requestname`	Name of the translation request.
`Sourcenativeid`	Source ID of the request in the content system. This is intended to be used for accessing the objects within the CMS. What to actually store here is arbitrary; it serves as a locator for read/write by the API consumer. For example, in a file-based connector, the sourceNativeId can be a file path /foo/bar/catalog/laptop/en/dell/inspiron/17/5000/features.txt, and the targetNativeId as /foo/bar/catalog/laptop/fr/dell/inspiron/17/5000/features.txt. Then when the translated content is received, the targetNativeId can be used, to open the target file for writing back translations directly.
`Sourcenativelanguagecode`	Source language code of the request in the content system.
`Fileid`	Id of source file.
`Sourcecontentid`	Id of source content.
`Targetnativeid`	Target ID of the request in the content system.
`Targetnativelanguagecode`	Target language code of the request in the content system.

/statusupdates/{updateId}/acknowledge

Acknowledges a status update, which results in specified ID no longer appearing in future /statusupdates request.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Updateid`	The ID of the status update being acknowledged.
`Response Type`	N/A

/providers/{providerId}/statusupdates

Get all unacknowledged status updates for this provider. This can be used in specific circumstances, for example, when the API credential is being used in multiple connector instances, each with a different provider.
For most use cases, the generic GET /statusupdates method is sufficient and is simpler to use.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Providerid`	The ID of the specified provider.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/jobs/{jobId}/statusupdates

Get all unacknowledged status updates for this job.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/statusupdates

Get all unacknowledged status updates. The items are ordered by update time, in reverse.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/jobs/{jobId}/supportassets

Add a support asset to a job based on a file

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (5)

Option Name	Description
`Fmsfileid`	FMS fileId of source file to use as this support asset.
`Description`	An optional description of this support asset.
`Sourcenativeids`	Optional source native id's associated with this support asset. This field is for informational purpose only, and is not validated by the API. See Request's sourceNativeId for a detailed description.
`Sourcenativelanguagecode`	Optional source language code associated with this support asset. This field is for informational purpose only, and is not validated by the API.
`Targetnativelanguagecodes`	Optional list of target languages of support asset associated with this support asset. This field is for informational purpose only, and is not validated by the API.

/jobs/{jobId}/supportassets/{supportassetId}

Delete the support asset in a job identified by supportassetId

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Supportassetid`	The ID of the support asset.
`Response Type`	N/A

/jobs/{jobId}/supportassets

Get all support assets in a job. The items are ordered by creation time, in reverse.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/jobs/{jobId}/supportassets/{supportassetId}

Get the support asset in a job identified by supportassetId.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Supportassetid`	The ID of the support asset.
`Response Type`	N/A

/jobs/{jobId}/sourcecontent

Create source content so it can be referenced for creating a translation request. The total length of all field names, values, and comments should not exceed 1 Mb.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Response Type`	N/A

Options (1)

Option Name	Description
`Fields`	N/A

/jobs/{jobId}/sourcecontent/{sourcecontentId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Sourcecontentid`	The ID of the translation source content.
`Response Type`	N/A

/jobs/{jobId}/sourcecontent/{sourcecontentId}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the specified job.
`Sourcecontentid`	The ID of the translation source content.
`Response Type`	N/A

Options (1)

Option Name	Description
`Fields`	N/A

/jobs/{jobId}/requests/{requestId}/retrieve

Retrieve the target content for translation request(s).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	The ID of the job.
`Requestid`	The ID of the translation request.
`Response Type`	N/A

/jobs/{jobId}/tmupdates

Associates a file as the source content to existing translation memory of a job.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Response Type`	N/A

Options (3)

Option Name	Description
`Fmsfileid`	FMS fileId of file containing updated content to use in this UpdateTM.
`Sourcenativelanguagecode`	Source language code of the update in the content system.
`Targetnativelanguagecode`	Target language code of the update in the content system.

/jobs/{jobId}/tmupdates/{tmupdateId}

Returns translation memory data.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Tmupdateid`	TMUpdate ID.
`Response Type`	N/A

/jobs/{jobId}/tmupdates

Returns translation memories data.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobid`	Job ID.
`Next`	The next parameter can be used as a cursor to navigate to the next page when retrieving a list of items. The value is returned as part of a collection response. One can also follow _links.next.href in the response directly.
`Response Type`	N/A

/statusupdates/listeners/{listenerId}/invocations/{invocationId}/retry

Retry a failed invocation

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	ID of listener
`Invocationid`	ID of invocation
`Response Type`	N/A

/statusupdates/listeners/{listenerId}/retry

Retry a list of failed invocations

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Listenerid`	ID of listener
`Response Type`	N/A

Options (1)

Option Name	Description
`Invocationids`	N/A

Archive (2)

FileTransfer (3)

Job (10)

Listener (7)

NotYetImplemented

Provider (2)

Quota

Request (10)

StatusUpdate (4)

SupportAsset (4)

TranslationContent (4)

TranslationMemory (3)

Webhook (2)