1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Profile Context List

getProfileContextList

get

/ccadmin/v1/profileContextLists/{id}

Get Profile Context List. Get the specified profileContextList. A profileContextList contains a profileContexts property that specifies the ordered list of available profileContexts.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
ID of the profileContextList.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getProfileContextList_response
Nested Schema : profileContexts
Type: array
The ordered list of profileContexts.
Nested Schema : items
Type: object
Nested Schema : defaultPriceListGroup
Type: object
The Default priceListGroup for the profileContext. Properties other than "id" may be visible.
Nested Schema : priceListGroupList
Type: array
The list of available priceListGroups for the profileContext. Properties other than "id" may be visible.
Nested Schema : items
Type: object
Example application/json

{
    "profileContexts":[
        {
            "priceListGroupList":[
                {
                    "deleted":false,
                    "endDate":null,
                    "displayName":"Default Price Group",
                    "listPriceList":{
                    },
                    "active":true,
                    "salePriceList":{
                    },
                    "currency":{
                        "symbol":null,
                        "displayName":null,
                        "fractionalDigits":null,
                        "currencyCode":null,
                        "numericCode":null
                    },
                    "id":"defaultPriceGroup",
                    "locale":"en_US",
                    "shippingSurchargePriceList":{
                    },
                    "startDate":null
                }
            ],
            "propertyName":"active",
            "defaultPriceListGroup":{
                "deleted":false,
                "endDate":null,
                "displayName":"Default Price Group",
                "listPriceList":{
                },
                "active":true,
                "salePriceList":{
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"defaultPriceGroup",
                "locale":"en_US",
                "shippingSurchargePriceList":{
                },
                "startDate":null
            }
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/profileContextLists/defaultProfileContextList"
        }
    ],
    "id":"defaultProfileContextList"
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "profileContexts": [{
    "priceListGroupList": [{
      "deleted": false,
      "endDate": null,
      "displayName": "Default Price Group",
      "listPriceList": {},
      "active": true,
      "salePriceList": {},
      "currency": {
        "symbol": null,
        "displayName": null,
        "fractionalDigits": null,
        "currencyCode": null,
        "numericCode": null
      },
      "id": "defaultPriceGroup",
      "locale": "en_US",
      "shippingSurchargePriceList": {},
      "startDate": null
    }],
    "propertyName": "active",
    "defaultPriceListGroup": {
      "deleted": false,
      "endDate": null,
      "displayName": "Default Price Group",
      "listPriceList": {},
      "active": true,
      "salePriceList": {},
      "currency": {
        "symbol": "$",
        "displayName": "US Dollar",
        "fractionalDigits": 2,
        "currencyCode": "USD",
        "numericCode": "840"
      },
      "id": "defaultPriceGroup",
      "locale": "en_US",
      "shippingSurchargePriceList": {},
      "startDate": null
    }
  }],
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/profileContextLists/defaultProfileContextList"
  }],
  "id": "defaultProfileContextList"
}