1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Data Admin

getAdminData

get

/ccadmin/v1/dataAdmin/{dataKey}

Retrieve a set of data from another source, e.g. external REST service. DataKey determines what source to use, e.g. 'assetId' for CECS Content Items.

Request

Supported Media Types
  • application/json
Path Parameters
dataKey
Type: string
Required: true
The data key of the data to be returned.
Body Parameter
Root Schema : generateDataAdmin_request

Response

Supported Media Types
  • application/json
200 Response
An object is returned that represents the data from the external source. Example is for CECS Content Items.
Body
Root Schema : generateDataAdmin_response
Example application/json

{
    "offset":0,
    "hasMore":false,
    "limit":100,
    "count":100,
    "links":[
        {
            "templated":false,
            "method":"GET",
            "profile":"",
            "rel":"self",
            "mediaType":"",
            "href":"/content/published/api/v1/items?access-token=bee9fc829bef49206c355b8bec37fdaf"
        },
        {
            "templated":false,
            "method":"GET",
            "profile":"",
            "rel":"canonical",
            "mediaType":"",
            "href":"/content/published/api/v1/items?access-token=bee9fc829bef49206c355b8bec37fdaf"
        },
        {
            "templated":false,
            "method":"GET",
            "profile":"",
            "rel":"describedby",
            "mediaType":"application/schema+json",
            "href":"/content/published/api/v1/metadata-catalog/items"
        },
        {
            "templated":false,
            "method":"",
            "profile":"",
            "rel":"first",
            "mediaType":"",
            "href":"/content/published/api/v1/items?access-token=bee9fc829bef49206c355b8bec37fdaf&offset=0"
        },
        {
            "templated":false,
            "method":"",
            "profile":"",
            "rel":"last",
            "mediaType":"",
            "href":"/content/published/api/v1/items?access-token=bee9fc829bef49206c355b8bec37fdaf&offset=0"
        },
        {
            "rel":"self",
            "href":"/ccadminui/v1/dataAdmin/assetId"
        },
        {
            "rel":"next",
            "href":"/ccadminui/v1/dataAdmin/assetId?offset=100&limit=100"
        }
    ],
    "items":[
        {
            "link":{
                "templated":false,
                "method":"GET",
                "profile":"",
                "rel":"Reference",
                "mediaType":"",
                "href":"/content/published/api/v1/items/Blog_core_efc3219b-58e6-46bd-9689-0b966cac1a69"
            },
            "name":"Our Pastries",
            "description":"Get the perfect pastries to go with your prefect coffee",
            "id":"Blog_core_efc3219b-58e6-46bd-9689-0b966cac1a69",
            "type":"Blog"
        },
        {
            "link":{
                "templated":false,
                "method":"GET",
                "profile":"",
                "rel":"Reference",
                "mediaType":"",
                "href":"/content/published/api/v1/items/PressRelease_core_df2cd298-0148-48f7-91f8-41198531258f"
            },
            "name":"Caf?? Supremo Honors Brazilian Coffee Heritage",
            "description":"Caf?? Supremo Honors Brazilian Coffee Heritage with Entry into Brazilia Retail Market and Expanded Support for Farmers",
            "id":"PressRelease_core_df2cd298-0148-48f7-91f8-41198531258f",
            "type":"PressRelease"
        }
    ]
}
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