Jump to

• Request
• Response

getConfigLocaleContentForWidgetDescriptor

get

/ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}

Gets the config locale content for widget descriptor for the specified locale.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the widget descriptor
• locale: string
  The locale of the of the desired content

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : configLocaleContentForWidgetDescriptor

Type: object

Show Source

• items(optional): object items
  response

{
    "properties":{
        "items":{
            "description":"response",
            "type":"object",
            "properties":{
                "localeData":{
                    "description":"Locale strings structure",
                    "type":"object",
                    "properties":{
                        "resources":{
                            "description":"Locale strings sub-structure",
                            "additionalProperties":{
                            },
                            "type":"object"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

response

Show Source

• localeData(optional): object localeData
  Locale strings structure

{
    "description":"response",
    "type":"object",
    "properties":{
        "localeData":{
            "description":"Locale strings structure",
            "type":"object",
            "properties":{
                "resources":{
                    "description":"Locale strings sub-structure",
                    "additionalProperties":{
                    },
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : localeData

Type: object

Locale strings structure

Show Source

• resources(optional): object resources
  Additional Properties Allowed: additionalProperties

  Locale strings sub-structure

{
    "description":"Locale strings structure",
    "type":"object",
    "properties":{
        "resources":{
            "description":"Locale strings sub-structure",
            "additionalProperties":{
            },
            "type":"object"
        }
    }
}

Nested Schema : resources

Type: object

Additional Properties Allowed

Show Source

{
    "description":"Locale strings sub-structure",
    "additionalProperties":{
    },
    "type":"object"
}

Locale strings sub-structure

Example Response (application/json)

{
    "localeData":{
        "resources":{
            "exampleStringPropertyHelpText":"Example string property help text",
            "exampleOption3Label":"Example Option 3",
            "exampleBooleanPropertyLabel":"Example Boolean Property Label",
            "exampleStringPropertyLabel":"Example String Property Label",
            "exampleOptionPropertyLabel":"Example Option Property Label",
            "exampleOption1Label":"Example Option 1",
            "exampleBooleanPropertyHelpText":"Example boolean property help text",
            "exampleOptionPropertyHelpText":"Example option property help text",
            "exampleOption2Label":"Example Option 2"
        }
    }
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top