Jump to

• Request
• Response

getComponentInstance

get

/ccadmin/v1/componentInstances/{id}

Retrieve Component Instance by ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID for Component Instance.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The response returned upon successfully retrieving a component instance by ID.

Body ()

Root Schema : getComponentInstance_okResponse

Type: object

Show Source

• instance(optional): object instance
  The associated component.
• links(optional): array links
• name(optional): string
  Default Value: ExampleOfClone

  Name for this component instance.
• notes(optional): string
  Default Value:

  Notes for this component instance.
• settings(optional): object settings

{
    "type":"object",
    "properties":{
        "settings":{
            "type":"object",
            "properties":{
                "thumbnailLocation":{
                    "default":"left",
                    "description":"Location of the thumbnail for this component instance.",
                    "type":"string"
                }
            }
        },
        "instance":{
            "description":"The associated component.",
            "type":"object",
            "properties":{
                "component":{
                    "description":"The associated component.",
                    "type":"object",
                    "properties":{
                        "isLatestVersion":{
                            "default":true,
                            "description":"Is the component the latest version.",
                            "type":"boolean"
                        },
                        "displayName":{
                            "default":"ProductImageViewer",
                            "description":"Display name for component.",
                            "type":"string"
                        },
                        "global":{
                            "default":null,
                            "description":"Whether the component is global.",
                            "type":"string"
                        },
                        "source":{
                            "default":101,
                            "description":"ID for the source used to create component.",
                            "type":"integer"
                        },
                        "type":{
                            "default":"component",
                            "description":"The type of repository item. Will always be component here.",
                            "type":"string"
                        },
                        "version":{
                            "default":1,
                            "description":"Version of the component.",
                            "type":"integer"
                        },
                        "latestVersion":{
                            "default":1,
                            "description":"Latest version of the component.",
                            "type":"integer"
                        },
                        "providesContext":{
                            "default":null,
                            "description":"Contexts provided relating to this component.",
                            "type":"string"
                        },
                        "requiresContext":{
                            "default":"product_context,container_context",
                            "description":"Contexts required relating to this component.",
                            "type":"string"
                        },
                        "root":{
                            "default":"/clientApplications/core-commerce-reference-store/components/ProductImageViewer",
                            "description":"Directory root for this component.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "default":300200,
                            "description":"Repository ID attributed to this component.",
                            "type":"integer"
                        },
                        "namespace":{
                            "default":"occ.react",
                            "description":"Namespace this component exists within.",
                            "type":"string"
                        },
                        "hiddenFromSiteStudio":{
                            "default":false,
                            "description":"Whether this is hidden from Design Studio in the admin site.",
                            "type":"boolean"
                        },
                        "id":{
                            "default":300200,
                            "description":"ID attributed to this component. Can be the same as the repositoryId.",
                            "type":"integer"
                        },
                        "configurable":{
                            "default":true,
                            "description":"Whether the component can be configured from Design Studio or not.",
                            "type":"boolean"
                        }
                    }
                },
                "displayName":{
                    "default":"ProductImageViewer",
                    "description":"Display name for component.",
                    "type":"string"
                },
                "repositoryId":{
                    "default":400001,
                    "description":"Repository ID attributed to this component instance.",
                    "type":"integer"
                },
                "id":{
                    "default":400001,
                    "description":"ID attributed to this component instance. Can be the same as the repositoryId.",
                    "type":"integer"
                },
                "version":{
                    "default":1,
                    "description":"Version of the component instance.",
                    "type":"integer"
                }
            }
        },
        "notes":{
            "default":"",
            "description":"Notes for this component instance.",
            "type":"string"
        },
        "name":{
            "default":"ExampleOfClone",
            "description":"Name for this component instance.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "default":"self",
                        "description":"The relationship between the current document and the linked document/resource.",
                        "type":"string"
                    },
                    "href":{
                        "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002?custom=...",
                        "description":"Specifies the location (URL) of the external resource.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : instance

Type: object

The associated component.

Show Source

• component(optional): object component
  The associated component.
• displayName(optional): string
  Default Value: ProductImageViewer

  Display name for component.
• id(optional): integer
  Default Value: 400001

  ID attributed to this component instance. Can be the same as the repositoryId.
• repositoryId(optional): integer
  Default Value: 400001

  Repository ID attributed to this component instance.
• version(optional): integer
  Default Value: 1

  Version of the component instance.

{
    "description":"The associated component.",
    "type":"object",
    "properties":{
        "component":{
            "description":"The associated component.",
            "type":"object",
            "properties":{
                "isLatestVersion":{
                    "default":true,
                    "description":"Is the component the latest version.",
                    "type":"boolean"
                },
                "displayName":{
                    "default":"ProductImageViewer",
                    "description":"Display name for component.",
                    "type":"string"
                },
                "global":{
                    "default":null,
                    "description":"Whether the component is global.",
                    "type":"string"
                },
                "source":{
                    "default":101,
                    "description":"ID for the source used to create component.",
                    "type":"integer"
                },
                "type":{
                    "default":"component",
                    "description":"The type of repository item. Will always be component here.",
                    "type":"string"
                },
                "version":{
                    "default":1,
                    "description":"Version of the component.",
                    "type":"integer"
                },
                "latestVersion":{
                    "default":1,
                    "description":"Latest version of the component.",
                    "type":"integer"
                },
                "providesContext":{
                    "default":null,
                    "description":"Contexts provided relating to this component.",
                    "type":"string"
                },
                "requiresContext":{
                    "default":"product_context,container_context",
                    "description":"Contexts required relating to this component.",
                    "type":"string"
                },
                "root":{
                    "default":"/clientApplications/core-commerce-reference-store/components/ProductImageViewer",
                    "description":"Directory root for this component.",
                    "type":"string"
                },
                "repositoryId":{
                    "default":300200,
                    "description":"Repository ID attributed to this component.",
                    "type":"integer"
                },
                "namespace":{
                    "default":"occ.react",
                    "description":"Namespace this component exists within.",
                    "type":"string"
                },
                "hiddenFromSiteStudio":{
                    "default":false,
                    "description":"Whether this is hidden from Design Studio in the admin site.",
                    "type":"boolean"
                },
                "id":{
                    "default":300200,
                    "description":"ID attributed to this component. Can be the same as the repositoryId.",
                    "type":"integer"
                },
                "configurable":{
                    "default":true,
                    "description":"Whether the component can be configured from Design Studio or not.",
                    "type":"boolean"
                }
            }
        },
        "displayName":{
            "default":"ProductImageViewer",
            "description":"Display name for component.",
            "type":"string"
        },
        "repositoryId":{
            "default":400001,
            "description":"Repository ID attributed to this component instance.",
            "type":"integer"
        },
        "id":{
            "default":400001,
            "description":"ID attributed to this component instance. Can be the same as the repositoryId.",
            "type":"integer"
        },
        "version":{
            "default":1,
            "description":"Version of the component instance.",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "default":"self",
                "description":"The relationship between the current document and the linked document/resource.",
                "type":"string"
            },
            "href":{
                "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002?custom=...",
                "description":"Specifies the location (URL) of the external resource.",
                "type":"string"
            }
        }
    }
}

Nested Schema : settings

Type: object

Show Source

• thumbnailLocation(optional): string
  Default Value: left

  Location of the thumbnail for this component instance.

{
    "type":"object",
    "properties":{
        "thumbnailLocation":{
            "default":"left",
            "description":"Location of the thumbnail for this component instance.",
            "type":"string"
        }
    }
}

Nested Schema : component

Type: object

The associated component.

Show Source

• configurable(optional): boolean
  Default Value: true

  Whether the component can be configured from Design Studio or not.
• displayName(optional): string
  Default Value: ProductImageViewer

  Display name for component.
• global(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@6937256e

  Whether the component is global.
• hiddenFromSiteStudio(optional): boolean
  Default Value: false

  Whether this is hidden from Design Studio in the admin site.
• id(optional): integer
  Default Value: 300200

  ID attributed to this component. Can be the same as the repositoryId.
• isLatestVersion(optional): boolean
  Default Value: true

  Is the component the latest version.
• latestVersion(optional): integer
  Default Value: 1

  Latest version of the component.
• namespace(optional): string
  Default Value: occ.react

  Namespace this component exists within.
• providesContext(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@3b0003fb

  Contexts provided relating to this component.
• repositoryId(optional): integer
  Default Value: 300200

  Repository ID attributed to this component.
• requiresContext(optional): string
  Default Value: product_context,container_context

  Contexts required relating to this component.
• root(optional): string
  Default Value: /clientApplications/core-commerce-reference-store/components/ProductImageViewer

  Directory root for this component.
• source(optional): integer
  Default Value: 101

  ID for the source used to create component.
• type(optional): string
  Default Value: component

  The type of repository item. Will always be component here.
• version(optional): integer
  Default Value: 1

  Version of the component.

{
    "description":"The associated component.",
    "type":"object",
    "properties":{
        "isLatestVersion":{
            "default":true,
            "description":"Is the component the latest version.",
            "type":"boolean"
        },
        "displayName":{
            "default":"ProductImageViewer",
            "description":"Display name for component.",
            "type":"string"
        },
        "global":{
            "default":null,
            "description":"Whether the component is global.",
            "type":"string"
        },
        "source":{
            "default":101,
            "description":"ID for the source used to create component.",
            "type":"integer"
        },
        "type":{
            "default":"component",
            "description":"The type of repository item. Will always be component here.",
            "type":"string"
        },
        "version":{
            "default":1,
            "description":"Version of the component.",
            "type":"integer"
        },
        "latestVersion":{
            "default":1,
            "description":"Latest version of the component.",
            "type":"integer"
        },
        "providesContext":{
            "default":null,
            "description":"Contexts provided relating to this component.",
            "type":"string"
        },
        "requiresContext":{
            "default":"product_context,container_context",
            "description":"Contexts required relating to this component.",
            "type":"string"
        },
        "root":{
            "default":"/clientApplications/core-commerce-reference-store/components/ProductImageViewer",
            "description":"Directory root for this component.",
            "type":"string"
        },
        "repositoryId":{
            "default":300200,
            "description":"Repository ID attributed to this component.",
            "type":"integer"
        },
        "namespace":{
            "default":"occ.react",
            "description":"Namespace this component exists within.",
            "type":"string"
        },
        "hiddenFromSiteStudio":{
            "default":false,
            "description":"Whether this is hidden from Design Studio in the admin site.",
            "type":"boolean"
        },
        "id":{
            "default":300200,
            "description":"ID attributed to this component. Can be the same as the repositoryId.",
            "type":"integer"
        },
        "configurable":{
            "default":true,
            "description":"Whether the component can be configured from Design Studio or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  Default Value: http://localhost:9080/ccadmin/v1/componentInstances/400002?custom=...

  Specifies the location (URL) of the external resource.
• rel(optional): string
  Default Value: self

  The relationship between the current document and the linked document/resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "default":"self",
            "description":"The relationship between the current document and the linked document/resource.",
            "type":"string"
        },
        "href":{
            "default":"http://localhost:9080/ccadmin/v1/componentInstances/400002?custom=...",
            "description":"Specifies the location (URL) of the external resource.",
            "type":"string"
        }
    }
}

404 Response

The error response returned when ID value is not recognised.

Body ()

Root Schema : getComponentInstance_doesNotExistResponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 33001

  The internal error code
• message(optional): string
  Default Value: Specified widget 'exampleId' does not exist.

  The HTTP error message
• status(optional): string
  Default Value: 404

  The HTTP status code

{
    "properties":{
        "errorCode":{
            "default":"33001",
            "description":"The internal error code",
            "type":"string"
        },
        "message":{
            "default":"Specified widget 'exampleId' does not exist.",
            "description":"The HTTP error message",
            "type":"string"
        },
        "status":{
            "default":"404",
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top