Jump to

• Request
• Response

updateComponentCustomTranslationsForLocale

put

/ccadmin/v1/componentInstances/{id}/locale/{locale}

Update Component Instance custom translations by ID for a specific Locale.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID for Component Instance.
• locale: string
  Desired locale for Component Instance.

Body ()

Request body for updateComponentCustomTranslationsForLocale endpoint.

Root Schema : putComponentInstanceByLocaleWithId_request

Type: object

Show Source

• custom(optional): object custom
  This refers to custom translations for text snippets.

{
    "properties":{
        "custom":{
            "description":"This refers to custom translations for text snippets.",
            "properties":{
                "labelExpand":{
                    "default":"Click here to expand image!",
                    "description":"Name of text snippet you want to change - in this case labelExpand.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : custom

Type: object

This refers to custom translations for text snippets.

Show Source

• labelExpand(optional): string
  Default Value: Click here to expand image!

  Name of text snippet you want to change - in this case labelExpand.

{
    "description":"This refers to custom translations for text snippets.",
    "properties":{
        "labelExpand":{
            "default":"Click here to expand image!",
            "description":"Name of text snippet you want to change - in this case labelExpand.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response received after submitting a new text snippet translation for a particular locale and widget instance.

Body ()

Root Schema : putComponentInstanceByLocaleWithId_okResponse

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "default":"self",
                        "description":"The relationship between the current document and the linked document/resource.",
                        "type":"string"
                    },
                    "href":{
                        "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002/locale/en",
                        "description":"Specifies the location (URL) of the external resource.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "default":"self",
                "description":"The relationship between the current document and the linked document/resource.",
                "type":"string"
            },
            "href":{
                "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002/locale/en",
                "description":"Specifies the location (URL) of the external resource.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  Default Value: http://localhost:9080/ccadmin/v1/componentInstances/400002/locale/en

  Specifies the location (URL) of the external resource.
• rel(optional): string
  Default Value: self

  The relationship between the current document and the linked document/resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "default":"self",
            "description":"The relationship between the current document and the linked document/resource.",
            "type":"string"
        },
        "href":{
            "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002/locale/en",
            "description":"Specifies the location (URL) of the external resource.",
            "type":"string"
        }
    }
}

404 Response

The error response returned when ID value is not recognised.

Body ()

Root Schema : putComponentInstanceByLocaleWithId_doesNotExistResponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 33001

  The internal error code
• message(optional): string
  Default Value: Specified widget 'exampleId' does not exist.

  The HTTP error message
• status(optional): string
  Default Value: 404

  The HTTP status code

{
    "properties":{
        "errorCode":{
            "default":"33001",
            "description":"The internal error code",
            "type":"string"
        },
        "message":{
            "default":"Specified widget 'exampleId' does not exist.",
            "description":"The HTTP error message",
            "type":"string"
        },
        "status":{
            "default":"404",
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top