Jump to

• Request
• Response

Get the default repository's preferred locale

get

/repositories/default/defaultPreferredLocale

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : LocaleKeyBO

Type: object

Documentation for BO mode: LocaleKeyBO:

Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

Show Source

• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• localeDesc: string
  Title: Locale Desc

  Read Only: true

  Maximum Length: 100

  The description about the language and country that the Locale object represents.
• recordId: string
  Title: Record Id

  The unique identifier of the Locale object.

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string",
            "writeOnly":true
        },
        "sinceVersion":{
            "type":"string",
            "writeOnly":true
        }
    }
}

204 Response

No preferred locale is configured.

Back to Top