search

GET /search-api/v1/doc/{tenant}/{id}

Changed on

Request

  • Base URL
    http://search-service
  • URL
    http://search-service/search-api/v1/doc/{tenant}/{id}
  • Auth
    HTTP basic

Path parameters

tenantstring required

tenant name

idstring required

document id

Response

default response

dataobject required

The data property should be used for standard fields, such as title, description, price. Only values of the following types are accepted (others will be dropped silently): Standard primitive types (Boolean, String, Integer, Double) and arrays of these types. Attributes (key-value objects with ID) should be passed to the attributes property.

idstring required

Example response

{
  "attributes": [
    {
      "name": "color",
      "value": "red",
      "code": "ff0000"
    }
  ],
  "categories": [
    [
      {
        "id": "7001",
        "name": "Electronics"
      },
      {
        "id": "7011",
        "name": "Notebooks"
      }
    ],
    [
      {
        "id": "9000",
        "name": "Sale"
      }
    ]
  ]
}

Changes

    • info

      added subschema #13 to the / response property anyOf list for the response status

    • info

      added subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 to the / response property anyOf list for the response status