Jump to

• Request
• Response

getInstancesForWidgetDescriptor

get

/ccadmin/v1/widgetDescriptors/{id}/instances

Get Instances For Widget Descriptor. Get all instances of a particular widget descriptor type.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The ID of the widget descriptor

Query Parameters

• includeLayoutAssociations: boolean
  If set to true (default is false), layout associations of the instances is passed in endpoint response.
• limit: integer
  This is the field to determine number of records to be fetched per REST call. If provided returns paginated response.
• offset: integer
  This field determines the offset/starting index from which data to be fetched. If provided returns paginated response.
• search: string
  If search provided (default is empty), returns paginated response matching the search query param with display name of instances.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getInstancesForWidgetDescriptor_response

Type: object

Show Source

• items: object items
  Array of widget instances.

{
    "properties":{
        "items":{
            "description":"Array of widget instances.",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"The widget display name",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The Repository Id",
                    "type":"string"
                },
                "descriptor":{
                    "description":"Widget descriptor details",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"The Repository ID",
                            "type":"string"
                        },
                        "minWidth":{
                            "description":"The minimum width",
                            "type":"integer"
                        },
                        "editableWidget":{
                            "description":"Whether the widget is editable",
                            "type":"boolean"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Array of widget instances.

Show Source

• descriptor: object descriptor
  Widget descriptor details
• displayName: string
  The widget display name
• repositoryId: string
  The Repository Id

{
    "description":"Array of widget instances.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The widget display name",
            "type":"string"
        },
        "repositoryId":{
            "description":"The Repository Id",
            "type":"string"
        },
        "descriptor":{
            "description":"Widget descriptor details",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The Repository ID",
                    "type":"string"
                },
                "minWidth":{
                    "description":"The minimum width",
                    "type":"integer"
                },
                "editableWidget":{
                    "description":"Whether the widget is editable",
                    "type":"boolean"
                }
            }
        }
    }
}

Nested Schema : descriptor

Type: object

Widget descriptor details

Show Source

• editableWidget: boolean
  Whether the widget is editable
• minWidth: integer
  The minimum width
• repositoryId: string
  The Repository ID

{
    "description":"Widget descriptor details",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The Repository ID",
            "type":"string"
        },
        "minWidth":{
            "description":"The minimum width",
            "type":"integer"
        },
        "editableWidget":{
            "description":"Whether the widget is editable",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

[
    {
        "displayName":"Header - Basic Widget",
        "repositoryId":"basicHeaderWidgetInst",
        "descriptor":{
            "repositoryId":"headerWidget",
            "minWidth":1,
            "editableWidget":true
        }
    },
    {
        "displayName":"Header Widget",
        "repositoryId":"headerWidgetInst",
        "descriptor":{
            "repositoryId":"headerWidget",
            "minWidth":1,
            "editableWidget":true
        }
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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