updateComponentInstance
put
/ccadmin/v1/componentInstances/{id}
Update Component Instance by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID for Component Instance.
Request body for updateComponentInstance endpoint.
Root Schema : putComponentInstance_request
Type:
Show Source
object
-
widgetConfig:
object widgetConfig
This refers to configuration for a widget instance.
Nested Schema : widgetConfig
Type:
object
This refers to configuration for a widget instance.
Show Source
-
displayName:
string
Default Value:
ProductImageViewerDisplayName
Display name for component instance. -
name:
string
Default Value:
ProductImageViewerName
Actual name for this component instance. Can be different to Display Name, but best kept the same. -
notes:
string
Default Value:
My favourite instance of the ProductImageViewer component!
Notes for this component instance.
Response
Supported Media Types
- application/json
200 Response
Response received after updating a component instance successfully.
Root Schema : putComponentInstance_okResponse
Type:
Show Source
object
-
component:
object component
The associated component.
-
configuration:
object configuration
Details of any configuration for this component instance.
-
displayName:
string
Default Value:
ProductImageViewerName
Display name for this new component instance. -
layout:
string
Default Value:
oracle.doceng.json.BetterJsonNull@22cc67f3
The Associated layout for the new cloned component instance. -
links:
array links
-
repositoryId:
integer
Default Value:
400001
Repository ID for this new component instance.
Nested Schema : component
Type:
object
The associated component.
Show Source
-
displayName:
string
Default Value:
ProductImageViewer
Display name for component. - hiddenFromSiteStudio: boolean
-
id:
integer
Default Value:
300200
ID attributed to this component. Can be the same as the repositoryId. -
name:
string
Default Value:
ProductImageViewer
Actual name for this component. Can be different to Display Name, but best kept the same. -
namespace:
string
Default Value:
occ.react
Namespace this component exists within. -
providesContext:
string
Default Value:
oracle.doceng.json.BetterJsonNull@4ecf7c1c
Contexts provided relating to this component. -
repositoryId:
integer
Default Value:
300200
Repository ID attributed to this component. -
requiresContext:
string
Default Value:
product_context,container_context
Contexts required relating to this component. -
root:
string
Default Value:
/clientApplications/core-commerce-reference-store/components/ProductImageViewer
Directory root for this component. -
source:
integer
Default Value:
101
ID for the source used to create component. -
type:
string
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
-
thumbnailLocation:
string
Default Value:
left
Location of the thumbnail for this component instance.
Nested Schema : items
Type:
Show Source
object
-
href:
string
Default Value:
http://localhost:9080/ccadmin/v1/componentInstances/500002
Specifies the location (URL) of the external resource. -
rel:
string
Default Value:
self
The relationship between the current document and the linked document/resource.
404 Response
The error response returned when ID value is not recognised.
Root Schema : putComponentInstance_doesNotExistResponse
Type:
Show Source
object
-
errorCode:
string
Default Value:
33001
The internal error code -
message:
string
Default Value:
Specified widget 'exampleId' does not exist.
The HTTP error message -
status:
string
Default Value:
404
The HTTP status code