Jump to

• Request
• Response

updateWidgetDescriptorBaseLocaleContent

put

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

Update the base locale content associated with the widget descriptor i.e. the one used to build widget instances.

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

Query Parameters

• updateInstances(optional): boolean
  If the changes to the base locale content are to be applied to its current instances.

Body ()

Root Schema : widgetBaseLocaleContent

Type: object

Show Source

• localeData(optional): object localeData
  Template source code.

{
    "properties":{
        "localeData":{
            "description":"Template source code.",
            "type":"object",
            "properties":{
                "resources":{
                    "description":"Base locale strings.",
                    "additionalProperties":{
                    },
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : localeData

Type: object

Template source code.

Show Source

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

  Base locale strings.

{
    "description":"Template source code.",
    "type":"object",
    "properties":{
        "resources":{
            "description":"Base locale strings.",
            "additionalProperties":{
            },
            "type":"object"
        }
    }
}

Nested Schema : resources

Type: object

Additional Properties Allowed

Show Source

{
    "description":"Base locale strings.",
    "additionalProperties":{
    },
    "type":"object"
}

Base locale strings.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : widgetBaseLocaleContent

Type: object

Show Source

• localeData(optional): object localeData
  Template source code.

{
    "properties":{
        "localeData":{
            "description":"Template source code.",
            "type":"object",
            "properties":{
                "resources":{
                    "description":"Base locale strings.",
                    "additionalProperties":{
                    },
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : localeData

Type: object

Template source code.

Show Source

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

  Base locale strings.

{
    "description":"Template source code.",
    "type":"object",
    "properties":{
        "resources":{
            "description":"Base locale strings.",
            "additionalProperties":{
            },
            "type":"object"
        }
    }
}

Nested Schema : resources

Type: object

Additional Properties Allowed

Show Source

{
    "description":"Base locale strings.",
    "additionalProperties":{
    },
    "type":"object"
}

Base locale strings.

Example Response (localeData)

{
    "exampleResourceKey":"Example Resource String"
}

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