updateComponentInstance

put

/ccadmin/v1/componentInstances/{id}

Update Component Instance by ID.

Request

Supported Media Types
Path Parameters
Body ()
Request body for updateComponentInstance endpoint.
Root Schema : putComponentInstance_request
Type: object
Show Source
Nested Schema : widgetConfig
Type: object
This refers to configuration for a widget instance.
Show Source
  • Default Value: ProductImageViewerDisplayName
    Display name for component instance.
  • Default Value: ProductImageViewerName
    Actual name for this component instance. Can be different to Display Name, but best kept the same.
  • Default Value: My favourite instance of the ProductImageViewer component!
    Notes for this component instance.
Back to Top

Response

Supported Media Types

200 Response

Response received after updating a component instance successfully.
Body ()
Root Schema : putComponentInstance_okResponse
Type: object
Show Source
Nested Schema : component
Type: object
The associated component.
Show Source
  • Default Value: ProductImageViewer
    Display name for component.
  • Default Value: false
    Whether this is hidden from Design Studio in the admin site.
  • Default Value: 300200
    ID attributed to this component. Can be the same as the repositoryId.
  • Default Value: ProductImageViewer
    Actual name for this component. Can be different to Display Name, but best kept the same.
  • Default Value: occ.react
    Namespace this component exists within.
  • Default Value: oracle.doceng.json.BetterJsonNull@4ecf7c1c
    Contexts provided relating to this component.
  • Default Value: 300200
    Repository ID attributed to this component.
  • Default Value: product_context,container_context
    Contexts required relating to this component.
  • Default Value: /clientApplications/core-commerce-reference-store/components/ProductImageViewer
    Directory root for this component.
  • Default Value: 101
    ID for the source used to create component.
  • Default Value: component
    The type of repository item. Will always be component here.
Nested Schema : configuration
Type: object
Details of any configuration for this component instance.
Show Source

404 Response

The error response returned when ID value is not recognised.
Body ()
Root Schema : putComponentInstance_doesNotExistResponse
Type: object
Show Source
Back to Top