listApplicationComponents
get
/ccadmin/v1/applications/{applicationId}/components
List Application Components. Endpoint for getting components belonging to the application.
Request
Supported Media Types
- application/json
Path Parameters
-
applicationId(required): string
The ID of the application.
Query Parameters
-
pageType: string
The page type. If specified the endpoint will list components that support the given page type.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listApplicationComponents_response
Type:
Show Source
object
-
items:
array items
Component
Nested Schema : items
Type:
Show Source
object
-
displayName:
string
The display name for the component.
- hiddenFromSiteStudio: boolean
-
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.
Example Response (application/json)
{
"items":[
{
"providesContext":null,
"requiresContext":null,
"displayName":"AccountTypeSelectorContainer",
"root":"/clientApplications/core-commerce-reference-store/components/ResponsiveContainer",
"repositoryId":"100869",
"name":"AccountTypeSelectorContainer",
"namespace":"occ.react",
"hiddenFromSiteStudio":false,
"id":"100869",
"source":101,
"type":"container"
},
{
"providesContext":null,
"requiresContext":null,
"displayName":"CheckoutLoginContainer",
"root":"/clientApplications/core-commerce-reference-store/components/ResponsiveContainer",
"repositoryId":"100888",
"name":"CheckoutLoginContainer",
"namespace":"occ.react",
"hiddenFromSiteStudio":false,
"id":"100888",
"source":101,
"type":"container"
},
{
"providesContext":null,
"requiresContext":null,
"displayName":"Container",
"root":"/clientApplications/core-commerce-reference-store/components/Container",
"repositoryId":"100714",
"name":"Container",
"namespace":"occ.react",
"hiddenFromSiteStudio":false,
"id":"100714",
"source":101,
"type":"container"
}
]
}
Default Response
The error response.
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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