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:
array
itemsAdditional Properties Allowed:profileContextLists items
Nested Schema : items
Nested Schema : items
Type:
object
- id
-
Type:
string
ID of the profileContextList. - profileContexts
-
Type:
array
profileContextsAdditional Properties Allowed:The ordered list of profileContexts
Nested Schema : profileContexts
Nested Schema : items
Type:
object
- defaultPriceListGroup
-
Type:
object
defaultPriceListGroupAdditional Properties Allowed:The Default priceListGroup for the profileContext. - priceListGroupList
-
Type:
array
priceListGroupListAdditional Properties Allowed:The list of available priceListGroups for the profileContext. Properties other than "id" may be visible. - propertyName
-
Type:
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.
- id
-
Type:
string
The ID of the default priceListGroup for the profileContext.
Nested Schema : priceListGroupList
Nested Schema : items
Type:
object
- id
-
Type:
string
ID 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:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The 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" }] }