Jump to

• Request
• Response

Update the default repository's preferred locale

patch

/repositories/default/defaultPreferredLocale

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Preferred locale update. Send a locale record ID to select a preferred locale. The service also accepts an empty object, which clears the readable preferred-locale value.

Show Source

• recordId: string
  Locale identifier, for example en_US.

{
    "description":"Preferred locale update. Send a locale record ID to select a preferred locale. The service also accepts an empty object, which clears the readable preferred-locale value.",
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"Locale identifier, for example en_US."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : RepositoryBO

Type: object

Show Source

• availableLocales(required): array availableLocales
• dateAdded: string (date-time)
  Title: Date Added

  Read Only: true

  The date and time when this repository was created.

  Example: 2022-03-10
• dateModified: string (date-time)
  Title: Date Modified

  Read Only: true

  The date and time this repository was last modified.

  Example: 2022-03-10
• defaultLocale(required): object LocaleKeyBO
  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.)

• defaultPreferredLocale: object LocaleKeyBO
  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.)

• links: array links
• name(required): string
  Minimum Length: 1

  Maximum Length: 255
• objectId: string
• recordId: string
• referenceKey(required): string
  Minimum Length: 1

  Maximum Length: 255

{
    "required":[
        "referenceKey",
        "name",
        "availableLocales",
        "defaultLocale"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "dateAdded":{
            "format":"date-time",
            "title":"Date Added",
            "description":"The date and time when this repository was created.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "dateModified":{
            "format":"date-time",
            "title":"Date Modified",
            "description":"The date and time this repository was last modified.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "availableLocales":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocaleKeyBO"
            }
        },
        "defaultLocale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        "defaultPreferredLocale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        }
    }
}

Nested Schema : availableLocales

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocaleKeyBO"
    }
}

Nested 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

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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
        }
    }
}

400 Response

Invalid locale update request.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• error: object error
• errorDetails: array errorDetails

{
    "type":"object",
    "properties":{
        "error":{
            "type":"object",
            "properties":{
                "title":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                }
            }
        },
        "errorDetails":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : error

Type: object

Show Source

• errorCode: string
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : errorDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

500 Response

Repository locale update failed.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• error: object error
• errorDetails: array errorDetails

{
    "type":"object",
    "properties":{
        "error":{
            "type":"object",
            "properties":{
                "title":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                }
            }
        },
        "errorDetails":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : error

Type: object

Show Source

• errorCode: string
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : errorDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top