Run a query

This request executes a query and return the results in CSV format.

Resource

POST /queries/<OID>/execute

Where OID is the object ID of the query.

Parameters

Name Type Description

Name	Type	Description
`where`	[String]	A comma seperated list with the non-standard query filters. This is a combination of group name + filter name ("<GROUPNAME>.<FILTERNAME>"). The filtername can also have multiple dots ("."), this is handled as one filtername. The groupname and filtername that can be selected can be found in the GET Query response. Some examples: where=dategroup.startdate=2023-08-23 where=phonelinegroup.linename=support where=phonelinegroup.line1.commonName=support where=phonelinegroup.line1.commonName=support,phonelinegroup.line2.commonName=sales where=dategroup.startdate=2023-01-22,dategroup.enddate=2023-04-22
`seperator`	[String]	The column seperator, if nothing set the default seperator ',' will be used
`response_type`	[json\|stream]	if stream is specified then the contents are streamed to the client.

where

[String]

A comma seperated list with the non-standard query filters.

This is a combination of group name + filter name ("<GROUPNAME>.<FILTERNAME>").
The filtername can also have multiple dots ("."), this is handled as one filtername.
The groupname and filtername that can be selected can be found in the GET Query response.

Some examples:
where=dategroup.startdate=2023-08-23 where=phonelinegroup.linename=support where=phonelinegroup.line1.commonName=support where=phonelinegroup.line1.commonName=support,phonelinegroup.line2.commonName=sales where=dategroup.startdate=2023-01-22,dategroup.enddate=2023-04-22

seperator

[String]

The column seperator, if nothing set the default seperator ',' will be used

response_type

[json|stream]

if stream is specified then the contents are streamed to the client.

Payload

None

Response

String Value

Context

Authorization

User

Errors

Common Errors

Example

Request

POST https://xelion.nl/api/v1/master/queries/2313541/execute

Response

{
    "object": {
        "value": "\"ObjectID\",\"name\",\"created\",\"number\"\r\n\"2311687\",\"Developer Trunk\",\"2023-10-13 16:46:48\",\r\n\"2296805\",\"Sander\",\"2022-11-21 12:03:04\",\r\n\"2294858\",\"Arnonn\",\"2022-09-21 15:16:39\",\r\n\"2295422\",\"Sergey\",\"2022-09-22 16:35:53\",\r\n\"2298726\",\"Beheerder Xelion\",\"2022-12-06 14:45:16\",\r\n"
    }
}