Jump to

• Request
• Response
• Examples

Create a Localization Policy

post

/content/management/api/v1.1/localizationPolicies

Creates a localization policy with the given payload.
The created localization policy will ensure

to deliver the item having the exact requested language, if published

to deliver the item in defined default language, if published

to deliver the item, if published, which referred to the unavailable translation.

It will also ensure

that a translation for every language specified in LocalizationPolicy.requiredValues must be published with a translation set

that any translation with a language specified in the LocalizationPolicy.optionalValues may be published with a translation set.

Request

Supported Media Types

• application/json

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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Creates a localization policy with the given information in the payload. The fields id, createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the localization policy. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the localization policy."
        },
        "createdBy":{
            "type":"string",
            "description":"created by user of the localization policy."
        },
        "createdDate":{
            "description":"date and time Localization Policy createdAt",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updated by user of the Localization Policy"
        },
        "updatedDate":{
            "description":"date and time Localization Policy updatedAt",
            "$ref":"#/definitions/date"
        },
        "defaultValue":{
            "type":"string",
            "description":"Fall back language in case if item of the given language not available. Value should be one of the required languages."
        },
        "requiredValues":{
            "type":"array",
            "description":"Required language values.",
            "items":{
                "type":"string"
            }
        },
        "optionalValues":{
            "type":"array",
            "description":"Optional language values.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the Localization Policy resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Localization Policy"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : links

Type: array

Links of the Localization Policy resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the Localization Policy resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : optionalValues

Type: array

Optional language values.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional language values.",
    "items":{
        "type":"string"
    }
}

Nested Schema : requiredValues

Type: array

Required language values.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Required language values.",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the localization policy. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the localization policy."
        },
        "createdBy":{
            "type":"string",
            "description":"created by user of the localization policy."
        },
        "createdDate":{
            "description":"date and time Localization Policy createdAt",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updated by user of the Localization Policy"
        },
        "updatedDate":{
            "description":"date and time Localization Policy updatedAt",
            "$ref":"#/definitions/date"
        },
        "defaultValue":{
            "type":"string",
            "description":"Fall back language in case if item of the given language not available. Value should be one of the required languages."
        },
        "requiredValues":{
            "type":"array",
            "description":"Required language values.",
            "items":{
                "type":"string"
            }
        },
        "optionalValues":{
            "type":"array",
            "description":"Optional language values.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the Localization Policy resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Localization Policy"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : links

Type: array

Links of the Localization Policy resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the Localization Policy resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : optionalValues

Type: array

Optional language values.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional language values.",
    "items":{
        "type":"string"
    }
}

Nested Schema : requiredValues

Type: array

Required language values.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Required language values.",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to create a localization policy by submitting a POST request on the REST resource using cURL.

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'http://host:port/content/management/api/v1.1/policy'

Example:

This creates a localization policy with a list of required and a list of optional languages, where en-IN, en-AU and en-US are language codes. Replace payload with your own data.

/content/management/api/v1.1/localizationPolicies

Request Body

{
  "name": "policy4",
  "description": "policy4 description",
  "requiredValues": [
    "en-AU",
    "en-US"
  ],
  "optionalValues": [
    "en-IN",
    "en-US"
  ]
}

Back to Top