Version 1.0
Connector Overview: This page documents all 21 actions for the Bluestoneconnector v1.0.
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter attributes by a specific identifier. |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter categories by name. |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Include nested child data when set to a positive integer. |
|
|
(Required) |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Starting category identifier for the scan. |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
Contexts
GET lists currently available publications
/contexts
List all currently available publication contexts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Product Differences
/differences/products
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Relation Differences
/differences/relations
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Type of difference to retrieve (e.g., added, removed, changed). |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
Health
GET Get Health
/health
A Health check for PAPI service.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Products (3)
POST Find Products
/products/list
Find products in PAPI
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Sort by name, number. Examples: sort ascending by number 'number', sort descending by name 'name:desc' |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Filter products by their internal IDs. |
|
|
Filter products by their names. |
|
|
Filter products by their product numbers. |
|
|
Filter products by assigned labels. |
|
|
Filter products by their category assignments. |
|
|
Filter products by their attribute values. |
|
|
Filter products by their related entities. |
|
|
Filter products by their product type. |
|
|
Filter products that are part of specified bundles. |
GET Get Product
/products/{id}
Get the product with given id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Include products from subcategories of the given category when set to true. |
|
|
Filter products by one or more labels. |
|
|
Filter categories by name. |
|
|
Filter products by a specific product number. |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
(Required) |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
Relations
GET Get Relations
/relations
Describe the relations available in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Context header for scoping the request. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
Syncs (2)
GET Retrieves a collection of publish info for given tenant.
/syncs
Retrieve a collection of publish information records for the current tenant, optionally filtered by context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter the publish info collection by a specific context string. |
|
|
Sort by createdAt. Examples: sort descending by createdAt 'createdAt:desc' |
|
|
Filter by publish states passed as comma-separated, capital lettered strings with no whitespaces, ie: 'CLOSED,PUBLISH', or 'CLOSED' |
|
|
Filter by "createdAt" field |
|
|
Number of items to return per page. |
|
|
Page number to retrieve. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieves the information about given PublishInfo environment.
/syncs/{id}
Retrieve detailed information about a specific publish info environment identified by its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) publish id. |
|
|
Accept header for response format negotiation. |
|
|
The response format expected from the API (e.g. application/json). |