Get the Details of the Translation File for a Translation Job
/sites/management/api/v1/sites/_status/{id}/translationFile
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.
- For more information, see Get the Progress of a Site Related Job
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 Name | Description |
jobStatus | Site 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
-
id: string
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.
-
excludeFields(optional): string
Comma-delimited string of field names that should not be included in the response.
-
excludeLinks(optional): string
Comma-separated list of link relation names to exclude from the response.
-
fields(optional): string
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.
-
links(optional): string
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 Relationship Description parent
Describes 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.self
Describes 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. canonical
Describes 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. describedBy
Describes 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. download
Download links are returned in file resources. The download link can be used to stream the file data. -
return(optional): string
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
andexpand
query parameters.The following representations are supported with the
return
query parameter:Representation Description representation
Full resource representation includes all properties and links and expands most relationships. default
Default resource representation includes most properties and links. basic
Basic resource representation includes some properties and some links. minimal
Minimal resource representation, includes essential properties and no links.
Response
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
allOf
DocumentFile
Information about a file in Documents.
Introduced in release 19.4.3.
Information about a file in Documents.
Introduced in release 19.4.3.-
object
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.
-
object
DocumentFile-allOf[1]
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.
-
links(optional):
array links
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
-
conversationID(optional):
string
Conversation ID associated with this file or a parent folder..
Introduced in release 19.4.3. -
createdBy(optional):
createdBy
User that created the file.
Introduced in release 19.4.3. -
createdTime(optional):
string(date-time)
File created time. Date and time values are in ISO 8601
Introduced in release 19.4.3.yyyy-MM-dd'T'HH:mm:ss'Z'
format using a UTC timezone. -
description(optional):
string
File description
Introduced in release 19.4.3. -
id(optional):
string
Unique identifier for the file.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
Introduced in release 19.4.3. -
isConversationInherited(optional):
boolean
Indicates whether conversation ID is associated with current file (false) or if conversation ID is associated with a parent folder (true).
Introduced in release 19.4.3. -
mimetype(optional):
string
Mimetype of file.
Introduced in release 19.4.3. -
modifiedBy(optional):
modifiedBy
User that last modified the file.
Introduced in release 19.4.3. -
modifiedTime(optional):
string(date-time)
File created time. Date and time values are in ISO 8601
Introduced in release 19.4.3.yyyy-MM-dd'T'HH:mm:ss'Z'
format using a UTC timezone. -
name(optional):
string
Filename.
Introduced in release 19.4.3. -
ownedBy(optional):
ownedBy
User that owns the file.
Introduced in release 19.4.3. -
parentID(optional):
string
Mimetype of file.
Introduced in release 19.4.3. -
reservationDate(optional):
string(date-time)
File reservation time. Date and time values are in ISO 8601
Introduced in release 19.4.3.yyyy-MM-dd'T'HH:mm:ss'Z'
format using a UTC timezone. -
reservedBy(optional):
reservedBy
User that has the file reserved.
Introduced in release 19.4.3. -
size(optional):
string
File size in bytes.
Introduced in release 19.4.3. -
type(optional):
string
Resource type. Has value 'file'.
Introduced in release 19.4.3. -
version(optional):
string
File version.
Introduced in release 19.4.3.
array
HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
User that created the file.
Introduced in release 19.4.3.-
allOf
DocumentUser
Information about a user for a file or folder.
Introduced in release 19.4.3.
User that last modified the file.
Introduced in release 19.4.3.-
allOf
DocumentUser
Information about a user for a file or folder.
Introduced in release 19.4.3.
User that owns the file.
Introduced in release 19.4.3.-
allOf
DocumentUser
Information about a user for a file or folder.
Introduced in release 19.4.3.
User that has the file reserved.
Introduced in release 19.4.3.-
allOf
DocumentUser
Information about a user for a file or folder.
Introduced in release 19.4.3.
Information about a user for a file or folder.
Introduced in release 19.4.3.-
object
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.
-
object
DocumentUser-allOf[1]
object
-
displayName(optional):
string
User display name.
Introduced in release 19.4.3. -
id(optional):
string
Unique identifer for the user.
Introduced in release 19.4.3. -
loginName(optional):
string
User login name.
Introduced in release 19.4.3. -
type(optional):
string
Resource type. Has value 'user'.
Introduced in release 19.4.3.
{
"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
401 Response
403 Response
404 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
object
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.
-
object
SiteJobNotFoundExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
jobStatus(optional):
string
Site job status that does not exist or is not visible to the authenticated user.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"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"
}
}
{
"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"
}