Chilkat Online Tools

Node.js / Support API / Record a new skip for the current user

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/skips");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "skip": {
    //     "created_at": "<dateTime>",
    //     "id": "<integer>",
    //     "reason": "<string>",
    //     "ticket": {
    //       "requester_id": "<integer>",
    //       "allow_attachments": "<boolean>",
    //       "allow_channelback": "<boolean>",
    //       "assignee_email": "<string>",
    //       "assignee_id": "<integer>",
    //       "attribute_value_ids": "<array>",
    //       "brand_id": "<integer>",
    //       "collaborator_ids": "<array>",
    //       "collaborators": [
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         },
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         }
    //       ],
    //       "comment": {},
    //       "created_at": "<dateTime>",
    //       "custom_fields": "<array>",
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": "<array>",
    //       "email_ccs": {},
    //       "external_id": "<string>",
    //       "follower_ids": "<array>",
    //       "followers": {},
    //       "followup_ids": "<array>",
    //       "forum_topic_id": "<integer>",
    //       "from_messaging_channel": "<boolean>",
    //       "group_id": "<integer>",
    //       "has_incidents": "<boolean>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "macro_id": "<integer>",
    //       "macro_ids": "<array>",
    //       "metadata": {},
    //       "organization_id": "<integer>",
    //       "priority": "normal",
    //       "problem_id": "<integer>",
    //       "raw_subject": "<string>",
    //       "recipient": "<string>",
    //       "requester": {},
    //       "safe_update": "<boolean>",
    //       "satisfaction_rating": {
    //         "ut_6f": true,
    //         "sed_fb1": -48186207
    //       },
    //       "sharing_agreement_ids": "<array>",
    //       "status": "pending",
    //       "subject": "<string>",
    //       "submitter_id": "<integer>",
    //       "tags": "<array>",
    //       "ticket_form_id": "<integer>",
    //       "type": "task",
    //       "updated_at": "<dateTime>",
    //       "updated_stamp": "<string>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "officiab": "mollit laborum nulla",
    //           "Duisa4": false,
    //           "ida": -77800757.90579444
    //         }
    //       },
    //       "via_followup_source_id": "<integer>",
    //       "via_id": "<integer>",
    //       "voice_comment": {}
    //     },
    //     "ticket_id": "<integer>",
    //     "updated_at": "<dateTime>",
    //     "user_id": "<integer>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var email;
    var name;

    var Created_at = jResp.StringOf("skip.created_at");
    var Id = jResp.StringOf("skip.id");
    var Reason = jResp.StringOf("skip.reason");
    var Requester_id = jResp.StringOf("skip.ticket.requester_id");
    var Allow_attachments = jResp.StringOf("skip.ticket.allow_attachments");
    var Allow_channelback = jResp.StringOf("skip.ticket.allow_channelback");
    var Assignee_email = jResp.StringOf("skip.ticket.assignee_email");
    var Assignee_id = jResp.StringOf("skip.ticket.assignee_id");
    var Attribute_value_ids = jResp.StringOf("skip.ticket.attribute_value_ids");
    var Brand_id = jResp.StringOf("skip.ticket.brand_id");
    var Collaborator_ids = jResp.StringOf("skip.ticket.collaborator_ids");
    var TicketCreated_at = jResp.StringOf("skip.ticket.created_at");
    var Custom_fields = jResp.StringOf("skip.ticket.custom_fields");
    var Custom_status_id = jResp.StringOf("skip.ticket.custom_status_id");
    var Description = jResp.StringOf("skip.ticket.description");
    var Due_at = jResp.StringOf("skip.ticket.due_at");
    var Email_cc_ids = jResp.StringOf("skip.ticket.email_cc_ids");
    var External_id = jResp.StringOf("skip.ticket.external_id");
    var Follower_ids = jResp.StringOf("skip.ticket.follower_ids");
    var Followup_ids = jResp.StringOf("skip.ticket.followup_ids");
    var Forum_topic_id = jResp.StringOf("skip.ticket.forum_topic_id");
    var From_messaging_channel = jResp.StringOf("skip.ticket.from_messaging_channel");
    var Group_id = jResp.StringOf("skip.ticket.group_id");
    var Has_incidents = jResp.StringOf("skip.ticket.has_incidents");
    var TicketId = jResp.StringOf("skip.ticket.id");
    var Is_public = jResp.StringOf("skip.ticket.is_public");
    var Macro_id = jResp.StringOf("skip.ticket.macro_id");
    var Macro_ids = jResp.StringOf("skip.ticket.macro_ids");
    var Organization_id = jResp.StringOf("skip.ticket.organization_id");
    var Priority = jResp.StringOf("skip.ticket.priority");
    var Problem_id = jResp.StringOf("skip.ticket.problem_id");
    var Raw_subject = jResp.StringOf("skip.ticket.raw_subject");
    var Recipient = jResp.StringOf("skip.ticket.recipient");
    var Safe_update = jResp.StringOf("skip.ticket.safe_update");
    var Ut_6f = jResp.BoolOf("skip.ticket.satisfaction_rating.ut_6f");
    var Sed_fb1 = jResp.IntOf("skip.ticket.satisfaction_rating.sed_fb1");
    var Sharing_agreement_ids = jResp.StringOf("skip.ticket.sharing_agreement_ids");
    var Status = jResp.StringOf("skip.ticket.status");
    var Subject = jResp.StringOf("skip.ticket.subject");
    var Submitter_id = jResp.StringOf("skip.ticket.submitter_id");
    var Tags = jResp.StringOf("skip.ticket.tags");
    var Ticket_form_id = jResp.StringOf("skip.ticket.ticket_form_id");
    var v_Type = jResp.StringOf("skip.ticket.type");
    var Updated_at = jResp.StringOf("skip.ticket.updated_at");
    var Updated_stamp = jResp.StringOf("skip.ticket.updated_stamp");
    var v_Url = jResp.StringOf("skip.ticket.url");
    var Channel = jResp.StringOf("skip.ticket.via.channel");
    var Officiab = jResp.StringOf("skip.ticket.via.source.officiab");
    var Duisa4 = jResp.BoolOf("skip.ticket.via.source.Duisa4");
    var Ida = jResp.StringOf("skip.ticket.via.source.ida");
    var Via_followup_source_id = jResp.StringOf("skip.ticket.via_followup_source_id");
    var Via_id = jResp.StringOf("skip.ticket.via_id");
    var Ticket_id = jResp.StringOf("skip.ticket_id");
    var skipUpdated_at = jResp.StringOf("skip.updated_at");
    var User_id = jResp.StringOf("skip.user_id");
    var i = 0;
    var count_i = jResp.SizeOfArray("skip.ticket.collaborators");
    while (i < count_i) {
        jResp.I = i;
        email = jResp.StringOf("skip.ticket.collaborators[i].email");
        name = jResp.StringOf("skip.ticket.collaborators[i].name");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/skips

Postman Collection Item JSON

{
  "name": "Record a new skip for the current user",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/skips",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "skips"
      ]
    },
    "description": "Record a new ticket skip for the current user.\n\n#### Allowed For\n\n* Agents\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/skips",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "skips"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"skip\": {\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"reason\": \"<string>\",\n    \"ticket\": {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"normal\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"ut_6f\": true,\n        \"sed_fb1\": -48186207\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"pending\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"task\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"officiab\": \"mollit laborum nulla\",\n          \"Duisa4\": false,\n          \"ida\": -77800757.90579444\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    },\n    \"ticket_id\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"user_id\": \"<integer>\"\n  }\n}"
    }
  ]
}