Jump to

• Request
• Response

getComponentHierarchy

get

/ccadmin/v1/components/{componentType}/{component}/hierarchy

Get Component Hierarchy. Gets the component hierarchy of the input component.

Request

Supported Media Types

• application/json

Path Parameters

• component: string
  The component id.
• componentType: string
  The type of component e.g. widget.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getComponentHierarchy_response

Type: object

Show Source

• items(optional): array items
  Component Hierarchy Response

{
    "properties":{
        "items":{
            "description":"Component Hierarchy Response",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The ID of the component that the hierarchy belongs to.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "maxAncestorDepth":{
                                    "description":"The maximum depth of the container instance hierarchy.",
                                    "type":"integer"
                                },
                                "providesContext":{
                                    "description":"The provided context from the container instance hierarchy.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "displayName":{
                                    "description":"The display name of the layout",
                                    "type":"string"
                                },
                                "allAncestors":{
                                    "description":"All the ancestors for the component.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "id":{
                                    "description":"The ID of the layout the component an instance of.",
                                    "type":"string"
                                },
                                "ancestors":{
                                    "description":"The ancestor component ids from the container instance hierarchy.",
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "type":{
                                    "description":"The type of layout.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Component Hierarchy Response

Show Source

• Array of: object items

{
    "description":"Component Hierarchy Response",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The ID of the component that the hierarchy belongs to.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "maxAncestorDepth":{
                            "description":"The maximum depth of the container instance hierarchy.",
                            "type":"integer"
                        },
                        "providesContext":{
                            "description":"The provided context from the container instance hierarchy.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "displayName":{
                            "description":"The display name of the layout",
                            "type":"string"
                        },
                        "allAncestors":{
                            "description":"All the ancestors for the component.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "id":{
                            "description":"The ID of the layout the component an instance of.",
                            "type":"string"
                        },
                        "ancestors":{
                            "description":"The ancestor component ids from the container instance hierarchy.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "type":{
                            "description":"The type of layout.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): array repositoryId
  The ID of the component that the hierarchy belongs to.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The ID of the component that the hierarchy belongs to.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "maxAncestorDepth":{
                        "description":"The maximum depth of the container instance hierarchy.",
                        "type":"integer"
                    },
                    "providesContext":{
                        "description":"The provided context from the container instance hierarchy.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "displayName":{
                        "description":"The display name of the layout",
                        "type":"string"
                    },
                    "allAncestors":{
                        "description":"All the ancestors for the component.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "id":{
                        "description":"The ID of the layout the component an instance of.",
                        "type":"string"
                    },
                    "ancestors":{
                        "description":"The ancestor component ids from the container instance hierarchy.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "type":{
                        "description":"The type of layout.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : repositoryId

Type: array

The ID of the component that the hierarchy belongs to.

Show Source

• Array of: object items

{
    "description":"The ID of the component that the hierarchy belongs to.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "maxAncestorDepth":{
                "description":"The maximum depth of the container instance hierarchy.",
                "type":"integer"
            },
            "providesContext":{
                "description":"The provided context from the container instance hierarchy.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "displayName":{
                "description":"The display name of the layout",
                "type":"string"
            },
            "allAncestors":{
                "description":"All the ancestors for the component.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "id":{
                "description":"The ID of the layout the component an instance of.",
                "type":"string"
            },
            "ancestors":{
                "description":"The ancestor component ids from the container instance hierarchy.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "type":{
                "description":"The type of layout.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• allAncestors(optional): array allAncestors
  All the ancestors for the component.
• ancestors(optional): array ancestors
  The ancestor component ids from the container instance hierarchy.
• displayName(optional): string
  The display name of the layout
• id(optional): string
  The ID of the layout the component an instance of.
• maxAncestorDepth(optional): integer
  The maximum depth of the container instance hierarchy.
• providesContext(optional): array providesContext
  The provided context from the container instance hierarchy.
• type(optional): string
  The type of layout.

{
    "type":"object",
    "properties":{
        "maxAncestorDepth":{
            "description":"The maximum depth of the container instance hierarchy.",
            "type":"integer"
        },
        "providesContext":{
            "description":"The provided context from the container instance hierarchy.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "description":"The display name of the layout",
            "type":"string"
        },
        "allAncestors":{
            "description":"All the ancestors for the component.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "description":"The ID of the layout the component an instance of.",
            "type":"string"
        },
        "ancestors":{
            "description":"The ancestor component ids from the container instance hierarchy.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "description":"The type of layout.",
            "type":"string"
        }
    }
}

Nested Schema : allAncestors

Type: array

All the ancestors for the component.

Show Source

• Array of: string

{
    "description":"All the ancestors for the component.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ancestors

Type: array

The ancestor component ids from the container instance hierarchy.

Show Source

• Array of: string

{
    "description":"The ancestor component ids from the container instance hierarchy.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : providesContext

Type: array

The provided context from the container instance hierarchy.

Show Source

• Array of: string

{
    "description":"The provided context from the container instance hierarchy.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "items":[
        {
            "cancelItemDetailsWidgetInst_v2":[
                {
                    "maxAncestorDepth":0,
                    "providesContext":[
                    ],
                    "displayName":"Order Details Layout",
                    "allAncestors":[
                    ],
                    "id":"orderDetailsPage",
                    "ancestors":[
                    ],
                    "type":"page"
                }
            ],
            "links":[
                {
                    "rel":"self",
                    "href":"http://localhost:9080/ccadmin/v1/components/widget/cancelItemDetails_v2/hierarchy"
                }
            ]
        }
    ]
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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