lianja / Support API / Retrieve Supported Filter Definition Items
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "definitions": {
// "type": "object",
// "properties": {
// "all": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "group": {
// "type": "string",
// "default": "<string>"
// },
// "operators": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// },
// "target": {
// "type": "string",
// "nullable": true,
// "default": "<string>"
// },
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "default": "<string>"
// },
// "values": {
// "type": "object",
// "properties": {
// "list": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "nullable": true,
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// },
// "type": {
// "type": "string",
// "default": "<string>"
// }
// }
// }
// }
// },
// "maxItems": 2
// },
// "any": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "group": {
// "type": "string",
// "default": "<string>"
// },
// "operators": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// },
// "target": {
// "type": "string",
// "nullable": true,
// "default": "<string>"
// },
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "default": "<string>"
// },
// "values": {
// "type": "object",
// "properties": {
// "list": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "title": {
// "type": "string",
// "default": "<string>"
// },
// "value": {
// "type": "string",
// "nullable": true,
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// },
// "type": {
// "type": "string",
// "default": "<string>"
// }
// }
// }
// }
// },
// "maxItems": 2
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcV_Type = loJResp.StringOf("definitions.type")
lcAllType = loJResp.StringOf("definitions.properties.all.type")
lcItemsType = loJResp.StringOf("definitions.properties.all.items.type")
lcGroupType = loJResp.StringOf("definitions.properties.all.items.properties.group.type")
lcDefault = loJResp.StringOf("definitions.properties.all.items.properties.group.default")
lcOperatorsType = loJResp.StringOf("definitions.properties.all.items.properties.operators.type")
lcItemsType = loJResp.StringOf("definitions.properties.all.items.properties.operators.items.type")
lcTitleType = loJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.default")
lnMaxItems = loJResp.IntOf("definitions.properties.all.items.properties.operators.maxItems")
lcTargetType = loJResp.StringOf("definitions.properties.all.items.properties.target.type")
llNullable = loJResp.BoolOf("definitions.properties.all.items.properties.target.nullable")
lcTargetDefault = loJResp.StringOf("definitions.properties.all.items.properties.target.default")
lcTitleType = loJResp.StringOf("definitions.properties.all.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.all.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.all.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.all.items.properties.value.default")
lcValuesType = loJResp.StringOf("definitions.properties.all.items.properties.values.type")
lcListType = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.type")
lcItemsType = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.type")
lcTitleType = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.type")
llValueNullable = loJResp.BoolOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable")
lcValueDefault = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.default")
lnListMaxItems = loJResp.IntOf("definitions.properties.all.items.properties.values.properties.list.maxItems")
lcTypeType = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.type.type")
lcTypeDefault = loJResp.StringOf("definitions.properties.all.items.properties.values.properties.type.default")
lnAllMaxItems = loJResp.IntOf("definitions.properties.all.maxItems")
lcAnyType = loJResp.StringOf("definitions.properties.any.type")
lcItemsType = loJResp.StringOf("definitions.properties.any.items.type")
lcGroupType = loJResp.StringOf("definitions.properties.any.items.properties.group.type")
lcGroupDefault = loJResp.StringOf("definitions.properties.any.items.properties.group.default")
lcOperatorsType = loJResp.StringOf("definitions.properties.any.items.properties.operators.type")
lcItemsType = loJResp.StringOf("definitions.properties.any.items.properties.operators.items.type")
lcTitleType = loJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.default")
lnOperatorsMaxItems = loJResp.IntOf("definitions.properties.any.items.properties.operators.maxItems")
lcTargetType = loJResp.StringOf("definitions.properties.any.items.properties.target.type")
llTargetNullable = loJResp.BoolOf("definitions.properties.any.items.properties.target.nullable")
lcTargetDefault = loJResp.StringOf("definitions.properties.any.items.properties.target.default")
lcTitleType = loJResp.StringOf("definitions.properties.any.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.any.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.any.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.any.items.properties.value.default")
lcValuesType = loJResp.StringOf("definitions.properties.any.items.properties.values.type")
lcListType = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.type")
lcItemsType = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.type")
lcTitleType = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.type")
llValueNullable = loJResp.BoolOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable")
lcValueDefault = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.default")
lnListMaxItems = loJResp.IntOf("definitions.properties.any.items.properties.values.properties.list.maxItems")
lcTypeType = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.type.type")
lcTypeDefault = loJResp.StringOf("definitions.properties.any.items.properties.values.properties.type.default")
lnAnyMaxItems = loJResp.IntOf("definitions.properties.any.maxItems")
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies/definitions
Postman Collection Item JSON
{
"name": "Retrieve Supported Filter Definition Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
"definitions"
]
},
"description": "#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"target\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"object\",\n \"properties\": {\n \"list\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n }\n }\n },\n \"maxItems\": 2\n },\n \"any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"target\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"object\",\n \"properties\": {\n \"list\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}
