REST API for Oracle Commerce Cloud

listComponents

get

/ccadmin/v1/components

List Components. Endpoint for getting all components.

Request

Supported Media Types

application/json

Query Parameters

includeAllInstances: boolean

If set to false (default is true), sends "numberOfInstances" property (where "numberOfInstances" represents count of instances of that component ) instead of "instances" property in response

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : listComponents_response

Type: object

Show Source

items: array items

Component

{
    "properties":{
        "items":{
            "description":"Component",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "isLatestVersion":{
                        "description":"Is this the latest version of the component.",
                        "type":"boolean"
                    },
                    "updatesAvailable":{
                        "description":"Are there any updates available for this component.",
                        "type":"boolean"
                    },
                    "slotType":{
                        "description":"If component type of slot, the type of slot.",
                        "type":"string"
                    },
                    "instances":{
                        "description":"The instances of the component.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayName":{
                                    "description":"The name displayed for the component instance.",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"The component's repository ID.",
                                    "type":"string"
                                },
                                "layoutAssociations":{
                                    "description":"The layouts the component instances are associated with.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "updateAvailable":{
                                    "description":"Is there an update available for this component instance.",
                                    "type":"boolean"
                                },
                                "version":{
                                    "description":"The current version of the component instance.",
                                    "type":"integer"
                                }
                            }
                        }
                    },
                    "displayName":{
                        "description":"The display name for the component.",
                        "type":"string"
                    },
                    "widgetFamily":{
                        "description":"If component type of widget, the family the widget belongs to.",
                        "type":"string"
                    },
                    "global":{
                        "description":"Is the component global.",
                        "type":"boolean"
                    },
                    "source":{
                        "description":"Is this component out of the box (100) or uploaded (101).",
                        "type":"integer"
                    },
                    "type":{
                        "description":"The type of component.",
                        "type":"string"
                    },
                    "version":{
                        "description":"The current version of the component.",
                        "type":"integer"
                    },
                    "widgetType":{
                        "description":"If component type of widget, the type of widget.",
                        "type":"string"
                    },
                    "latestVersion":{
                        "description":"The latest version of the component.",
                        "type":"integer"
                    },
                    "repositoryId":{
                        "description":"The component's repository ID.",
                        "type":"string"
                    },
                    "hiddenFromSiteStudio":{
                        "description":"Is this component hidden from the site.",
                        "type":"boolean"
                    },
                    "stackType":{
                        "description":"If component type of stack, the type of stack.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Component

Show Source

Array of: object items

{
    "description":"Component",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "isLatestVersion":{
                "description":"Is this the latest version of the component.",
                "type":"boolean"
            },
            "updatesAvailable":{
                "description":"Are there any updates available for this component.",
                "type":"boolean"
            },
            "slotType":{
                "description":"If component type of slot, the type of slot.",
                "type":"string"
            },
            "instances":{
                "description":"The instances of the component.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayName":{
                            "description":"The name displayed for the component instance.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"The component's repository ID.",
                            "type":"string"
                        },
                        "layoutAssociations":{
                            "description":"The layouts the component instances are associated with.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "updateAvailable":{
                            "description":"Is there an update available for this component instance.",
                            "type":"boolean"
                        },
                        "version":{
                            "description":"The current version of the component instance.",
                            "type":"integer"
                        }
                    }
                }
            },
            "displayName":{
                "description":"The display name for the component.",
                "type":"string"
            },
            "widgetFamily":{
                "description":"If component type of widget, the family the widget belongs to.",
                "type":"string"
            },
            "global":{
                "description":"Is the component global.",
                "type":"boolean"
            },
            "source":{
                "description":"Is this component out of the box (100) or uploaded (101).",
                "type":"integer"
            },
            "type":{
                "description":"The type of component.",
                "type":"string"
            },
            "version":{
                "description":"The current version of the component.",
                "type":"integer"
            },
            "widgetType":{
                "description":"If component type of widget, the type of widget.",
                "type":"string"
            },
            "latestVersion":{
                "description":"The latest version of the component.",
                "type":"integer"
            },
            "repositoryId":{
                "description":"The component's repository ID.",
                "type":"string"
            },
            "hiddenFromSiteStudio":{
                "description":"Is this component hidden from the site.",
                "type":"boolean"
            },
            "stackType":{
                "description":"If component type of stack, the type of stack.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName: string

The display name for the component.
global: boolean

Is the component global.
hiddenFromSiteStudio: boolean

Is this component hidden from the site.
instances: array instances

The instances of the component.
isLatestVersion: boolean

Is this the latest version of the component.
latestVersion: integer

The latest version of the component.
repositoryId: string

The component's repository ID.
slotType: string

If component type of slot, the type of slot.
source: integer

Is this component out of the box (100) or uploaded (101).
stackType: string

If component type of stack, the type of stack.
type: string

The type of component.
updatesAvailable: boolean

Are there any updates available for this component.
version: integer

The current version of the component.
widgetFamily: string

If component type of widget, the family the widget belongs to.
widgetType: string

If component type of widget, the type of widget.

{
    "type":"object",
    "properties":{
        "isLatestVersion":{
            "description":"Is this the latest version of the component.",
            "type":"boolean"
        },
        "updatesAvailable":{
            "description":"Are there any updates available for this component.",
            "type":"boolean"
        },
        "slotType":{
            "description":"If component type of slot, the type of slot.",
            "type":"string"
        },
        "instances":{
            "description":"The instances of the component.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The name displayed for the component instance.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The component's repository ID.",
                        "type":"string"
                    },
                    "layoutAssociations":{
                        "description":"The layouts the component instances are associated with.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "updateAvailable":{
                        "description":"Is there an update available for this component instance.",
                        "type":"boolean"
                    },
                    "version":{
                        "description":"The current version of the component instance.",
                        "type":"integer"
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name for the component.",
            "type":"string"
        },
        "widgetFamily":{
            "description":"If component type of widget, the family the widget belongs to.",
            "type":"string"
        },
        "global":{
            "description":"Is the component global.",
            "type":"boolean"
        },
        "source":{
            "description":"Is this component out of the box (100) or uploaded (101).",
            "type":"integer"
        },
        "type":{
            "description":"The type of component.",
            "type":"string"
        },
        "version":{
            "description":"The current version of the component.",
            "type":"integer"
        },
        "widgetType":{
            "description":"If component type of widget, the type of widget.",
            "type":"string"
        },
        "latestVersion":{
            "description":"The latest version of the component.",
            "type":"integer"
        },
        "repositoryId":{
            "description":"The component's repository ID.",
            "type":"string"
        },
        "hiddenFromSiteStudio":{
            "description":"Is this component hidden from the site.",
            "type":"boolean"
        },
        "stackType":{
            "description":"If component type of stack, the type of stack.",
            "type":"string"
        }
    }
}

Nested Schema : instances

Type: array

The instances of the component.

Show Source

Array of: object items

{
    "description":"The instances of the component.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"The name displayed for the component instance.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The component's repository ID.",
                "type":"string"
            },
            "layoutAssociations":{
                "description":"The layouts the component instances are associated with.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "updateAvailable":{
                "description":"Is there an update available for this component instance.",
                "type":"boolean"
            },
            "version":{
                "description":"The current version of the component instance.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName: string

The name displayed for the component instance.
layoutAssociations: array layoutAssociations

The layouts the component instances are associated with.
repositoryId: string

The component's repository ID.
updateAvailable: boolean

Is there an update available for this component instance.
version: integer

The current version of the component instance.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The name displayed for the component instance.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The component's repository ID.",
            "type":"string"
        },
        "layoutAssociations":{
            "description":"The layouts the component instances are associated with.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "updateAvailable":{
            "description":"Is there an update available for this component instance.",
            "type":"boolean"
        },
        "version":{
            "description":"The current version of the component instance.",
            "type":"integer"
        }
    }
}

Nested Schema : layoutAssociations

Type: array

The layouts the component instances are associated with.

Show Source

Array of: string

{
    "description":"The layouts the component instances are associated with.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "items":[
        {
            "isLatestVersion":true,
            "updatesAvailable":false,
            "slotType":"contentVariationSlot",
            "latestVersion":1,
            "instances":[
            ],
            "displayName":"Content Variation Slot",
            "repositoryId":"ContentVariationSlot",
            "hiddenFromSiteStudio":false,
            "global":false,
            "source":100,
            "type":"slot",
            "version":1
        },
        {
            "isLatestVersion":true,
            "updatesAvailable":false,
            "slotType":"experimentSlot",
            "latestVersion":1,
            "instances":[
            ],
            "displayName":"Experiment Slot",
            "repositoryId":"ExperimentSlot",
            "hiddenFromSiteStudio":false,
            "global":false,
            "source":100,
            "type":"slot",
            "version":1
        }
    ]
}

Default Response

The error response.

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"
        }
    }
}