Chilkat Online Tools

autoit / Support API / Create OLA Policy

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/olas/policies")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "ola_policy": {
;     "title": "<string>",
;     "filter": {
;       "all": [
;         {
;           "field": "<string>",
;           "operator": "<string>",
;           "value": "<string>"
;         },
;         {
;           "field": "<string>",
;           "operator": "<string>",
;           "value": "<string>"
;         }
;       ],
;       "any": [
;         {
;           "field": "<string>",
;           "operator": "<string>",
;           "value": "<string>"
;         },
;         {
;           "field": "<string>",
;           "operator": "<string>",
;           "value": "<string>"
;         }
;       ]
;     },
;     "created_at": "<dateTime>",
;     "description": "<string>",
;     "id": "<integer>",
;     "policy_metrics": [
;       {
;         "business_hours": "<boolean>",
;         "metric": "<string>",
;         "priority": "<string>",
;         "target": "<integer>"
;       },
;       {
;         "business_hours": "<boolean>",
;         "metric": "<string>",
;         "priority": "<string>",
;         "target": "<integer>"
;       }
;     ],
;     "position": "<integer>",
;     "updated_at": "<dateTime>",
;     "url": "<string>"
;   }
; }

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

Local $sField
Local $sOperator
Local $sValue
Local $sBusiness_hours
Local $sMetric
Local $sPriority
Local $sTarget

Local $sTitle = $oJResp.StringOf("ola_policy.title")
Local $sCreated_at = $oJResp.StringOf("ola_policy.created_at")
Local $sDescription = $oJResp.StringOf("ola_policy.description")
Local $sId = $oJResp.StringOf("ola_policy.id")
Local $sPosition = $oJResp.StringOf("ola_policy.position")
Local $sUpdated_at = $oJResp.StringOf("ola_policy.updated_at")
Local $sV_Url = $oJResp.StringOf("ola_policy.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("ola_policy.filter.all")
While $i < $iCount_i
    $oJResp.I = $i
    $sField = $oJResp.StringOf("ola_policy.filter.all[i].field")
    $sOperator = $oJResp.StringOf("ola_policy.filter.all[i].operator")
    $sValue = $oJResp.StringOf("ola_policy.filter.all[i].value")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("ola_policy.filter.any")
While $i < $iCount_i
    $oJResp.I = $i
    $sField = $oJResp.StringOf("ola_policy.filter.any[i].field")
    $sOperator = $oJResp.StringOf("ola_policy.filter.any[i].operator")
    $sValue = $oJResp.StringOf("ola_policy.filter.any[i].value")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("ola_policy.policy_metrics")
While $i < $iCount_i
    $oJResp.I = $i
    $sBusiness_hours = $oJResp.StringOf("ola_policy.policy_metrics[i].business_hours")
    $sMetric = $oJResp.StringOf("ola_policy.policy_metrics[i].metric")
    $sPriority = $oJResp.StringOf("ola_policy.policy_metrics[i].priority")
    $sTarget = $oJResp.StringOf("ola_policy.policy_metrics[i].target")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create OLA Policy",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies"
      ]
    },
    "description": "#### Allowed For\n\n* Admins\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/olas/policies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ola_policy\": {\n    \"title\": \"<string>\",\n    \"filter\": {\n      \"all\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"any\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"policy_metrics\": [\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      },\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      }\n    ],\n    \"position\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}