Get the Localization Policy for the Target Site
/sites/management/api/v1/requests/{id}/localizationPolicy
The localization policy that will be associated with the site when it is created. Localization policies can be set only for enterprise sites. A localization policy cannot be associated with a request if the policy associated with the request specifies a localization policy.
Introduced in release 19.2.3.
Authorization
To access this relationship requires read access to the parent resource.
- For more information, see Get a Request
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
Request
GET https://api.example.com/sites/management/api/v1/requests/{id}/localizationPolicy
Response Body
{ "id": "7D77CB6653BC1FF8E0530100007F6630", "name": "English and French", "description": "This localization policy allows US English and French only.", "createdBy": "jsmith", "createdDate": { "value": "2019-06-01T06:44:17.000Z", "timezone": "GMT" }, "updatedBy": "jsmith", "updatedDate": { "value": "2019-06-01T06:44:17.000Z", "timezone": "GMT" }, "defaultValue": "en-US", "requiredValues": [ "en-US" ], "optionalValues": [ "en-US" ] }
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 - Request Not Found
The request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.
Error Code
OCE-SITEMGMT-009001
Resolution - Check Identifier
Check that the request identifier is valid.
Resolution - Check Authorization
Check that the authenticated user can review the request or that the authenticated user is the user that created the request.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
request | Request that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the RequestNotFoundExceptionDetail 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": "Request Not Found", "status": "404", "detail": "Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.", "o:errorCode": "OCE-SITEMGMT-009001", "request": { "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7" } }
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 Request and Localization Policy resource. If there is no Localization Policy associated with the Request then the response status code will be 204 No Content. If the Localization Policy 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
Globally unique immutable identifier for a request.
-
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.
-
includeDeleted(optional): boolean
Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to
true
. When theincludeDeleted
query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted. -
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. -
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.
-
ETag: string
Opaque identifier assigned by the origin server to a specific version of a resource.
-
allOf
LocalizationPolicy
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
Localization policies are the translation rules applied to any text assets in a repository. These policies do not apply to digital assets such as images. That content is classified as non-translatable when it is uploaded. But content items can have multiple translated versions associated with the original item, which is considered the master copy.
When an item is localized, a copy of the item is made for the language. For example, there may be a blog post about the newest Android tablet that is translated into French and Spanish with the master copy in English. Each version of the blog post exists as a separate entity. It can be edited as needed and can be at a different stage of asset life cycle than the others. The French version could be in review, while the Spanish version could be published. There may be two or three content versions of the post, each of which can be translated and have a different status applied to it.
-
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
LocalizationPolicy-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
-
createdBy(optional):
string
User that created the policy.
-
createdDate(optional):
createdDate
Date and time the policy was created.
-
defaultValue(optional):
string
Fall back language in case if item of the given language not available. The default value will be one of the required languages.
-
description(optional):
string
Human-readable description of the repository to give consumers an idea of what content this localization policy is for.
-
id(optional):
string
Unique identifer for the localization policy.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
name(optional):
string
Short human-readable name to identify the localization policy.
-
optionalValues(optional):
array optionalValues
Optional language values.
-
requiredValues(optional):
array requiredValues
Required language values.
-
updatedBy(optional):
string
User that last updated the policy. If the policy has not been updated the updated by will be the user that created the policy.
-
updatedDate(optional):
updatedDate
Date and time the policy was last updated.
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.
Date and time the policy was created.
-
object
DateTimeZone
Date, time and time zone.
Date and time the policy was last updated.
-
object
DateTimeZone
Date, time and time zone.
object
Date, time and time zone.
-
description(optional):
string
Description of the date, time and time zone information.
-
timezone(optional):
string
Timezone in Olson database format.
-
value(optional):
string(date-time)
Date in ISO 8601 format. Date and time values are in ISO 8601
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
{
"id":"7D77CB6653BC1FF8E0530100007F6630",
"name":"English and French",
"description":"This localization policy allows US English and French only.",
"createdBy":"jsmith",
"createdDate":{
"value":"2019-06-01T06:44:17.000Z",
"timezone":"GMT"
},
"updatedBy":"jsmith",
"updatedDate":{
"value":"2019-06-01T06:44:17.000Z",
"timezone":"GMT"
},
"defaultValue":"en-US",
"requiredValues":[
"en-US"
],
"optionalValues":[
"en-US"
]
}
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
RequestNotFoundExceptionDetail-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
-
request(optional):
string
Request 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":"Request Not Found",
"status":"404",
"detail":"Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
"o:errorCode":"OCE-SITEMGMT-009001",
"request":{
"id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
}
}
{
"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"
}