Skip to content
Cloud APIs
/
/Facets/
Execute faceted search qu...

Execute faceted search queries
deprecated

Request

  • Performs faceted search operations including term facets, range facets, and statistical facets.
  • Required roles: ''users.datalake.viewers'' or ''users.datalake.editors'' or ''users.datalake.admins''. In addition, users must be a member of data groups to access the data.
Security
bearer
Headers
data-partition-idstringrequired

Desired data partition id

Bodyapplication/jsonrequired
termFacetsArray of objects, [ 0 .. 1 ] items(TermFacetDefinition)
pagedFacetsArray of objects, [ 0 .. 1 ] items(PagedFacetDefinition)
rangeFacetsArray of objects, [ 0 .. 1 ] items(RangeFacetDefinition)
statisticsFacetsArray of objects, [ 0 .. 1 ] items(StatisticsFacetDefinition)
noValueFacetsArray of objects, [ 0 .. 1 ] items(NoValueFacetDefinition)
queryRequestobject(QueryRequest)required
Example:
{
  "kind": "slb-osdu-prod-des-prod-testing:welldb:wellbore:1.0.0",
  "limit": 30,
  "query": "data.Basin:\"Ft. Worth\"",
  "returnedFields": [
    "data.kind"
  ],
  "queryAsOwner": false,
  "offset": 0
}
curl -i -X POST \
  https://as5.api.enterprisedata.slb.com/api/search-extensions/v1alpha/facets \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'data-partition-id: string' \
  -d '{
    "termFacets": [
      {
        "field": "string",
        "asKeyword": true,
        "noValueBucket": "string",
        "limit": 1,
        "subTermFacet": {}
      }
    ],
    "pagedFacets": [
      {
        "field": "string",
        "noValueBucket": "string",
        "cursor": "string",
        "limit": 1
      }
    ],
    "rangeFacets": [
      {
        "field": "string",
        "generateBuckets": 0,
        "buckets": [
          {
            "from": 0,
            "to": 0
          }
        ]
      }
    ],
    "statisticsFacets": [
      {
        "field": "string"
      }
    ],
    "noValueFacets": [
      {
        "field": "string",
        "fieldType": "TEXT"
      }
    ],
    "queryRequest": {
      "kind": "slb-osdu-prod-des-prod-testing:welldb:wellbore:1.0.0",
      "limit": 30,
      "query": "data.Basin:\"Ft. Worth\"",
      "returnedFields": [
        "data.kind"
      ],
      "queryAsOwner": false,
      "offset": 0
    }
  }'

Responses

Success

Bodyapplication/json
termFacetsArray of objects(TermFacet)
pagedFacetsArray of objects(PagedFacet)
rangeFacetsArray of objects(RangeFacet)
statisticsFacetsArray of objects(StatisticsFacet)
noValueFacetsArray of objects(NoValueFacet)
Response
{
  "termFacets": [
    { … }
  ],
  "pagedFacets": [
    { … }
  ],
  "rangeFacets": [
    { … }
  ],
  "statisticsFacets": [
    { … }
  ],
  "noValueFacets": [
    { … }
  ]
}