getProfileContextLists
get
/ccadmin/v1/profileContextLists
Get Profile Context Lists. Get the available profileContextList items. Currently only a single item will be returned.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getProfileContextLists_response
Type:
Show Source
object
-
items(optional):
array items
profileContextLists items
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the profileContextList.
-
profileContexts(optional):
array profileContexts
The ordered list of profileContexts
Nested Schema : items
Type:
Show Source
object
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
The Default priceListGroup for the profileContext.
-
priceListGroupList(optional):
array priceListGroupList
The list of available priceListGroups for the profileContext. Properties other than "id" may be visible.
-
propertyName(optional):
string
The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active. A given property name can only appear once in the profileContexts list.
Nested Schema : defaultPriceListGroup
Type:
object
The Default priceListGroup for the profileContext.
Show Source
-
id(optional):
string
The ID of the default priceListGroup for the profileContext.
Nested Schema : priceListGroupList
Type:
array
The list of available priceListGroups for the profileContext. Properties other than "id" may be visible.
Show Source
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/profileContextLists"
}
],
"autoWrap":true,
"items":[
{
"profileContexts":[
],
"id":"defaultProfileContextList"
}
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
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(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