REST API for Oracle Commerce Cloud December 2017

assemble

get

/ccstore/v1/assembler/assemble

Assemble. Invokes assembler with the service which is given at path query parameter then assemble the service response and return it from the endpoint. Currently, we support only '/typeahead' service path.

Request

Supported Media Types

application/json

Query Parameters

path: Type: string

Required: true

Assembler service path. A Path query parameter can be like path=/typeahead Note: We support only '/typeahead' service in current release.'

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : assemble_response

Properties

resultsList: Type: object resultsList

Additional Properties Allowed:

List of all the results

Nested Schema : resultsList

Type: object

List of all the results

Properties

firstRecNum: Type: integer

First record number
lastRecNum: Type: integer

Last record number
pagingActionTemplate: Type: object pagingActionTemplate

Additional Properties Allowed:

Template of paging action
recsPerPage: Type: integer

Number of records per page
totalNumRecs: Type: integer

Total Number of Records in the result set

Nested Schema : pagingActionTemplate

Type: object

Template of paging action

Properties

@class: Type: string

Path of NavigationAction class
contentPath: Type: string

Path of the content
label: Type: string

Label of action
navigationState: Type: string

Query of navigation which determines the state
siteRootPath: Type: string

Site Root path of endeca

Example application/json


{
    "resultsList":{
        "pagingActionTemplate":{
            "contentPath":"/guidedsearch",
            "@class":"com.endeca.infront.cartridge.model.NavigationAction",
            "navigationState":"?No=%7Boffset%7D&Nr=AND%28product.active%3A1%2Cproduct.priceListPair%3AsalePrices_listPrices%2Cproduct.language%3Aen%29&Nrpp=%7BrecordsPerPage%7D&Ntl=en&Ntt=clo*&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null",
            "siteRootPath":"/services",
            "label":null
        },
        "lastRecNum":3,
        "totalNumRecs":3,
        "sortOptions":[
        ],
        "records":[
            {
                "@class":"com.endeca.infront.cartridge.model.Record",
                "detailsAction":{
                    "contentPath":"/recorddetails",
                    "@class":"com.endeca.infront.cartridge.model.RecordAction",
                    "siteRootPath":"/services",
                    "label":null,
                    "recordState":"?A=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                },
                "records":[
                    {
                        "@class":"com.endeca.infront.cartridge.model.Record",
                        "detailsAction":{
                            "contentPath":"/recorddetails",
                            "@class":"com.endeca.infront.cartridge.model.RecordAction",
                            "siteRootPath":"/services",
                            "label":null,
                            "recordState":"?R=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                        },
                        "records":null,
                        "numRecords":0,
                        "attributes":{
                            "product.repositoryId":[
                                "xprod2005"
                            ],
                            "sku.listPrice":[
                                "99.000000"
                            ],
                            "product.route":[
                                "/elliot-classic-wall-clock/product/xprod2005"
                            ],
                            "product.listPrice":[
                                "99.000000"
                            ],
                            "product.displayName":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryImageTitle":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryImageAltText":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryThumbImageURL":[
                                "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ElliotClassicClock_full.jpg&height=100&width=100"
                            ]
                        }
                    }
                ],
                "numRecords":1,
                "attributes":{
                    "product.repositoryId":[
                        "xprod2005"
                    ],
                    "sku.listPrice":[
                        "99.000000"
                    ],
                    "product.route":[
                        "/elliot-classic-wall-clock/product/xprod2005"
                    ],
                    "sku.maxActivePrice":[
                        "99.000000"
                    ],
                    "product.listPrice":[
                        "99.000000"
                    ],
                    "product.displayName":[
                        "Elliot Classic Wall Clock"
                    ],
                    "product.primaryImageTitle":[
                        "Elliot Classic Wall Clock"
                    ],
                    "product.primaryImageAltText":[
                        "Elliot Classic Wall Clock"
                    ],
                    "sku.minActivePrice":[
                        "99.000000"
                    ],
                    "product.primaryThumbImageURL":[
                        "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ElliotClassicClock_full.jpg&height=100&width=100"
                    ]
                }
            },
            {
                "@class":"com.endeca.infront.cartridge.model.Record",
                "detailsAction":{
                    "contentPath":"/recorddetails",
                    "@class":"com.endeca.infront.cartridge.model.RecordAction",
                    "siteRootPath":"/services",
                    "label":null,
                    "recordState":"?A=sku-xsku2032..xprod2032.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                },
                "records":[
                    {
                        "@class":"com.endeca.infront.cartridge.model.Record",
                        "detailsAction":{
                            "contentPath":"/recorddetails",
                            "@class":"com.endeca.infront.cartridge.model.RecordAction",
                            "siteRootPath":"/services",
                            "label":null,
                            "recordState":"?R=sku-xsku2032..xprod2032.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                        },
                        "records":null,
                        "numRecords":0,
                        "attributes":{
                            "product.repositoryId":[
                                "xprod2032"
                            ],
                            "sku.listPrice":[
                                "49.000000"
                            ],
                            "product.route":[
                                "/paris-clock/product/xprod2032"
                            ],
                            "product.listPrice":[
                                "49.000000"
                            ],
                            "product.displayName":[
                                "Paris Clock"
                            ],
                            "product.primaryImageTitle":[
                                "Paris Clock"
                            ],
                            "product.primaryImageAltText":[
                                "Paris Clock"
                            ],
                            "product.primaryThumbImageURL":[
                                "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ParisClock_full.jpg&height=100&width=100"
                            ]
                        }
                    }
                ],
                "numRecords":1,
                "attributes":{
                    "product.repositoryId":[
                        "xprod2032"
                    ],
                    "sku.listPrice":[
                        "49.000000"
                    ],
                    "product.route":[
                        "/paris-clock/product/xprod2032"
                    ],
                    "sku.maxActivePrice":[
                        "49.000000"
                    ],
                    "product.listPrice":[
                        "49.000000"
                    ],
                    "product.displayName":[
                        "Paris Clock"
                    ],
                    "product.primaryImageTitle":[
                        "Paris Clock"
                    ],
                    "product.primaryImageAltText":[
                        "Paris Clock"
                    ],
                    "sku.minActivePrice":[
                        "49.000000"
                    ],
                    "product.primaryThumbImageURL":[
                        "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ParisClock_full.jpg&height=100&width=100"
                    ]
                }
            },
            {
                "@class":"com.endeca.infront.cartridge.model.Record",
                "detailsAction":{
                    "contentPath":"/recorddetails",
                    "@class":"com.endeca.infront.cartridge.model.RecordAction",
                    "siteRootPath":"/services",
                    "label":null,
                    "recordState":"?A=sku-xsku2011..xprod2011.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                },
                "records":[
                    {
                        "@class":"com.endeca.infront.cartridge.model.Record",
                        "detailsAction":{
                            "contentPath":"/recorddetails",
                            "@class":"com.endeca.infront.cartridge.model.RecordAction",
                            "siteRootPath":"/services",
                            "label":null,
                            "recordState":"?R=sku-xsku2011..xprod2011.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                        },
                        "records":null,
                        "numRecords":0,
                        "attributes":{
                            "product.repositoryId":[
                                "xprod2011"
                            ],
                            "sku.listPrice":[
                                "99.000000"
                            ],
                            "product.route":[
                                "/swiss-detail-clock/product/xprod2011"
                            ],
                            "product.listPrice":[
                                "99.000000"
                            ],
                            "product.displayName":[
                                "Swiss Detail Clock"
                            ],
                            "product.primaryImageTitle":[
                                "Swiss Detail Clock"
                            ],
                            "product.primaryImageAltText":[
                                "Swiss Detail Clock"
                            ],
                            "product.primaryThumbImageURL":[
                                "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_SwissDetailClock_full.jpg&height=100&width=100"
                            ]
                        }
                    }
                ],
                "numRecords":1,
                "attributes":{
                    "product.repositoryId":[
                        "xprod2011"
                    ],
                    "sku.listPrice":[
                        "99.000000"
                    ],
                    "product.route":[
                        "/swiss-detail-clock/product/xprod2011"
                    ],
                    "sku.maxActivePrice":[
                        "99.000000"
                    ],
                    "product.listPrice":[
                        "99.000000"
                    ],
                    "product.displayName":[
                        "Swiss Detail Clock"
                    ],
                    "product.primaryImageTitle":[
                        "Swiss Detail Clock"
                    ],
                    "product.primaryImageAltText":[
                        "Swiss Detail Clock"
                    ],
                    "sku.minActivePrice":[
                        "99.000000"
                    ],
                    "product.primaryThumbImageURL":[
                        "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_SwissDetailClock_full.jpg&height=100&width=100"
                    ]
                }
            }
        ],
        "@type":"ResultsList",
        "firstRecNum":1,
        "precomputedSorts":[
        ],
        "recsPerPage":5
    },
    "endeca:assemblerRequestInformation":{
        "endeca:eneTime":3,
        "endeca:numRecords":3,
        "@type":"AssemblerRequestEvent",
        "endeca:relRankStrategy":"maxfield,static(product.displayName),static(sku.listingOptionIndex)",
        "endeca:requestType":"UNKNOWN",
        "endeca:assemblyStartTimestamp":1.461684699656E12,
        "endeca:sessionId":"8A53C5DBB423BBBCCA3DABF730EE6CE8",
        "endeca:assemblyFinishTimestamp":1.461684699863E12
    },
    "@type":"TypeaheadResponse",
    "atg:currentSiteProductionURL":null
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

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 errors

Additional 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

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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:

{
  "resultsList": {
    "pagingActionTemplate": {
      "contentPath": "/guidedsearch",
      "@class": "com.endeca.infront.cartridge.model.NavigationAction",
      "navigationState": "?No=%7Boffset%7D&Nr=AND%28product.active%3A1%2Cproduct.priceListPair%3AsalePrices_listPrices%2Cproduct.language%3Aen%29&Nrpp=%7BrecordsPerPage%7D&Ntl=en&Ntt=clo*&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null",
      "siteRootPath": "/services",
      "label": null
    },
    "lastRecNum": 3,
    "totalNumRecs": 3,
    "sortOptions": [],
    "records": [
      {
        "@class": "com.endeca.infront.cartridge.model.Record",
        "detailsAction": {
          "contentPath": "/recorddetails",
          "@class": "com.endeca.infront.cartridge.model.RecordAction",
          "siteRootPath": "/services",
          "label": null,
          "recordState": "?A=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
        },
        "records": [{
          "@class": "com.endeca.infront.cartridge.model.Record",
          "detailsAction": {
            "contentPath": "/recorddetails",
            "@class": "com.endeca.infront.cartridge.model.RecordAction",
            "siteRootPath": "/services",
            "label": null,
            "recordState": "?R=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
          },
          "records": null,
          "numRecords": 0,
          "attributes": {
            "product.repositoryId": ["xprod2005"],
            "sku.listPrice": ["99.000000"],
            "product.route": ["/elliot-classic-wall-clock/product/xprod2005"],
            "product.listPrice": ["99.000000"],
            "product.displayName": ["Elliot Classic Wall Clock"],
            "product.primaryImageTitle": ["Elliot Classic Wall Clock"],
            "product.primaryImageAltText": ["Elliot Classic Wall Clock"],
            "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ElliotClassicClock_full.jpg&height=100&width=100"]
          }
        }],
        "numRecords": 1,
        "attributes": {
          "product.repositoryId": ["xprod2005"],
          "sku.listPrice": ["99.000000"],
          "product.route": ["/elliot-classic-wall-clock/product/xprod2005"],
          "sku.maxActivePrice": ["99.000000"],
          "product.listPrice": ["99.000000"],
          "product.displayName": ["Elliot Classic Wall Clock"],
          "product.primaryImageTitle": ["Elliot Classic Wall Clock"],
          "product.primaryImageAltText": ["Elliot Classic Wall Clock"],
          "sku.minActivePrice": ["99.000000"],
          "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ElliotClassicClock_full.jpg&height=100&width=100"]
        }
      },
      {
        "@class": "com.endeca.infront.cartridge.model.Record",
        "detailsAction": {
          "contentPath": "/recorddetails",
          "@class": "com.endeca.infront.cartridge.model.RecordAction",
          "siteRootPath": "/services",
          "label": null,
          "recordState": "?A=sku-xsku2032..xprod2032.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
        },
        "records": [{
          "@class": "com.endeca.infront.cartridge.model.Record",
          "detailsAction": {
            "contentPath": "/recorddetails",
            "@class": "com.endeca.infront.cartridge.model.RecordAction",
            "siteRootPath": "/services",
            "label": null,
            "recordState": "?R=sku-xsku2032..xprod2032.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
          },
          "records": null,
          "numRecords": 0,
          "attributes": {
            "product.repositoryId": ["xprod2032"],
            "sku.listPrice": ["49.000000"],
            "product.route": ["/paris-clock/product/xprod2032"],
            "product.listPrice": ["49.000000"],
            "product.displayName": ["Paris Clock"],
            "product.primaryImageTitle": ["Paris Clock"],
            "product.primaryImageAltText": ["Paris Clock"],
            "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ParisClock_full.jpg&height=100&width=100"]
          }
        }],
        "numRecords": 1,
        "attributes": {
          "product.repositoryId": ["xprod2032"],
          "sku.listPrice": ["49.000000"],
          "product.route": ["/paris-clock/product/xprod2032"],
          "sku.maxActivePrice": ["49.000000"],
          "product.listPrice": ["49.000000"],
          "product.displayName": ["Paris Clock"],
          "product.primaryImageTitle": ["Paris Clock"],
          "product.primaryImageAltText": ["Paris Clock"],
          "sku.minActivePrice": ["49.000000"],
          "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ParisClock_full.jpg&height=100&width=100"]
        }
      },
      {
        "@class": "com.endeca.infront.cartridge.model.Record",
        "detailsAction": {
          "contentPath": "/recorddetails",
          "@class": "com.endeca.infront.cartridge.model.RecordAction",
          "siteRootPath": "/services",
          "label": null,
          "recordState": "?A=sku-xsku2011..xprod2011.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
        },
        "records": [{
          "@class": "com.endeca.infront.cartridge.model.Record",
          "detailsAction": {
            "contentPath": "/recorddetails",
            "@class": "com.endeca.infront.cartridge.model.RecordAction",
            "siteRootPath": "/services",
            "label": null,
            "recordState": "?R=sku-xsku2011..xprod2011.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
          },
          "records": null,
          "numRecords": 0,
          "attributes": {
            "product.repositoryId": ["xprod2011"],
            "sku.listPrice": ["99.000000"],
            "product.route": ["/swiss-detail-clock/product/xprod2011"],
            "product.listPrice": ["99.000000"],
            "product.displayName": ["Swiss Detail Clock"],
            "product.primaryImageTitle": ["Swiss Detail Clock"],
            "product.primaryImageAltText": ["Swiss Detail Clock"],
            "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_SwissDetailClock_full.jpg&height=100&width=100"]
          }
        }],
        "numRecords": 1,
        "attributes": {
          "product.repositoryId": ["xprod2011"],
          "sku.listPrice": ["99.000000"],
          "product.route": ["/swiss-detail-clock/product/xprod2011"],
          "sku.maxActivePrice": ["99.000000"],
          "product.listPrice": ["99.000000"],
          "product.displayName": ["Swiss Detail Clock"],
          "product.primaryImageTitle": ["Swiss Detail Clock"],
          "product.primaryImageAltText": ["Swiss Detail Clock"],
          "sku.minActivePrice": ["99.000000"],
          "product.primaryThumbImageURL": ["/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_SwissDetailClock_full.jpg&height=100&width=100"]
        }
      }
    ],
    "@type": "ResultsList",
    "firstRecNum": 1,
    "precomputedSorts": [],
    "recsPerPage": 5
  },
  "endeca:assemblerRequestInformation": {
    "endeca:eneTime": 3,
    "endeca:numRecords": 3,
    "@type": "AssemblerRequestEvent",
    "endeca:relRankStrategy": "maxfield,static(product.displayName),static(sku.listingOptionIndex)",
    "endeca:requestType": "UNKNOWN",
    "endeca:assemblyStartTimestamp": 1461684699656,
    "endeca:sessionId": "8A53C5DBB423BBBCCA3DABF730EE6CE8",
    "endeca:assemblyFinishTimestamp": 1461684699863
  },
  "@type": "TypeaheadResponse",
  "atg:currentSiteProductionURL": null
}