PowerBuilder / Support API / Create Item
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Content
string ls_Locale_id
string ls_Active
string ls_Created_at
string ls_Default
string ls_Id
string ls_Outdated
string ls_Updated_at
string ls_Url
string ls_Name
string ls_Default_locale_id
string ls_Created_at
string ls_Id
string ls_Outdated
string ls_Placeholder
string ls_Updated_at
string ls_V_Url
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("POST","https://example.zendesk.com/api/v2/dynamic_content/items")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "item": {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<string>",
// "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
ls_Name = loo_JResp.StringOf("item.name")
ls_Default_locale_id = loo_JResp.StringOf("item.default_locale_id")
ls_Created_at = loo_JResp.StringOf("item.created_at")
ls_Id = loo_JResp.StringOf("item.id")
ls_Outdated = loo_JResp.StringOf("item.outdated")
ls_Placeholder = loo_JResp.StringOf("item.placeholder")
ls_Updated_at = loo_JResp.StringOf("item.updated_at")
ls_V_Url = loo_JResp.StringOf("item.url")
i = 0
li_Count_i = loo_JResp.SizeOfArray("item.variants")
do while i < li_Count_i
loo_JResp.I = i
ls_Content = loo_JResp.StringOf("item.variants[i].content")
ls_Locale_id = loo_JResp.StringOf("item.variants[i].locale_id")
ls_Active = loo_JResp.StringOf("item.variants[i].active")
ls_Created_at = loo_JResp.StringOf("item.variants[i].created_at")
ls_Default = loo_JResp.StringOf("item.variants[i].default")
ls_Id = loo_JResp.StringOf("item.variants[i].id")
ls_Outdated = loo_JResp.StringOf("item.variants[i].outdated")
ls_Updated_at = loo_JResp.StringOf("item.variants[i].updated_at")
ls_Url = loo_JResp.StringOf("item.variants[i].url")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items
Postman Collection Item JSON
{
"name": "Create Item",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items"
]
},
"description": "Create a new content item, with one or more variants in the item's `variants` array. See [Specifying item variants](#specifying-item-variants).\n\nThe `default_locale_id` and variant `locale_id` values must be one of the locales the account has active. You can get the list with the [List Locales](/api-reference/ticketing/account-configuration/locales/#list-locales) endpoint.\n\n#### Allowed For\n\n* Admins, Agents\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/dynamic_content/items",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"item\": {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
