SQL Server / Support API / Filter Definitions
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/relationships/definitions/:target_type', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "definitions": {
-- "type": "object",
-- "properties": {
-- "conditions_all": {
-- "type": "array",
-- "items": {
-- "type": "object",
-- "properties": {
-- "group": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "nullable": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "operators": {
-- "type": "array",
-- "items": {
-- "type": "object",
-- "properties": {
-- "terminal": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "title": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "value": {
-- "type": "string",
-- "default": "<string>"
-- }
-- }
-- },
-- "maxItems": 2
-- },
-- "repeatable": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "subject": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "title": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "type": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "values": {
-- "type": "array",
-- "items": {
-- "type": "object",
-- "properties": {
-- "enabled": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "title": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "value": {
-- "type": "string",
-- "default": "<string>"
-- }
-- }
-- },
-- "maxItems": 2
-- }
-- }
-- },
-- "maxItems": 2
-- },
-- "conditions_any": {
-- "type": "array",
-- "items": {
-- "type": "object",
-- "properties": {
-- "group": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "nullable": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "operators": {
-- "type": "array",
-- "items": {
-- "type": "object",
-- "properties": {
-- "terminal": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "title": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "value": {
-- "type": "string",
-- "default": "<string>"
-- }
-- }
-- },
-- "maxItems": 2
-- },
-- "repeatable": {
-- "type": "boolean",
-- "default": "<boolean>"
-- },
-- "subject": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "title": {
-- "type": "string",
-- "default": "<string>"
-- },
-- "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
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'definitions.type'
DECLARE @Conditions_allType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Conditions_allType OUT, 'definitions.properties.conditions_all.type'
DECLARE @ItemsType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ItemsType OUT, 'definitions.properties.conditions_all.items.type'
DECLARE @GroupType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @GroupType OUT, 'definitions.properties.conditions_all.items.properties.group.type'
DECLARE @Default nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Default OUT, 'definitions.properties.conditions_all.items.properties.group.default'
DECLARE @NullableType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @NullableType OUT, 'definitions.properties.conditions_all.items.properties.nullable.type'
DECLARE @NullableDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @NullableDefault OUT, 'definitions.properties.conditions_all.items.properties.nullable.default'
DECLARE @OperatorsType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OperatorsType OUT, 'definitions.properties.conditions_all.items.properties.operators.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemsType OUT, 'definitions.properties.conditions_all.items.properties.operators.items.type'
DECLARE @TerminalType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TerminalType OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type'
DECLARE @TerminalDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TerminalDefault OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default'
DECLARE @TitleType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TitleType OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.title.type'
DECLARE @TitleDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TitleDefault OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.title.default'
DECLARE @ValueType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ValueType OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.value.type'
DECLARE @ValueDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ValueDefault OUT, 'definitions.properties.conditions_all.items.properties.operators.items.properties.value.default'
DECLARE @MaxItems int
EXEC sp_OAMethod @jResp, 'IntOf', @MaxItems OUT, 'definitions.properties.conditions_all.items.properties.operators.maxItems'
DECLARE @RepeatableType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RepeatableType OUT, 'definitions.properties.conditions_all.items.properties.repeatable.type'
DECLARE @RepeatableDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RepeatableDefault OUT, 'definitions.properties.conditions_all.items.properties.repeatable.default'
DECLARE @SubjectType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SubjectType OUT, 'definitions.properties.conditions_all.items.properties.subject.type'
DECLARE @SubjectDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SubjectDefault OUT, 'definitions.properties.conditions_all.items.properties.subject.default'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleType OUT, 'definitions.properties.conditions_all.items.properties.title.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleDefault OUT, 'definitions.properties.conditions_all.items.properties.title.default'
DECLARE @TypeType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TypeType OUT, 'definitions.properties.conditions_all.items.properties.type.type'
DECLARE @TypeDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TypeDefault OUT, 'definitions.properties.conditions_all.items.properties.type.default'
DECLARE @ValuesType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ValuesType OUT, 'definitions.properties.conditions_all.items.properties.values.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemsType OUT, 'definitions.properties.conditions_all.items.properties.values.items.type'
DECLARE @EnabledType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @EnabledType OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type'
DECLARE @EnabledDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @EnabledDefault OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleType OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.title.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleDefault OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.title.default'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueType OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.value.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueDefault OUT, 'definitions.properties.conditions_all.items.properties.values.items.properties.value.default'
DECLARE @ValuesMaxItems int
EXEC sp_OAMethod @jResp, 'IntOf', @ValuesMaxItems OUT, 'definitions.properties.conditions_all.items.properties.values.maxItems'
DECLARE @Conditions_allMaxItems int
EXEC sp_OAMethod @jResp, 'IntOf', @Conditions_allMaxItems OUT, 'definitions.properties.conditions_all.maxItems'
DECLARE @Conditions_anyType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Conditions_anyType OUT, 'definitions.properties.conditions_any.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemsType OUT, 'definitions.properties.conditions_any.items.type'
EXEC sp_OAMethod @jResp, 'StringOf', @GroupType OUT, 'definitions.properties.conditions_any.items.properties.group.type'
DECLARE @GroupDefault nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @GroupDefault OUT, 'definitions.properties.conditions_any.items.properties.group.default'
EXEC sp_OAMethod @jResp, 'StringOf', @NullableType OUT, 'definitions.properties.conditions_any.items.properties.nullable.type'
EXEC sp_OAMethod @jResp, 'StringOf', @NullableDefault OUT, 'definitions.properties.conditions_any.items.properties.nullable.default'
EXEC sp_OAMethod @jResp, 'StringOf', @OperatorsType OUT, 'definitions.properties.conditions_any.items.properties.operators.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ItemsType OUT, 'definitions.properties.conditions_any.items.properties.operators.items.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TerminalType OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TerminalDefault OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleType OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.title.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleDefault OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.title.default'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueType OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.value.type'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueDefault OUT, 'definitions.properties.conditions_any.items.properties.operators.items.properties.value.default'
DECLARE @OperatorsMaxItems int
EXEC sp_OAMethod @jResp, 'IntOf', @OperatorsMaxItems OUT, 'definitions.properties.conditions_any.items.properties.operators.maxItems'
EXEC sp_OAMethod @jResp, 'StringOf', @RepeatableType OUT, 'definitions.properties.conditions_any.items.properties.repeatable.type'
EXEC sp_OAMethod @jResp, 'StringOf', @RepeatableDefault OUT, 'definitions.properties.conditions_any.items.properties.repeatable.default'
EXEC sp_OAMethod @jResp, 'StringOf', @SubjectType OUT, 'definitions.properties.conditions_any.items.properties.subject.type'
EXEC sp_OAMethod @jResp, 'StringOf', @SubjectDefault OUT, 'definitions.properties.conditions_any.items.properties.subject.default'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleType OUT, 'definitions.properties.conditions_any.items.properties.title.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TitleDefault OUT, 'definitions.properties.conditions_any.items.properties.title.default'
EXEC sp_OAMethod @jResp, 'StringOf', @TypeType OUT, 'definitions.properties.conditions_any.items.properties.type.type'
EXEC sp_OAMethod @jResp, 'StringOf', @TypeDefault OUT, 'definitions.properties.conditions_any.items.properties.type.default'
DECLARE @Conditions_anyMaxItems int
EXEC sp_OAMethod @jResp, 'IntOf', @Conditions_anyMaxItems OUT, 'definitions.properties.conditions_any.maxItems'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/relationships/definitions/:target_type
Postman Collection Item JSON
{
"name": "Filter Definitions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/relationships/definitions/:target_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"relationships",
"definitions",
":target_type"
],
"variable": [
{
"key": "target_type",
"value": "<string>"
}
]
},
"description": "Returns filter definitions based on the given target type. Target types\ninclude users (zen:user), tickets (zen:ticket), organizations (zen:organization), or custom objects (zen:custom_object:CUSTOM_OBJECT_KEY).\nThe returned filter definitions are the options that you can use to build a custom field or ticket field's\n`relationship_filter`.\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/relationships/definitions/:target_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"relationships",
"definitions",
":target_type"
],
"variable": [
{
"key": "target_type"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"conditions_all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 }\n },\n \"maxItems\": 2\n },\n \"conditions_any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}
