Bluestoneconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 21 actions for the Bluestoneconnector v1.

Attributes

GET Get Attributes

/attributes

Describe the attributes available in the system.

id - attribute id.

itemsOnPage - items to be displayed on page.

pageNo - page number to display.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

Categories (4)

GET Get Ancestors

/categories/{categoryId}/ancestors

Describe categories associated with given category.

deep - deepness of sub categories to be retrieved. default 10.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Categoryid`	(Required)
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Categories

/categories

Describe the root categories available in the system.

name - category contains a name

itemsOnPage - items to be displayed on page.

pageNo - page number to display.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Category By Id

/categories/{categoryId}

Describe categories associated with given category.

deep - deepness of sub categories to be retrieved. default 10.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Deep`	N/A
`Categoryid`	(Required)
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Scan

/categories/scan

Get paginated flat list of categories: given category and its descendants.
CategoryId is optional, if not provided all catalogs are listed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Categoryid`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

Contexts

GET lists currently available publications

/contexts

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Differences (8)

GET Get Attribute Differences

/differences/attributes

Return a set of differences done during last sync operation.

diffType - filter returned values on difference type.

itemsOnPage - items to be displayed on page.

pageNo - page number to display.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Attribute Differences On Sync Deletes

/differences/sync/{id}/attributes

Return a set of changed attributes with given sync

id - sync id for which differences should be retrieved.

diffType - filter returned values on difference type.

itemsOnPage - amount of items to be retrieved.

pageNo - page number.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get Category Differences

/differences/categories

Return a set of changed categories during last publish

diffType - filter returned values on difference type.

itemsOnPage - amount of items to be retrieved.

pageNo - page number.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Category Differences On Sync Deletes

/differences/sync/{id}/categories

Return a set of differences done with a given sync.

id - sync id for which differences should be retrieved.

itemsOnPage - items to be displayed on page.

pageNo - page number to display.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get Product Differences

/differences/products

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Product Differences On Sync Deletes

/differences/sync/{id}/products

Return a set of changed products with given sync

id - sync id for which differences should be retrieved.

diffType - filter returned values on difference type.

itemsOnPage - amount of items to be retrieved.

pageNo - page number.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get Relation Differences

/differences/relations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Relation Differences On Sync Deletes

/differences/sync/{id}/relations

Return a set of changed relations with given sync

id - sync id for which differences should be retrieved.

diffType - filter returned values on difference type.

itemsOnPage - amount of items to be retrieved.

pageNo - page number.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Difftype`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

Health

GET Get Health

/health

A Health check for PAPI service.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Products (3)

POST Find Products

/products/list

Find products in PAPI

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Sort by name, number. Examples: sort ascending by number 'number', sort descending by name 'name:desc'
`Itemsonpage`	N/A
`Pageno`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Ids`	N/A
`Names`	N/A
`Numbers`	N/A
`Labels`	N/A
`Categories`	N/A
`Attributes`	N/A
`Relations`	N/A
`Producttypes`	N/A
`Bundles`	N/A

GET Get Product

/products/{id}

Get the product with given id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required)
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get Products

/categories/{categoryId}/products

Get a list of products for given category.

subCategories - default false. Set to true provides products for all sub categories.

withLabels - format "label1;label2" a set of labels products should contain.

name - part of the name contained by the product

itemsOnPage - items to be displayed on page.

pageNo - page number to display.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Subcategories`	N/A
`Labels`	N/A
`Name`	N/A
`Number`	N/A
`Itemsonpage`	N/A
`Pageno`	N/A
`Categoryid`	(Required)
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

Relations

GET Get Relations

/relations

Describe the relations available in the system.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Context`	N/A
`Accept`	N/A
`Response Type`	N/A

Syncs (2)

GET Retrieves a collection of publish info for given tenant.

/syncs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Context`	N/A
`Sort`	Sort by createdAt. Examples: sort descending by createdAt 'createdAt:desc'
`Publishstates`	Filter by publish states passed as comma-separated, capital lettered strings with no whitespaces, ie: 'CLOSED,PUBLISH', or 'CLOSED'
`Createdafter`	Filter by "createdAt" field
`Itemsonpage`	N/A
`Pageno`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves the information about given PublishInfo environment.

/syncs/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required) publish id.
`Accept`	N/A
`Response Type`	N/A