DataFlex / Support API / Create View
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Integer iDuis8
String sUllamco_0
Integer iOfficia_13e
String sIpsum_7
Boolean iIn_a8
Boolean iLaborum_a27
String sEa85c
Integer iOccaecat_04
String sQui82a
Integer iVelit21
String sEx_f
String sExcepteur_92
Integer iCillum4
String sActive
String sLaborum_8
Integer iConsequata
String sCreated_at
String sDefault
String sDescription
Boolean iDeserunt6
String sEu7df
String sUtd70
Boolean iAute_03
Integer iCulpa_5b2
String sId
String sPosition
String sExercitatione1
String sMagna_b_3
String sTitle
String sUpdated_at
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "POST" "https://example.zendesk.com/api/v2/views" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "columns": [
// {
// "Duis8": -59589120,
// "ullamco_0": "Ut nostrud qui elit dolor"
// },
// {
// "officia_13e": -39842370,
// "ipsum_7": "sunt",
// "in_a8": true
// }
// ],
// "groups": [
// {
// "laborum_a27": false
// },
// {
// "ea85c": 69952708.53230786,
// "occaecat_04": 58869893,
// "qui82a": "L"
// }
// ],
// "rows": [
// {
// "velit21": -89119970
// },
// {
// "ex_f": 92255473.59295204,
// "Excepteur_92": "sunt",
// "cillum4": 24641748
// }
// ],
// "view": {
// "active": "<boolean>",
// "conditions": {
// "laborum_8": 404871.0763479173,
// "consequata": -40432952
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "deserunt6": false,
// "eu7df": "veniam",
// "utd70": -40480339.58192083,
// "aute_03": true,
// "culpa_5b2": -78225658
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "exercitatione1": "in",
// "magna_b_3": -90768253.5149942
// },
// "title": "<string>",
// "updated_at": "<dateTime>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "view.active" To sActive
Get ComStringOf Of hoJResp "view.conditions.laborum_8" To sLaborum_8
Get ComIntOf Of hoJResp "view.conditions.consequata" To iConsequata
Get ComStringOf Of hoJResp "view.created_at" To sCreated_at
Get ComStringOf Of hoJResp "view.default" To sDefault
Get ComStringOf Of hoJResp "view.description" To sDescription
Get ComBoolOf Of hoJResp "view.execution.deserunt6" To iDeserunt6
Get ComStringOf Of hoJResp "view.execution.eu7df" To sEu7df
Get ComStringOf Of hoJResp "view.execution.utd70" To sUtd70
Get ComBoolOf Of hoJResp "view.execution.aute_03" To iAute_03
Get ComIntOf Of hoJResp "view.execution.culpa_5b2" To iCulpa_5b2
Get ComStringOf Of hoJResp "view.id" To sId
Get ComStringOf Of hoJResp "view.position" To sPosition
Get ComStringOf Of hoJResp "view.restriction.exercitatione1" To sExercitatione1
Get ComStringOf Of hoJResp "view.restriction.magna_b_3" To sMagna_b_3
Get ComStringOf Of hoJResp "view.title" To sTitle
Get ComStringOf Of hoJResp "view.updated_at" To sUpdated_at
Move 0 To i
Get ComSizeOfArray Of hoJResp "columns" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComIntOf Of hoJResp "columns[i].Duis8" To iDuis8
Get ComStringOf Of hoJResp "columns[i].ullamco_0" To sUllamco_0
Get ComIntOf Of hoJResp "columns[i].officia_13e" To iOfficia_13e
Get ComStringOf Of hoJResp "columns[i].ipsum_7" To sIpsum_7
Get ComBoolOf Of hoJResp "columns[i].in_a8" To iIn_a8
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "groups" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComBoolOf Of hoJResp "groups[i].laborum_a27" To iLaborum_a27
Get ComStringOf Of hoJResp "groups[i].ea85c" To sEa85c
Get ComIntOf Of hoJResp "groups[i].occaecat_04" To iOccaecat_04
Get ComStringOf Of hoJResp "groups[i].qui82a" To sQui82a
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "rows" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComIntOf Of hoJResp "rows[i].velit21" To iVelit21
Get ComStringOf Of hoJResp "rows[i].ex_f" To sEx_f
Get ComStringOf Of hoJResp "rows[i].Excepteur_92" To sExcepteur_92
Get ComIntOf Of hoJResp "rows[i].cillum4" To iCillum4
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views
Postman Collection Item JSON
{
"name": "Create View",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views"
]
},
"description": "#### Allowed For\n\n* Agents\n\n#### JSON Format\n\nThe JSON format consists of one property, a `view` object that lists the values to set when the view is created.\n\n**Note**: The request must include at least one condition in the `all` array that checks one of the following fields: `status`, `type`, `group_id`, `assignee_id`, or `requester_id`.\n\n| Name | Description\n| ----------- | -----------\n| title | Required. The title of the view\n| all | Required. An array of one or more conditions. A ticket must meet all of them to be included in the view. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n| any | An array of one or more conditions. A ticket must meet any of them to be included in the view. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n| description | The description of the view\n| active | Allowed values are true or false. Determines if the view is displayed or not\n| output | An object that specifies the columns to display. Example: `\"output\": {\"columns\": [\"status\", \"description\", \"priority\"]}`. See [View columns](#view-columns)\n| restriction | An object that describes who can access the view. To give all agents access to the view, omit this property\n\nThe `restriction` object has the following properties.\n\n| Name | Comment\n| ---- | -------\n| type | Allowed values are \"Group\" or \"User\"\n| id | The numeric ID of a single group or user\n| ids | The numeric IDs of a single or more groups. Recommended for \"Group\" `type`\n\nIf `type` is \"Group\", the `ids` property is the preferred method of specifying the group id or ids.\n\n#### Example Request Body\n\n```js\n{\n \"view\": {\n \"title\": \"Kelly's tickets\",\n \"raw_title\": \"{{dc.tickets_assigned_to_kelly}}\",\n \"description\": \"Tickets that are assigned to Kelly\",\n \"active\": true,\n \"position\": 3,\n \"restriction\": {\n \"type\": \"User\",\n \"id\": \"213977756\"\n },\n \"all\": [\n {\n \"field\": \"status\",\n \"operator\": \"less_than\",\n \"value\": \"solved\"\n },\n {\n \"field\": \"group_id\",\n \"operator\": \"is\",\n \"value\": \"24000932\"\n },\n {\n \"field\": \"custom_fields_360011872073\",\n \"operator\": \"is\",\n \"value\": \"Canada\"\n },\n ...\n ],\n \"output\": {\n \"columns\": [\"status\", \"requester\", \"assignee\"],\n \"group_by\": \"assignee\",\n \"group_order\": \"desc\",\n \"sort_by\": \"status\",\n \"sort_order\": \"desc\"\n }\n }\n}\n```\n\n#### View columns\n\nThe `output` request parameter lets you specify what columns to include in the view in the agent interface. Example: `\"output\": {\"columns\": [\"status\", \"description\", \"priority\"]}`. The following table lists possible columns for views in the agent UI and the corresponding values in the `columns` array.\n\nFor custom fields, specify the id of the custom field in the `columns` array.\n\nYou can specify a total of 10 columns to a view.\n\n| View column title in UI | Value |\n|---------------------------- | -------------------- |\n| Assigned | `assigned` |\n| Assignee | `assignee` |\n| Due Date | `due_date` |\n| Group | `group` |\n| ID | `nice_id` |\n| Updated | `updated` |\n| Assignee updated | `updated_assignee` |\n| Requester updated | `updated_requester` |\n| Updater | `updated_by_type` |\n| Organization | `organization` |\n| Priority | `priority` |\n| Requested | `created` |\n| Requester | `requester` |\n| Requester language | `locale_id` |\n| Satisfaction | `satisfaction_score` |\n| Solved | `solved` |\n| Status category | `status` |\n| Subject | `description` |\n| Submitter | `submitter` |\n| Ticket form | `ticket_form` |\n| Type | `type` |\n| Brand | `brand` |\n| Ticket status | `custom_status_id` |\n\n#### View sorting\n\nYou can group and sort items in the view by adding items to the `output` parameter:\n\n| Attribute | Description\n|-----------------------------| -----------\n| `group_by`, `sort_by` | Sort or group the tickets by a column in the [View columns](#view-columns) table. The `subject` and `submitter` columns are not supported\n| `group_order`, `sort_order` | Either \"asc\" or \"desc\"\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"columns\": [\n {\n \"Duis8\": -59589120,\n \"ullamco_0\": \"Ut nostrud qui elit dolor\"\n },\n {\n \"officia_13e\": -39842370,\n \"ipsum_7\": \"sunt\",\n \"in_a8\": true\n }\n ],\n \"groups\": [\n {\n \"laborum_a27\": false\n },\n {\n \"ea85c\": 69952708.53230786,\n \"occaecat_04\": 58869893,\n \"qui82a\": \"L\"\n }\n ],\n \"rows\": [\n {\n \"velit21\": -89119970\n },\n {\n \"ex_f\": 92255473.59295204,\n \"Excepteur_92\": \"sunt\",\n \"cillum4\": 24641748\n }\n ],\n \"view\": {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"laborum_8\": 404871.0763479173,\n \"consequata\": -40432952\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"deserunt6\": false,\n \"eu7df\": \"veniam\",\n \"utd70\": -40480339.58192083,\n \"aute_03\": true,\n \"culpa_5b2\": -78225658\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"exercitatione1\": \"in\",\n \"magna_b_3\": -90768253.5149942\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n}"
}
]
}
