1. REST API for Sites Management
  2. Tasks
  3. Sites
  4. Jobs

Get the Details of the Translation File for a Translation Job

get

/sites/management/api/v1/sites/_status/{id}/translationFile

RELATION

Details of the translation file that was created when translating a site. The translation file is a zip file that contains the translatable content and assets of the site. The response will contain a download link that can be used to stream the file data.

Introduced in release 19.4.3.

Authorization

To access this relationship requires read access to the parent resource.

Importing Translations

To import translations, first download the file. Then add translations to the ZIP file and upload the file to a personal folder. The translations can then be imported.

For more information, see Import Site Translations.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK - Get the Details of the Translation Zip File

Read the details about the translation zip file that was created as part of a translate site job, specifying that the download link should be included so that the file can be downloaded.

Request

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}/translationFile?links=download

Response Body

{
  "links": [
      {
        "rel": "download",
        "href": "http://acmecorp.com/documents/api/1.2/files/D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015/data",
        "templated": false,
        "mediaType": "application/json",
        "method": "GET"
      }
  ],
  "id": "D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015",
  "name": "AcmeProductLaunch.zip",
  "type": "file",
  "version": "1",
  "size": "12646",
  "parentID": "TRANSLATIONJOBSF29E5445DC86366110B7BA737771948CD1C2E31858AE",
  "createdTime": "2020-01-13T14:57:44Z",
  "createdBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "cecsadmina",
    "loginName": "swebcli.cecsadmina",
    "type": "user"
  },
  "modifiedTime": "2020-01-13T14:57:44Z",
  "modifiedBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "cecsadmina",
    "loginName": "swebcli.cecsadmina",
    "type": "user"
  },
  "ownedBy": {
    "id": "docadmin",
    "displayName": "Oracle Documents Administrator",
    "loginName": "docadmin",
    "type": "user"
  }
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Site Job Not Found

The site job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.

Error Code

OCE-SITEMGMT-009024

Resolution - Check Identifier

Check that the site job identifier is valid.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
jobStatusSite job status that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the SiteJobNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Job Not Found",
  "status": "404",
  "detail": "Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
  "o:errorCode": "OCE-SITEMGMT-009024",
  "jobStatus": {
    "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423"
  }
}

404Not Found - Relationship Not Found

An attempt to read a relationship has failed because the relationship does not exist. Reading a relationship can fail if the relationship no longer exists or the authenticated identity is not authorized to read the relationship details.

Error Code

PAAS-005027

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

This resource represents the relationship between a Site Job Status and Document File resource. If there is no Document File associated with the Site Job Status then the response status code will be 204 No Content. If the Document File has been deleted or the authenticated user is not authorized to read the resource then the response status code will be 404 Not Found and a Relationship Not Found error will be returned in the response body.

Request

Path Parameters

  • Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.

Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.
    downloadDownload links are returned in file resources. The download link can be used to stream the file data.

  • Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : DocumentFile

Information about a file in Documents.

Introduced in release 19.4.3.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • DocumentFile-allOf[1]
Nested Schema : SingularResource
Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source
  • links
Nested Schema : DocumentFile-allOf[1]
Type: object
Show Source
Nested Schema : createdBy

User that created the file.

Introduced in release 19.4.3.
Match All
Show Source
  • DocumentUser

    Information about a user for a file or folder.

    Introduced in release 19.4.3.
Nested Schema : modifiedBy

User that last modified the file.

Introduced in release 19.4.3.
Match All
Show Source
  • DocumentUser

    Information about a user for a file or folder.

    Introduced in release 19.4.3.
Nested Schema : ownedBy

User that owns the file.

Introduced in release 19.4.3.
Match All
Show Source
  • DocumentUser

    Information about a user for a file or folder.

    Introduced in release 19.4.3.
Nested Schema : reservedBy

User that has the file reserved.

Introduced in release 19.4.3.
Match All
Show Source
  • DocumentUser

    Information about a user for a file or folder.

    Introduced in release 19.4.3.
Nested Schema : DocumentUser

Information about a user for a file or folder.

Introduced in release 19.4.3.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • DocumentUser-allOf[1]
Nested Schema : DocumentUser-allOf[1]
Type: object
Show Source
Example Response (Get the Details of the Translation Zip File)
{
    "links":[
        {
            "rel":"download",
            "href":"http://acmecorp.com/documents/api/1.2/files/D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015/data",
            "templated":false,
            "mediaType":"application/json",
            "method":"GET"
        }
    ],
    "id":"D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015",
    "name":"AcmeProductLaunch.zip",
    "type":"file",
    "version":"1",
    "size":"12646",
    "parentID":"TRANSLATIONJOBSF29E5445DC86366110B7BA737771948CD1C2E31858AE",
    "createdTime":"2020-01-13T14:57:44Z",
    "createdBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"cecsadmina",
        "loginName":"swebcli.cecsadmina",
        "type":"user"
    },
    "modifiedTime":"2020-01-13T14:57:44Z",
    "modifiedBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"cecsadmina",
        "loginName":"swebcli.cecsadmina",
        "type":"user"
    },
    "ownedBy":{
        "id":"docadmin",
        "displayName":"Oracle Documents Administrator",
        "loginName":"docadmin",
        "type":"user"
    }
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteJobNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteJobNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Site Job Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Job Not Found",
    "status":"404",
    "detail":"Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
    "o:errorCode":"OCE-SITEMGMT-009024",
    "jobStatus":{
        "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423"
    }
}
Example Response (Relationship Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top