Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get By Rid Queries Batch

POST/api/v2/functions/queries/getByRidBatch
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets a list of query types by RID in bulk. By default, this gets the latest version of each query.

Queries are filtered from the response if they don't exist or the requesting token lacks the required permissions.

The maximum batch size for this endpoint is 100.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:functions-read.

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Request body

body
list<GetByRidQueriesBatchRequestElement>
Hide child attributes

Hide child attributes

GetByRidQueriesBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetByRidQueriesBatchResponse
object
Hide child attributes

Hide child attributes

data
list<Query>optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/functions/queries/getByRidBatch?preview=true" \ -d '[{"rid":"ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c","version":"1.2.3"}]'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "data": [ { "output": { "type": "integer" }, "apiName": "myQueryFunction", "displayName": "My Entity", "rid": "ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c", "typeReferences": { "MyTypeReference": { "type": "integer" } }, "parameters": { "price": { "dataType": { "type": "integer" } } }, "version": "1.2.3" } ] }