Jump to

• Request
• Response

getWidgetDescriptorJavascriptInfoById

get

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

Get Widget Descriptor Javascript Info By Id. Gets the widget descriptor javascript info by id.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  the widget type id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getWidgetDescriptorJavascriptInfoById_response

Type: object

Show Source

• displayName(optional): string
  The widget display name
• jsfiles(optional): array jsfiles
  java script file url
• multipleVersions(optional): boolean
  Is there multiple versions of this widget
• version(optional): integer
  the widget version

{
    "properties":{
        "displayName":{
            "description":"The widget display name",
            "type":"string"
        },
        "multipleVersions":{
            "description":"Is there multiple versions of this widget",
            "type":"boolean"
        },
        "version":{
            "description":"the widget version",
            "type":"integer"
        },
        "jsfiles":{
            "description":"java script file url",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The javascript filename",
                        "type":"string"
                    },
                    "url":{
                        "description":"The javascript file url",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : jsfiles

Type: array

java script file url

Show Source

• Array of: object items

{
    "description":"java script file url",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The javascript filename",
                "type":"string"
            },
            "url":{
                "description":"The javascript file url",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name(optional): string
  The javascript filename
• url(optional): string
  The javascript file url

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The javascript filename",
            "type":"string"
        },
        "url":{
            "description":"The javascript file url",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "jsFiles":[
        {
            "name":"helloWorldWidget-1.js",
            "url":"http://localhost:9080/file/widget/helloWorldWidget-1/js/helloWorldWidget-1.js"
        }
    ],
    "displayName":"Hello World Widget 1",
    "multipleVersions":false,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/helloWorldWidget-1_v1/javascript"
        }
    ],
    "version":"1",
    "___etag___":"eyJoYXNoIjoibDBuRHNtSEVEMlc0OFllRERhNm41Z0V6cFRienlPaEcyZzZXWWRETm1lYz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL3dpZGdldERlc2NyaXB0b3JzL2hlbGxvV29ybGRXaWRnZXQtMV92MS9qYXZhc2NyaXB0IiwidmVyc2lvbiI6MH0="
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33038|Widget Javascript is not editable.|

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