Retrieving assets

The ODS API endpoints that are available in the current version are very generic. The “item type” parameter indicates what kind of items that need to be queried on. In our case we want to fetch assets so the item type should be “asset”. So for {type} you need to use the value “asset” when you want to fetch assets.

The {id} parameter depends on the {type}. To fetch assets the {id} value should be an asset id and not a product/colour id. In our system an asset id looks like this “69499550-84a8-4d2f-9b40-a67c00e8fcf3”. The {id} is only needed if you want to retrieve the data for 1 single asset. The value for {id} can be found in the attribute “assetId” in the JSON response of the Search API.

As URL this looks as follows:

https://api.twinbru.com/ods/item-read/v1/api/Search/Asset

https://api.twinbru.com/ods/item-read/v1/api/Items/Asset/69499550-84a8-4d2f-9b40-a67c00e8fcf3

This should already give results in the items API.

When using the Item Search API, a couple of parameters can be added:

• Filter

• Page

• PageSize

• SortAttribute

• SortDirection

• …

To filter on assets, the ODS query language must be used. Filtering supports different operations (equal, not equal, …) and multiple filters can be combined. Basically, every attribute that is returned in the search result, can be used in the search filter. To fetch a certain asset type, U can use the following filter:  assetType.eq.RoomShot

The filter “assetType.eq.Roomshot” can be added in the URL for a GET request and in the body for a POST request. A search can be done with a GET request or a POST request. When using the GET request, all parameters should be provided in the URL as a query string. When using the POST request, all parameters should be defined in the body as JSON text.

The following example assumes that a GET request is used: https://api.twinbru.com/ods/item-read/v1/api/Search/Asset?filter=assetType.eq.roomshot.

The URL used for testing the POST Search Item API is: https://api.twinbru.com/ods/item-read/v1/api/search/asset

An asset in ODS contains limited product data such as a product ID. This attribute is called “salesId” in ODS. Retrieving assets for a specific article can be done via the following URL:  https://api.twinbru.com/ods/item-read/v1/api/Search/Asset?filter=salesId.eq.{id}

The search filter will split up your search term and try to find matches based on parts of the word or the complete word. This means that searching for “thor” should return “author”. The current version of our searching mechanism will only go through textual values from the field “assetName”. In most cases, the asset name contains the colour name so searching on that should work fine. Every field that is returned by the Search API can be used for filtering.  

More product properties that are enabled for filtering:

• Brand

• Collection

• Design

• SalesId

When searching for render assets, the following example properties are enabled for filtering:

• When sofa render

  • SofaStyle

    • Examples: Cabriole, Camelback, Modern, Traditional, …

  • SofaSize

    • Examples: Chaise longue, one seat, sectional, two seat, three seat

  • When curtain

    • CurtainLength

      • Examples: Break, Puddle, Short

    • General render

      • RenderScene

      • RenderView

      • LightSetting

      • WallColour

      • FloorType

      • RoomType

        • Examples: Modern, Traditional, Contemporary

The easiest way to get all available values from the API is by faceting on them with a page size of 0.

Send a POST request to the Search API with following JSON in the request body:

{
    "pageSize": 0,
    "facets": [
        {
            "attribute": "roomType"
        }
    ]
}

This will return all possible values with their count (example result below).

{
  "results": [],
  "facets": [
    {
      "name": "roomType",
      "displayName": "roomType",
      "totalValueCount": 4,
      "values": [
        {
          "key": "residential",
          "displayName": "Residential",
          "value": "Residential",
          "count": 7,
          "countText": "7",
          "sortKey": "Residential"
        },
        {
          "key": "livingroom",
          "displayName": "Livingroom",
          "value": "Livingroom",
          "count": 1,
          "countText": "1",
          "sortKey": "Livingroom"
        },
        {
          "key": "modern",
          "displayName": "Modern",
          "value": "Modern",
          "count": 1,
          "countText": "1",
          "sortKey": "Modern"
        },
        {
          "key": "outdoor",
          "displayName": "Outdoor",
          "value": "Outdoor",
          "count": 1,
          "countText": "1",
          "sortKey": "Outdoor"
        }
      ]
    }
  ],
  "page": 1,
  "totalPageCount": 0,
  "totalItemCount": 85048
}