Jump to

• Request
• Response

updateWidgetDescriptorJavascript

put

/ccadmin/v1/widgetDescriptors/{id}/javascript/{filename}

Update Widget Descriptor Javascript. Updates the Widget Descriptor JavaScript

Request

Supported Media Types

• application/json

Path Parameters

• filename: string
  the javascript file name
• id: string
  the widget type id

Body ()

Root Schema : updateWidgetDescriptorJavascript_request

Type: object

Show Source

• source(optional): string
  the javascript source

{
    "properties":{
        "source":{
            "description":"the javascript source",
            "type":"string"
        }
    },
    "example":{
        "source":"/**\n * @fileoverview Hello World Widget.\n *\n * @author nev @example.com\n */\ndefine(\n \n  \n  function () {\n\n \"use strict\";\n\n  return {\n\n  onLoad: function(widget) {\n var temp;\n },\n\n beforeAppear: function(page) {\n\n }\n };\n  }\n);\n"
    }
}

Example:

{
    "source":"/**\n * @fileoverview Hello World Widget.\n *\n * @author nev @example.com\n */\ndefine(\n \n  \n  function () {\n\n \"use strict\";\n\n  return {\n\n  onLoad: function(widget) {\n var temp;\n },\n\n beforeAppear: function(page) {\n\n }\n };\n  }\n);\n"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateWidgetDescriptorJavascript_response

Type: object

Show Source

• name(optional): string
  the javascript file name
• url(optional): string
  the url of the javascript file

{
    "properties":{
        "name":{
            "description":"the javascript file name",
            "type":"string"
        },
        "url":{
            "description":"the url of the javascript file",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "name":"helloWorldWidget-1.js",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/helloWorldWidget-1_v1/javascript/helloWorldWidget-1.js"
        }
    ],
    "url":"http://localhost:9080/file/v1/widget/helloWorldWidget-1/js/helloWorldWidget-1.js"
}

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