Chilkat Online Tools

Powershell / Support API / Create Sharing Agreement

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

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

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

$resp = $http.QuickRequest("POST","https://example.zendesk.com/api/v2/sharing_agreements")
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "sharing_agreement": {
#     "created_at": "<dateTime>",
#     "id": "<integer>",
#     "name": "<string>",
#     "partner_name": "<string>",
#     "remote_subdomain": "<string>",
#     "status": "<string>",
#     "type": "<string>",
#     "url": "<string>"
#   }
# }

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

$Created_at = $jResp.StringOf("sharing_agreement.created_at")
$Id = $jResp.StringOf("sharing_agreement.id")
$Name = $jResp.StringOf("sharing_agreement.name")
$Partner_name = $jResp.StringOf("sharing_agreement.partner_name")
$Remote_subdomain = $jResp.StringOf("sharing_agreement.remote_subdomain")
$Status = $jResp.StringOf("sharing_agreement.status")
$v_Type = $jResp.StringOf("sharing_agreement.type")
$v_Url = $jResp.StringOf("sharing_agreement.url")

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create Sharing Agreement",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sharing_agreements",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sharing_agreements"
      ]
    },
    "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/sharing_agreements",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sharing_agreements"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sharing_agreement\": {\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"partner_name\": \"<string>\",\n    \"remote_subdomain\": \"<string>\",\n    \"status\": \"<string>\",\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}