Python / Support API / Update Resource Collection
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/resource_collections/:resource_collection_id")
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "job_status": {
# "id": "<string>",
# "message": "<string>",
# "progress": "<integer>",
# "results": [
# {
# "id": "<integer>",
# "index": "<integer>"
# },
# {
# "id": "<integer>",
# "index": "<integer>"
# }
# ],
# "status": "<string>",
# "total": "<integer>",
# "url": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id = jResp.stringOf("job_status.id")
Message = jResp.stringOf("job_status.message")
Progress = jResp.stringOf("job_status.progress")
Status = jResp.stringOf("job_status.status")
Total = jResp.stringOf("job_status.total")
v_Url = jResp.stringOf("job_status.url")
i = 0
count_i = jResp.SizeOfArray("job_status.results")
while i < count_i :
jResp.put_I(i)
id = jResp.stringOf("job_status.results[i].id")
index = jResp.stringOf("job_status.results[i].index")
i = i + 1
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/resource_collections/:resource_collection_id
Postman Collection Item JSON
{
"name": "Update Resource Collection",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/resource_collections/:resource_collection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"resource_collections",
":resource_collection_id"
],
"variable": [
{
"key": "resource_collection_id",
"value": "<integer>"
}
]
},
"description": "Updates a resource collection using a provided `payload` object. The `payload` object is specified the same way as the content of a requirements.json file in a Zendesk app. See [Specifying Apps Requirements](/documentation/apps/app-developer-guide/apps_requirements/) in the Zendesk Apps framework docs.\n\nThe response includes a [job\nstatus](/api-reference/ticketing/ticket-management/job_statuses/) for the resource updates.\n\n#### Allowed for\n\n* Admins\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/resource_collections/:resource_collection_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"resource_collections",
":resource_collection_id"
],
"variable": [
{
"key": "resource_collection_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"job_status\": {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}