delphiDll / Support API / Create Request
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
id: PWideChar;
value: PWideChar;
Subject: PWideChar;
Assignee_id: PWideChar;
Can_be_solved_by_me: PWideChar;
Created_at: PWideChar;
Custom_status_id: PWideChar;
Description: PWideChar;
Due_at: PWideChar;
Followup_source_id: PWideChar;
Group_id: PWideChar;
Id: PWideChar;
Is_public: PWideChar;
Organization_id: PWideChar;
Priority: PWideChar;
Recipient: PWideChar;
Requester_id: PWideChar;
Solved: PWideChar;
Status: PWideChar;
Ticket_form_id: PWideChar;
v_Type: PWideChar;
Updated_at: PWideChar;
v_Url: PWideChar;
Channel: PWideChar;
Est__: Boolean;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequest(http,'POST','https://example.zendesk.com/api/v2/requests');
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "request": {
// "subject": "<string>",
// "assignee_id": "<integer>",
// "can_be_solved_by_me": "<boolean>",
// "collaborator_ids": [
// "<integer>",
// "<integer>"
// ],
// "created_at": "<dateTime>",
// "custom_fields": [
// {
// "id": "<integer>",
// "value": "<string>"
// },
// {
// "id": "<integer>",
// "value": "<string>"
// }
// ],
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": [
// "<integer>",
// "<integer>"
// ],
// "followup_source_id": "<integer>",
// "group_id": "<integer>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "organization_id": "<integer>",
// "priority": "<string>",
// "recipient": "<string>",
// "requester_id": "<integer>",
// "solved": "<boolean>",
// "status": "<string>",
// "ticket_form_id": "<integer>",
// "type": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "est__": false
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Subject := CkJsonObject__stringOf(jResp,'request.subject');
Assignee_id := CkJsonObject__stringOf(jResp,'request.assignee_id');
Can_be_solved_by_me := CkJsonObject__stringOf(jResp,'request.can_be_solved_by_me');
Created_at := CkJsonObject__stringOf(jResp,'request.created_at');
Custom_status_id := CkJsonObject__stringOf(jResp,'request.custom_status_id');
Description := CkJsonObject__stringOf(jResp,'request.description');
Due_at := CkJsonObject__stringOf(jResp,'request.due_at');
Followup_source_id := CkJsonObject__stringOf(jResp,'request.followup_source_id');
Group_id := CkJsonObject__stringOf(jResp,'request.group_id');
Id := CkJsonObject__stringOf(jResp,'request.id');
Is_public := CkJsonObject__stringOf(jResp,'request.is_public');
Organization_id := CkJsonObject__stringOf(jResp,'request.organization_id');
Priority := CkJsonObject__stringOf(jResp,'request.priority');
Recipient := CkJsonObject__stringOf(jResp,'request.recipient');
Requester_id := CkJsonObject__stringOf(jResp,'request.requester_id');
Solved := CkJsonObject__stringOf(jResp,'request.solved');
Status := CkJsonObject__stringOf(jResp,'request.status');
Ticket_form_id := CkJsonObject__stringOf(jResp,'request.ticket_form_id');
v_Type := CkJsonObject__stringOf(jResp,'request.type');
Updated_at := CkJsonObject__stringOf(jResp,'request.updated_at');
v_Url := CkJsonObject__stringOf(jResp,'request.url');
Channel := CkJsonObject__stringOf(jResp,'request.via.channel');
Est__ := CkJsonObject_BoolOf(jResp,'request.via.source.est__');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'request.collaborator_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'request.collaborator_ids[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'request.custom_fields');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'request.custom_fields[i].id');
value := CkJsonObject__stringOf(jResp,'request.custom_fields[i].value');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'request.email_cc_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'request.email_cc_ids[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests
Postman Collection Item JSON
{
"name": "Create Request",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests"
]
},
"description": "Accepts a `request` object that sets one or more properties.\n\n#### Allowed for\n\n* End users\n* Anonymous users (rate limit of 5 requests per hour for [trial accounts](/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development/))\n\n#### Additional properties\n\nIn addition to the writable request properties in the [JSON Format table](#json-format) above, you can set the following properties when creating a request.\n\n| Name | Type | Mandatory | Comment\n| ---------------- | -------| --------- | -------\n| comment | object | yes | Describes the problem, incident, question, or task. See [Request comments](#request-comments)\n| collaborators | array | no | Adds collaborators (cc's) to the request. An email notification is sent to them when the ticket is created. See [Setting collaborators](/documentation/ticketing/managing-tickets/creating-and-managing-requests#setting-collaborators)\n| requester | object | yes* | \\*Required for anonymous requests. Specifies the requester of the anonymous request. See [Creating anonymous requests](/documentation/ticketing/managing-tickets/creating-and-managing-requests#creating-anonymous-requests)\n\n#### Creating follow-up requests\n\nOnce a ticket is closed (as distinct from solved), it can't be reopened. However, you can create a new request that references the closed ticket. To create the follow-up request, include a `via_followup_source_id` property in the `request` object that specifies the closed ticket. The parameter only works with closed tickets. It has no effect with other tickets.\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"request\": {\n \"subject\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"can_be_solved_by_me\": \"<boolean>\",\n \"collaborator_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": [\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n }\n ],\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"followup_source_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"priority\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester_id\": \"<integer>\",\n \"solved\": \"<boolean>\",\n \"status\": \"<string>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"est__\": false\n }\n }\n }\n}"
}
]
}
