Get Query Suggestions V2

POST 
/iam/api/v2/suggestion

Suggest auto completion for RQL and notify whether the current RQL is valid or not

Request

application/json

Body

required

query string

Query to validate

Responses

200

OK

application/json

Schema

Schema

valid boolean

Is query valid

suggestions string[]

Suggestion list

translate boolean

Should translate

needsOffsetUpdate boolean

Should add offset from the query beginning

offset int32

The number of characters of offset from the query beginning

Example (from schema)

{
  "valid": true,
  "suggestions": [
    "AND"
  ],
  "translate": false,
  "needsOffsetUpdate": true,
  "offset": 43
}

400

Bad request

application/json

Schema

Schema

error object
code stringrequired
message stringrequired
target string
details string[]
innerError

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      "string"
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error object
code stringrequired
message stringrequired
target string
details string[]
innerError

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      "string"
    ]
  }
}

403

Forbidden

application/json

Schema

Schema

error object
code stringrequired
message stringrequired
target string
details string[]
innerError

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      "string"
    ]
  }
}

404

Not found

application/json

Schema

Schema

error object
code stringrequired
message stringrequired
target string
details string[]
innerError

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      "string"
    ]
  }
}

429

Throttled

Response Headers

• X-RateLimit-Remaining integer
• X-RateLimit-Requested-Tokens integer
• X-RateLimit-Burst-Capacity integer
• X-RateLimit-Replenish-Rate integer

Loading...