REST API for Oracle Commerce Cloud

cloneComponentInstance

post

/ccadmin/v1/componentInstances/clone

Clone a new instance for a component.

Request

Supported Media Types

application/json

Request body for cloneComponentInstance endpoint.

Root Schema : cloneComponentInstance_request

Type: object

Show Source

deepClone: boolean

Default Value: false

Whether the method will create a 'deep clone' - A new instance will be created in this case.
displayName: string

Default Value: Shopping-Cart-Clone

The Display Name for the new cloned component instance.
source: string

Default Value: 100011

The ID of the component instance to be cloned.

{
    "properties":{
        "displayName":{
            "default":"Shopping-Cart-Clone",
            "description":"The Display Name for the new cloned component instance.",
            "type":"string"
        },
        "deepClone":{
            "default":false,
            "description":"Whether the method will create a 'deep clone' - A new instance will be created in this case.",
            "type":"boolean"
        },
        "source":{
            "default":100011,
            "description":"The ID of the component instance to be cloned.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The response returned upon successfully cloning a component instance.

Root Schema : cloneComponentInstance_okResponse

Type: object

Show Source

component: object component

The associated component.
configuration: object configuration

Details of any configuration for this component instance.
displayName: string

Default Value: ExampleOfClone

Display name for this new component instance.
layout: string

Default Value: oracle.doceng.json.BetterJsonNull@21140225

The Associated layout for the new cloned component instance.
links: array links
repositoryId: integer

Default Value: 400001

Repository ID for this new component instance.

{
    "type":"object",
    "properties":{
        "layout":{
            "default":null,
            "description":"The Associated layout for the new cloned component instance.",
            "type":"string"
        },
        "component":{
            "description":"The associated component.",
            "type":"object",
            "properties":{
                "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"
                },
                "displayName":{
                    "default":"ProductImageViewer",
                    "description":"Display name for 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"
                },
                "name":{
                    "default":"ProductImageViewer",
                    "description":"Actual name for this component. Can be different to Display Name, but best kept the same.",
                    "type":"string"
                },
                "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"
                },
                "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"
                }
            }
        },
        "configuration":{
            "description":"Details of any configuration for this component instance.",
            "type":"object",
            "properties":{
                "thumbnailLocation":{
                    "default":"left",
                    "description":"Location of the thumbnail for this component instance.",
                    "type":"string"
                }
            }
        },
        "displayName":{
            "default":"ExampleOfClone",
            "description":"Display name for this new component instance.",
            "type":"string"
        },
        "repositoryId":{
            "default":400001,
            "description":"Repository ID for this new component instance.",
            "type":"integer"
        },
        "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/clone",
                        "description":"Specifies the location (URL) of the external resource.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : component

Type: object

The associated component.

Show Source

displayName: string

Default Value: ProductImageViewer

Display name for component.
hiddenFromSiteStudio: boolean

Default Value: false

Whether this is hidden from Design Studio in the admin site.
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@35d7dc91

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.

{
    "description":"The associated component.",
    "type":"object",
    "properties":{
        "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"
        },
        "displayName":{
            "default":"ProductImageViewer",
            "description":"Display name for 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"
        },
        "name":{
            "default":"ProductImageViewer",
            "description":"Actual name for this component. Can be different to Display Name, but best kept the same.",
            "type":"string"
        },
        "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"
        },
        "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"
        }
    }
}

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.

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

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/clone",
                "description":"Specifies the location (URL) of the external resource.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

href: string

Default Value: http://localhost:9080/ccadmin/v1/componentInstances/clone

Specifies the location (URL) of the external resource.
rel: 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/clone",
            "description":"Specifies the location (URL) of the external resource.",
            "type":"string"
        }
    }
}

404 Response

The error response returned when ID value is not recognised.

Root Schema : cloneComponentInstance_doesNotExistResponse

Type: object

Show Source

errorCode: string

Default Value: 33001

The internal error code.
message: string

Default Value: Component instance with id: 100011 not found.

The HTTP error message.
status: string

Default Value: 404

The HTTP status code.

{
    "properties":{
        "errorCode":{
            "default":"33001",
            "description":"The internal error code.",
            "type":"string"
        },
        "message":{
            "default":"Component instance with id: 100011 not found.",
            "description":"The HTTP error message.",
            "type":"string"
        },
        "status":{
            "default":"404",
            "description":"The HTTP status code.",
            "type":"string"
        }
    }
}