Jump to

• Request
• Response

createComponentInstance

post

/ccadmin/v1/applications/{applicationId}/components/{componentId}/instances

Creates an instance of a component.

Request

Supported Media Types

• application/json

Path Parameters

• applicationId(required): string
  The ID of the application.
• componentId(required): string
  The ID of the component.

Body ()

Root Schema : createComponentInstance_request

Type: object

Show Source

• displayName: string
  Name for the new component instance

{
    "properties":{
        "displayName":{
            "description":"Name for the new component instance",
            "type":"string"
        }
    },
    "example":{
        "displayName":"New Web Content"
    }
}

Example:

{
    "displayName":"New Web Content"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createComponentInstance_response

Type: object

Show Source

• component: object component
  The parent component.
• configuration: object configuration
  Configuration settings for the component instance
• displayName: string
  The display name for the component instance.
• layout: object layout
  The layout for the component, if any.
• repositoryId: string
  The component instance's repository ID.
• usageCount: integer
  Number of pages where instance is used.

{
    "properties":{
        "layout":{
            "description":"The layout for the component, if any.",
            "type":"object"
        },
        "component":{
            "description":"The parent component.",
            "type":"object",
            "properties":{
                "providesContext":{
                    "description":"the container context that the component provides.",
                    "type":"string"
                },
                "requiresContext":{
                    "description":"the container context that the component requires.",
                    "type":"string"
                },
                "displayName":{
                    "description":"The display name for the component.",
                    "type":"string"
                },
                "root":{
                    "description":"The root folder for the component's assets",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The component's repository ID.",
                    "type":"string"
                },
                "name":{
                    "description":"The  name for the component.",
                    "type":"string"
                },
                "namespace":{
                    "description":"The namespace for the component (e.g. occ.react).",
                    "type":"string"
                },
                "hiddenFromSiteStudio":{
                    "description":"Is this component hidden from the site.",
                    "type":"boolean"
                },
                "id":{
                    "description":"The component's repository ID.",
                    "type":"string"
                },
                "source":{
                    "description":"Is this component out of the box (100) or uploaded (101).",
                    "type":"integer"
                },
                "type":{
                    "description":"The type of component.",
                    "type":"string"
                }
            }
        },
        "configuration":{
            "description":"Configuration settings for the component instance",
            "type":"object"
        },
        "displayName":{
            "description":"The display name for the component instance.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The component instance's repository ID.",
            "type":"string"
        },
        "usageCount":{
            "description":"Number of pages where instance is used.",
            "type":"integer"
        }
    }
}

Nested Schema : component

Type: object

The parent component.

Show Source

• displayName: string
  The display name for the component.
• hiddenFromSiteStudio: boolean
  Is this component hidden from the site.
• id: string
  The component's repository ID.
• name: string
  The name for the component.
• namespace: string
  The namespace for the component (e.g. occ.react).
• providesContext: string
  the container context that the component provides.
• repositoryId: string
  The component's repository ID.
• requiresContext: string
  the container context that the component requires.
• root: string
  The root folder for the component's assets
• source: integer
  Is this component out of the box (100) or uploaded (101).
• type: string
  The type of component.

{
    "description":"The parent component.",
    "type":"object",
    "properties":{
        "providesContext":{
            "description":"the container context that the component provides.",
            "type":"string"
        },
        "requiresContext":{
            "description":"the container context that the component requires.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name for the component.",
            "type":"string"
        },
        "root":{
            "description":"The root folder for the component's assets",
            "type":"string"
        },
        "repositoryId":{
            "description":"The component's repository ID.",
            "type":"string"
        },
        "name":{
            "description":"The  name for the component.",
            "type":"string"
        },
        "namespace":{
            "description":"The namespace for the component (e.g. occ.react).",
            "type":"string"
        },
        "hiddenFromSiteStudio":{
            "description":"Is this component hidden from the site.",
            "type":"boolean"
        },
        "id":{
            "description":"The component's repository ID.",
            "type":"string"
        },
        "source":{
            "description":"Is this component out of the box (100) or uploaded (101).",
            "type":"integer"
        },
        "type":{
            "description":"The type of component.",
            "type":"string"
        }
    }
}

Nested Schema : configuration

Type: object

Configuration settings for the component instance

Nested Schema : layout

Type: object

The layout for the component, if any.

Example Response (application/json)

{
    "layout":null,
    "component":{
        "providesContext":null,
        "requiresContext":null,
        "displayName":"WebContent",
        "root":"/clientApplications/core-commerce-reference-store/components/WebContent",
        "repositoryId":"100739",
        "name":"WebContent",
        "namespace":"occ.react",
        "hiddenFromSiteStudio":false,
        "id":"100739",
        "source":101,
        "type":"component"
    },
    "configuration":{
    },
    "displayName":"New Web Content",
    "repositoryId":"900002",
    "usageCount":0
}

Default Response

The error response.

Body ()

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

Back to Top