Jump to

• Request
• Response

Get all active locales for a repository

get

/repositories/{id}/availableLocales

Request

Path Parameters

• id(required): string
  The unique identifier of the repository object, probably FBA17E28CAAB4A7387A44BEE77240E33.

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Maximum number of locales to return.
• offset: integer(int32)
  Minimum Value: 0

  Zero-based index of the first locale to return.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ResultListBOExtendsLocaleKeyBO

Type: object

Show Source

• count: integer (int32)
• hasMore(required): boolean
  Title: Has More

  Default Value: false

  Boolean indicating whether or not the collection contains more items than were returned in this request. Defaults to false.
• items(required): array Items
  Title: Items

  The collection of of the requested resources meeting your criteria.
• limit(required): integer (int32)
  Title: Limit

  The number of items this result is limited to. Used in conjunction with offset for pagination.
• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• offset(required): integer (int32)
  Title: Offset

  The item index at which this resultset starts. Used in conjunction with limit for pagination.

{
    "required":[
        "items",
        "hasMore",
        "limit",
        "offset"
    ],
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "description":"The collection of of the requested resources meeting your criteria.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocaleKeyBO2"
            },
            "readOnly":false
        },
        "hasMore":{
            "title":"Has More",
            "description":"Boolean indicating whether or not the collection contains more items than were returned in this request.  Defaults to false.",
            "default":false,
            "type":"boolean",
            "readOnly":false
        },
        "limit":{
            "format":"int32",
            "title":"Limit",
            "description":"The number of items this result is limited to.  Used in conjunction with offset for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "offset":{
            "format":"int32",
            "title":"Offset",
            "description":"The item index at which this resultset starts.  Used in conjunction with limit for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "count":{
            "format":"int32",
            "type":"integer"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of of the requested resources meeting your criteria.

Show Source

• Array of: object LocaleKeyBO2
  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.)

{
    "title":"Items",
    "description":"The collection of of the requested resources meeting your criteria.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocaleKeyBO2"
    },
    "readOnly":false
}

Nested Schema : Links

Type: array

Title: Links

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":false
}

Nested Schema : LocaleKeyBO2

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

• active: boolean
• dateAdded: string (date-time)
• dateFormat: string
• dateFormatDisplay: string
• dateModified: string (date-time)
• encoding: string
• groupDefault: boolean
• links: array Links
  Title: Links

  Read Only: true

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

  Read Only: true

  Maximum Length: 100

  The description about the language and country that the Locale object represents.
• localeValue: integer (int32)
• recordId: string
  Title: Record Id

  The unique identifier of the Locale object.
• supportsAI: boolean
  Title: Supports AI

  Flag indicating whether this locale supports AI features.
• timeFormat: string
• timeFormatDisplay: string

{
    "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":{
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "supportsAI":{
            "title":"Supports AI",
            "description":"Flag indicating whether this locale supports AI features.",
            "type":"boolean",
            "readOnly":false
        },
        "active":{
            "type":"boolean"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time"
        },
        "dateFormat":{
            "type":"string"
        },
        "dateFormatDisplay":{
            "type":"string"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time"
        },
        "encoding":{
            "type":"string"
        },
        "groupDefault":{
            "type":"boolean"
        },
        "localeCode":{
            "type":"string"
        },
        "localeValue":{
            "type":"integer",
            "format":"int32"
        },
        "timeFormat":{
            "type":"string"
        },
        "timeFormatDisplay":{
            "type":"string"
        },
        "links":{
            "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 : 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
        }
    }
}

Back to Top