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.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getProfileContextLists_response
- items
-
Type:
arrayitemsAdditional Properties Allowed:profileContextLists items
Nested Schema : items
Nested Schema : items
Type:
object- id
-
Type:
stringID of the profileContextList. - profileContexts
-
Type:
arrayprofileContextsAdditional Properties Allowed:The ordered list of profileContexts
Nested Schema : profileContexts
Nested Schema : items
Type:
object- defaultPriceListGroup
-
Type:
objectdefaultPriceListGroupAdditional Properties Allowed:The Default priceListGroup for the profileContext. - priceListGroupList
-
Type:
arraypriceListGroupListAdditional Properties Allowed:The list of available priceListGroups for the profileContext. Properties other than "id" may be visible. - propertyName
-
Type:
stringThe 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:
objectThe Default priceListGroup for the profileContext.
- id
-
Type:
stringThe ID of the default priceListGroup for the profileContext.
Nested Schema : priceListGroupList
Nested Schema : items
Type:
object- id
-
Type:
stringID of the priceListGroup.
Example application/json
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/profileContextLists"
}
],
"autoWrap":true,
"items":[
{
"profileContexts":[
],
"id":"defaultProfileContextList"
}
]
}
Default Response
The error response
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Response Payload returned by endpoint:
{
"links": [{
"rel": "self",
"href": "http://localhost:9080/ccadmin/v1/profileContextLists"
}],
"autoWrap": true,
"items": [{
"profileContexts": [],
"id": "defaultProfileContextList"
}]
}