Delphi (DLL) / Support API / Get sources by target
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);name := CkJsonObject__stringOf(jResp,'users[i].name');active := CkJsonObject__stringOf(jResp,'users[i].active');alias := CkJsonObject__stringOf(jResp,'users[i].alias');chat_only := CkJsonObject__stringOf(jResp,'users[i].chat_only');created_at := CkJsonObject__stringOf(jResp,'users[i].created_at');custom_role_id := CkJsonObject__stringOf(jResp,'users[i].custom_role_id');default_group_id := CkJsonObject__stringOf(jResp,'users[i].default_group_id');details := CkJsonObject__stringOf(jResp,'users[i].details');email := CkJsonObject__stringOf(jResp,'users[i].email');external_id := CkJsonObject__stringOf(jResp,'users[i].external_id');iana_time_zone := CkJsonObject__stringOf(jResp,'users[i].iana_time_zone');id := CkJsonObject__stringOf(jResp,'users[i].id');last_login_at := CkJsonObject__stringOf(jResp,'users[i].last_login_at');locale := CkJsonObject__stringOf(jResp,'users[i].locale');locale_id := CkJsonObject__stringOf(jResp,'users[i].locale_id');moderator := CkJsonObject__stringOf(jResp,'users[i].moderator');notes := CkJsonObject__stringOf(jResp,'users[i].notes');only_private_comments := CkJsonObject__stringOf(jResp,'users[i].only_private_comments');organization_id := CkJsonObject__stringOf(jResp,'users[i].organization_id');phone := CkJsonObject__stringOf(jResp,'users[i].phone');In1f := CkJsonObject_BoolOf(jResp,'users[i].photo.in1f');Cillumb5 := CkJsonObject_BoolOf(jResp,'users[i].photo.cillumb5');remote_photo_url := CkJsonObject__stringOf(jResp,'users[i].remote_photo_url');report_csv := CkJsonObject__stringOf(jResp,'users[i].report_csv');restricted_agent := CkJsonObject__stringOf(jResp,'users[i].restricted_agent');role := CkJsonObject__stringOf(jResp,'users[i].role');role_type := CkJsonObject__stringOf(jResp,'users[i].role_type');v_shared := CkJsonObject__stringOf(jResp,'users[i].shared');shared_agent := CkJsonObject__stringOf(jResp,'users[i].shared_agent');shared_phone_number := CkJsonObject__stringOf(jResp,'users[i].shared_phone_number');signature := CkJsonObject__stringOf(jResp,'users[i].signature');suspended := CkJsonObject__stringOf(jResp,'users[i].suspended');tags := CkJsonObject__stringOf(jResp,'users[i].tags');ticket_restriction := CkJsonObject__stringOf(jResp,'users[i].ticket_restriction');time_zone := CkJsonObject__stringOf(jResp,'users[i].time_zone');two_factor_auth_enabled := CkJsonObject__stringOf(jResp,'users[i].two_factor_auth_enabled');updated_at := CkJsonObject__stringOf(jResp,'users[i].updated_at');url := CkJsonObject__stringOf(jResp,'users[i].url');Nisi_e := CkJsonObject__stringOf(jResp,'users[i].user_fields.nisi_e');verified := CkJsonObject__stringOf(jResp,'users[i].verified');Ut69 := CkJsonObject_BoolOf(jResp,'users[i].photo.ut69');Magna_4 := CkJsonObject_IntOf(jResp,'users[i].photo.magna_4');Loremcc := CkJsonObject_IntOf(jResp,'users[i].user_fields.Loremcc');Dolore7 := CkJsonObject_BoolOf(jResp,'users[i].user_fields.dolore7');Pariaturf := CkJsonObject__stringOf(jResp,'users[i].user_fields.pariaturf');i := i + 1;
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type
Postman Collection Item JSON
{
"name": "Get sources by target",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type",
"value": "<string>"
},
{
"key": "target_id",
"value": "<integer>"
},
{
"key": "field_id",
"value": "<integer>"
},
{
"key": "source_type",
"value": "<string>"
}
]
},
"description": "Returns a list of source objects whose values are populated with the id of a related target object. For example,\nif you have a lookup field called \"Success Manager\" on a ticket, this endpoint can answer the question,\n\"What tickets (sources) is this user (found by `target_type` and `target_id`)\nassigned as the 'Success Manager' (field referenced by `field_id`)?\"\n\n#### Allowed For\n\n* Agents\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/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type"
},
{
"key": "target_id"
},
{
"key": "field_id"
},
{
"key": "source_type"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"users\": [\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"in1f\": false,\n \"cillumb5\": true\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nisi_e\": \"commodo exercitation consequat\"\n },\n \"verified\": \"<boolean>\"\n },\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"ut69\": true,\n \"magna_4\": -92520384\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"Loremcc\": 52379422,\n \"dolore7\": true,\n \"pariaturf\": \"magna consectet\"\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
