Read a Localization Policy
get
/content/management/api/v1.1/localizationPolicies/{id}
Read a localization policy.
Request
Path Parameters
-
id: string
Localization Policy id
Query Parameters
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : LocalizationPolicy
Type:
object
Localization Policy
Show Source
-
createdBy(optional):
string
created by user of the localization policy.
-
createdDate(optional):
object date
date
-
defaultValue(optional):
string
Fall back language in case if item of the given language not available. Value should be one of the required languages.
-
description(optional):
string
Description of the localization policy.
-
id(optional):
string
id of the localization policy. It is a required property in the get response and put request whereas it is not required in the post request.
-
links(optional):
array links
Links of the Localization Policy resource
-
name(optional):
string
Name of the localization policy. It is a required property in the get response and post/put request.
-
optionalValues(optional):
array optionalValues
Optional language values.
-
requiredValues(optional):
array requiredValues
Required language values.
-
updatedBy(optional):
string
updated by user of the Localization Policy
-
updatedDate(optional):
object date
date
Nested Schema : links
Type:
array
Links of the Localization Policy resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to get localization policy details by submission of a GET request on the REST resource using cURL:
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/localizationPolicies/{id}'
Example:
This reads a localization policy with id: 7BE0595E225430CCE0534DB0F70AB94C.
/content/management/api/v1.1/localizationPolicies/7BE0595E225430CCE0534DB0F70AB94C
Response Body
{ "id": "7BE0595E225430CCE0534DB0F70AB94C", "name": "policyName", "description": "policy description", "createdBy": "marketing.user", "createdDate": { "value": "2018-11-30T10:49:49.818Z", "timezone": "UTC" }, "updatedBy": "marketing.user", "updatedDate": { "value": "2018-11-30T10:47:59.522Z", "timezone": "UTC" }, "defaultValue": "en", "requiredValues": [ "en-AU", "en-US", "de" ], "optionalValues": [ "en-IN", "en-US", "en-AU" ], "links": [ { "href": "https://host:port/content/management/api/v1.1/localizationPolicies/7BE0595E225430CCE0534DB0F70AB94C", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://host:port/content/management/api/v1.1/localizationPolicies/7BE0595E225430CCE0534DB0F70AB94C", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://host:port/content/management/api/v1.1/metadata-catalog/localizationPolicies/7BE0595E225430CCE0534DB0F70AB94C", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }