Jump to

• Request
• Response

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.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : assemble_response

Type: object

Show Source

• resultsList(optional): object resultsList
  List of all the results

{
    "properties":{
        "resultsList":{
            "description":"List of all the results",
            "type":"object",
            "properties":{
                "pagingActionTemplate":{
                    "description":"Template of paging action",
                    "type":"object",
                    "properties":{
                        "contentPath":{
                            "description":"Path of the content",
                            "type":"string"
                        },
                        "@class":{
                            "description":"Path of NavigationAction class",
                            "type":"string"
                        },
                        "navigationState":{
                            "description":"Query of navigation which determines the state",
                            "type":"string"
                        },
                        "siteRootPath":{
                            "description":"Site Root path of endeca",
                            "type":"string"
                        },
                        "label":{
                            "description":"Label of action",
                            "type":"string"
                        }
                    }
                },
                "lastRecNum":{
                    "description":"Last record number",
                    "type":"integer"
                },
                "totalNumRecs":{
                    "description":"Total Number of Records in the result set",
                    "type":"integer"
                },
                "firstRecNum":{
                    "description":"First record number",
                    "type":"integer"
                },
                "recsPerPage":{
                    "description":"Number of records per page",
                    "type":"integer"
                }
            }
        }
    }
}

Nested Schema : resultsList

Type: object

List of all the results

Show Source

• firstRecNum(optional): integer
  First record number
• lastRecNum(optional): integer
  Last record number
• pagingActionTemplate(optional): object pagingActionTemplate
  Template of paging action
• recsPerPage(optional): integer
  Number of records per page
• totalNumRecs(optional): integer
  Total Number of Records in the result set

{
    "description":"List of all the results",
    "type":"object",
    "properties":{
        "pagingActionTemplate":{
            "description":"Template of paging action",
            "type":"object",
            "properties":{
                "contentPath":{
                    "description":"Path of the content",
                    "type":"string"
                },
                "@class":{
                    "description":"Path of NavigationAction class",
                    "type":"string"
                },
                "navigationState":{
                    "description":"Query of navigation which determines the state",
                    "type":"string"
                },
                "siteRootPath":{
                    "description":"Site Root path of endeca",
                    "type":"string"
                },
                "label":{
                    "description":"Label of action",
                    "type":"string"
                }
            }
        },
        "lastRecNum":{
            "description":"Last record number",
            "type":"integer"
        },
        "totalNumRecs":{
            "description":"Total Number of Records in the result set",
            "type":"integer"
        },
        "firstRecNum":{
            "description":"First record number",
            "type":"integer"
        },
        "recsPerPage":{
            "description":"Number of records per page",
            "type":"integer"
        }
    }
}

Nested Schema : pagingActionTemplate

Type: object

Template of paging action

Show Source

• @class(optional): string
  Path of NavigationAction class
• contentPath(optional): string
  Path of the content
• label(optional): string
  Label of action
• navigationState(optional): string
  Query of navigation which determines the state
• siteRootPath(optional): string
  Site Root path of endeca

{
    "description":"Template of paging action",
    "type":"object",
    "properties":{
        "contentPath":{
            "description":"Path of the content",
            "type":"string"
        },
        "@class":{
            "description":"Path of NavigationAction class",
            "type":"string"
        },
        "navigationState":{
            "description":"Query of navigation which determines the state",
            "type":"string"
        },
        "siteRootPath":{
            "description":"Site Root path of endeca",
            "type":"string"
        },
        "label":{
            "description":"Label of action",
            "type":"string"
        }
    }
}

Example Response (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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top