ONonshape
Translation

Get information on an in-progress or completed translation by translation ID.

When the translation is complete, requestState changes from ACTIVE to DONE or FAILED. See API Guide: Model Translation for more details.

When polling for translations to complete, use a reasonable interval (e.g., avoid polling multiple times a second, use an exponential backoff strategy, etc.) or use Webhooks. See Rate Limiting and API Limits for more information.

get/translations/{tid}

Request

Path parameters

tidstring required

Response

default response

correlationIdstring

User specified identifier that can be used as a correlation id across api calls.

documentIdstring
exportRuleFileNamestring

The file name after evaluating a rule for the given formatName. NULL if evaluateExportRule=false or if the export rule is not found.

failureReasonstring
hrefstring uri

URI to fetch complete information of the resource.

idstring

Id of the resource.

namestring

Name of the resource.

requestElementIdstring
requestState'ACTIVE' | 'DONE' | 'FAILED'
resultDocumentIdstring
resultElementIdsstring[]
resultExternalDataIdsstring[]
resultWorkspaceIdstring
versionIdstring
viewRefstring uri

URI to visualize the resource in a webclient if applicable.

workspaceIdstring

Changes

No recorded changes to this operation across all 13 revisions of this API.