Jump to

• Request
• Response

getComponentLocaleContentForLocale

get

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

Retrieve locale-specific Component Instance widget data by ID. User may select locale with parameters in the form of ISO 3166-1 Alpha-2 codes (England - en, France - fr etc).

Request

Supported Media Types

• application/json

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The response returned upon successfully retrieving locale specific component instance data by ID.

Body ()

Root Schema : getComponentInstanceByLocaleWithId_okResponse

Type: object

Show Source

• links(optional): array links
• localeData(optional): object localeData

{
    "type":"object",
    "properties":{
        "localeData":{
            "type":"object",
            "properties":{
                "custom":{
                    "description":"Custom translations used for this locale.",
                    "type":"object",
                    "properties":{
                        "labelNextImage":{
                            "default":"Next Image label edited version!",
                            "description":"Customised label text for NextImage field in this locale.",
                            "type":"string"
                        }
                    }
                },
                "resources":{
                    "type":"object",
                    "properties":{
                        "labelNextImage":{
                            "default":"Next Image",
                            "description":"Label text for NextImage field in this locale.",
                            "type":"string"
                        },
                        "labelRollOverImage":{
                            "default":"Roll over image to zoom in",
                            "description":"Label text for RollOverImage field in this locale.",
                            "type":"string"
                        },
                        "labelImageSelected":{
                            "default":"Image selected",
                            "description":"Label text for ImageSelected field in this locale.",
                            "type":"string"
                        },
                        "labelExpand":{
                            "default":"Expand",
                            "description":"Label text for Expand field in this locale.",
                            "type":"string"
                        },
                        "closeLinkAltText":{
                            "default":"Close",
                            "description":"Alt Text for Close Link option in this locale.",
                            "type":"string"
                        },
                        "labelOpenExpandedView":{
                            "default":"Click to open expanded view",
                            "description":"Label text for OpenExpandedView field in this locale.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "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?custom=...",
                        "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?custom=...",
                "description":"Specifies the location (URL) of the external resource.",
                "type":"string"
            }
        }
    }
}

Nested Schema : localeData

Type: object

Show Source

• custom(optional): object custom
  Custom translations used for this locale.
• resources(optional): object resources

{
    "type":"object",
    "properties":{
        "custom":{
            "description":"Custom translations used for this locale.",
            "type":"object",
            "properties":{
                "labelNextImage":{
                    "default":"Next Image label edited version!",
                    "description":"Customised label text for NextImage field in this locale.",
                    "type":"string"
                }
            }
        },
        "resources":{
            "type":"object",
            "properties":{
                "labelNextImage":{
                    "default":"Next Image",
                    "description":"Label text for NextImage field in this locale.",
                    "type":"string"
                },
                "labelRollOverImage":{
                    "default":"Roll over image to zoom in",
                    "description":"Label text for RollOverImage field in this locale.",
                    "type":"string"
                },
                "labelImageSelected":{
                    "default":"Image selected",
                    "description":"Label text for ImageSelected field in this locale.",
                    "type":"string"
                },
                "labelExpand":{
                    "default":"Expand",
                    "description":"Label text for Expand field in this locale.",
                    "type":"string"
                },
                "closeLinkAltText":{
                    "default":"Close",
                    "description":"Alt Text for Close Link option in this locale.",
                    "type":"string"
                },
                "labelOpenExpandedView":{
                    "default":"Click to open expanded view",
                    "description":"Label text for OpenExpandedView field in this locale.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

  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?custom=...",
            "description":"Specifies the location (URL) of the external resource.",
            "type":"string"
        }
    }
}

Nested Schema : custom

Type: object

Custom translations used for this locale.

Show Source

• labelNextImage(optional): string
  Default Value: Next Image label edited version!

  Customised label text for NextImage field in this locale.

{
    "description":"Custom translations used for this locale.",
    "type":"object",
    "properties":{
        "labelNextImage":{
            "default":"Next Image label edited version!",
            "description":"Customised label text for NextImage field in this locale.",
            "type":"string"
        }
    }
}

Nested Schema : resources

Type: object

Show Source

• closeLinkAltText(optional): string
  Default Value: Close

  Alt Text for Close Link option in this locale.
• labelExpand(optional): string
  Default Value: Expand

  Label text for Expand field in this locale.
• labelImageSelected(optional): string
  Default Value: Image selected

  Label text for ImageSelected field in this locale.
• labelNextImage(optional): string
  Default Value: Next Image

  Label text for NextImage field in this locale.
• labelOpenExpandedView(optional): string
  Default Value: Click to open expanded view

  Label text for OpenExpandedView field in this locale.
• labelRollOverImage(optional): string
  Default Value: Roll over image to zoom in

  Label text for RollOverImage field in this locale.

{
    "type":"object",
    "properties":{
        "labelNextImage":{
            "default":"Next Image",
            "description":"Label text for NextImage field in this locale.",
            "type":"string"
        },
        "labelRollOverImage":{
            "default":"Roll over image to zoom in",
            "description":"Label text for RollOverImage field in this locale.",
            "type":"string"
        },
        "labelImageSelected":{
            "default":"Image selected",
            "description":"Label text for ImageSelected field in this locale.",
            "type":"string"
        },
        "labelExpand":{
            "default":"Expand",
            "description":"Label text for Expand field in this locale.",
            "type":"string"
        },
        "closeLinkAltText":{
            "default":"Close",
            "description":"Alt Text for Close Link option in this locale.",
            "type":"string"
        },
        "labelOpenExpandedView":{
            "default":"Click to open expanded view",
            "description":"Label text for OpenExpandedView field in this locale.",
            "type":"string"
        }
    }
}

404 Response

The error response returned when ID value is not recognised.

Body ()

Root Schema : getComponentInstanceByLocaleWithId_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