Object API

Object API

Up until now, single item driven integration scenarios required multiple List API calls followed by substantial effort to assemble the single item entity object from combining the relevant sub-entity information. With Product 360 10.1, a new Service API resource has been added which is capable of returning a single entity item, in a full hierarchical form with all its sub-entities and most importantly: in one single call. The Object API significantly improves the performance in integration scenarios requiring the full data of a single item by leveraging the use of in-memory caches optimized for single item retrieval, as opposed to the return of a large number of items by the List API.
URL pattern
/object/{entity-identifier}/{entity_item}
Method
GET
Media types
application/json, application/xml
Example
/rest/V1.0/object/Article/4711@1 /rest/V1.0/object/Article/'myItem'@'myCatalog'

Permissions

  • The user needs to have the
    READ
    object permission for this API. In case she doesn't, the API returns
    HTTP 403
    (forbidden).
  • The user needs to have the
    READ
    field permission for a field. If she doesn't, the field will not be part of the data element, but no error is returned either granting flexibility in responses.
  • The user needs to have the
    READ
    permission for qualifications (e.g. for language = English). If she doesn't, sub-entities which are qualified for this will not be part of the data element, but no error is returned either granting flexibility in responses.
Note that the initial introduction of the Object API only caters for read use cases. Writing data back into Product 360 using REST methods currently still requires making use of the List API.

0 COMMENTS

We’d like to hear from you!