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(required): string
ID for Component Instance.
-
locale(required): string
Desired locale for Component Instance.
Response
Supported Media Types
- application/json
200 Response
The response returned upon successfully retrieving locale specific component instance data by ID.
Nested Schema : localeData
Type:
Show Source
object
-
custom:
object custom
Custom translations used for this locale.
-
resources:
object resources
Nested Schema : items
Type:
Show Source
object
-
href:
string
Default Value:
http://localhost:9080/ccadmin/v1/componentInstances/400002/locale/en?custom=...
Specifies the location (URL) of the external resource. -
rel:
string
Default Value:
self
The relationship between the current document and the linked document/resource.
Nested Schema : custom
Type:
object
Custom translations used for this locale.
Show Source
-
labelNextImage:
string
Default Value:
Next Image label edited version!
Customised label text for NextImage field in this locale.
Nested Schema : resources
Type:
Show Source
object
-
closeLinkAltText:
string
Default Value:
Close
Alt Text for Close Link option in this locale. -
labelExpand:
string
Default Value:
Expand
Label text for Expand field in this locale. -
labelImageSelected:
string
Default Value:
Image selected
Label text for ImageSelected field in this locale. -
labelNextImage:
string
Default Value:
Next Image
Label text for NextImage field in this locale. -
labelOpenExpandedView:
string
Default Value:
Click to open expanded view
Label text for OpenExpandedView field in this locale. -
labelRollOverImage:
string
Default Value:
Roll over image to zoom in
Label text for RollOverImage field in this locale.
404 Response
The error response returned when ID value is not recognised.
Root Schema : getComponentInstanceByLocaleWithId_doesNotExistResponse
Type:
Show Source
object
-
errorCode:
string
Default Value:
33001
The internal error code -
message:
string
Default Value:
Specified widget 'exampleId' does not exist.
The HTTP error message -
status:
string
Default Value:
404
The HTTP status code