Back to Collection Items
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample XML: Generate Code to Create XML
; The following XML is sent in the request body.
; <?xml version="1.0" encoding="utf-8"?>
; <project>
; <name>RR API Creation</name>
; <active type="boolean">true</active>
; <open type="boolean">true</open>
; <description>Random Description comes from intake</description>
; <start-date type="dateTime">2021-11-22T00:00:00-07:00</start-date>
; <enabled-tabs type="array">
; <enabled-tab>contracts</enabled-tab>
; <enabled-tab>quote_requests</enabled-tab>
; <enabled-tab>suppliers</enabled-tab>
; </enabled-tabs>
; <status>draft</status>
; <template-group>
; <id type="integer">1</id>
; <name>Jason Test - Single Task</name>
; </template-group>
; <custom-fields>
; <checkbox type="boolean">false</checkbox>
; <cf15-analytics-test nil="true"/>
; <custom-field-14 nil="true"/>
; <date nil="true"/>
; <projected-headcount nil="true"/>
; <estimated-savings nil="true"/>
; <evycustom-field-11>TESTING</evycustom-field-11>
; <n2 nil="true"/>
; <text-box/>
; <multi-select nil="true"/>
; <custom-attachment nil="true"/>
; <custom-field-8 type="boolean">false</custom-field-8>
; <cfproattachment nil="true"/>
; <start-date1 nil="true"/>
; </custom-fields>
; </project>
;
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "project")
CkXml::ckUpdateChildContent(xml,"name","RR API Creation")
CkXml::ckUpdateAttrAt(xml,"active",1,"type","boolean")
CkXml::ckUpdateChildContent(xml,"active","true")
CkXml::ckUpdateAttrAt(xml,"open",1,"type","boolean")
CkXml::ckUpdateChildContent(xml,"open","true")
CkXml::ckUpdateChildContent(xml,"description","Random Description comes from intake")
CkXml::ckUpdateAttrAt(xml,"start-date",1,"type","dateTime")
CkXml::ckUpdateChildContent(xml,"start-date","2021-11-22T00:00:00-07:00")
CkXml::ckUpdateAttrAt(xml,"enabled-tabs",1,"type","array")
CkXml::ckUpdateChildContent(xml,"enabled-tabs|enabled-tab","contracts")
CkXml::ckUpdateChildContent(xml,"enabled-tabs|enabled-tab[1]","quote_requests")
CkXml::ckUpdateChildContent(xml,"enabled-tabs|enabled-tab[2]","suppliers")
CkXml::ckUpdateChildContent(xml,"status","draft")
CkXml::ckUpdateAttrAt(xml,"template-group|id",1,"type","integer")
CkXml::ckUpdateChildContentInt(xml,"template-group|id",1)
CkXml::ckUpdateChildContent(xml,"template-group|name","Jason Test - Single Task")
CkXml::ckUpdateAttrAt(xml,"custom-fields|checkbox",1,"type","boolean")
CkXml::ckUpdateChildContent(xml,"custom-fields|checkbox","false")
CkXml::ckUpdateAttrAt(xml,"custom-fields|cf15-analytics-test",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|custom-field-14",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|date",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|projected-headcount",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|estimated-savings",1,"nil","true")
CkXml::ckUpdateChildContent(xml,"custom-fields|evycustom-field-11","TESTING")
CkXml::ckUpdateAttrAt(xml,"custom-fields|n2",1,"nil","true")
CkXml::ckUpdateChildContent(xml,"custom-fields|text-box","")
CkXml::ckUpdateAttrAt(xml,"custom-fields|multi-select",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|custom-attachment",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|custom-field-8",1,"type","boolean")
CkXml::ckUpdateChildContent(xml,"custom-fields|custom-field-8","false")
CkXml::ckUpdateAttrAt(xml,"custom-fields|cfproattachment",1,"nil","true")
CkXml::ckUpdateAttrAt(xml,"custom-fields|start-date1",1,"nil","true")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckGetXmlSb(xml,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"POST","{}}]",sbRequestBody,"utf-8","application/xml",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '<project>
<name>RR API Creation</name>
<active type="boolean">true</active>
<open type="boolean">true</open>
<description>Random Description comes from intake</description>
<start-date type="dateTime">2021-11-22T00:00:00-07:00</start-date>
<enabled-tabs type="array">
<enabled-tab>contracts</enabled-tab>
<enabled-tab>quote_requests</enabled-tab>
<enabled-tab>suppliers</enabled-tab>
</enabled-tabs>
<status>draft</status>
<template-group>
<id type="integer">1</id>
<name>Jason Test - Single Task</name>
</template-group>
<custom-fields>
<checkbox type="boolean">false</checkbox>
<cf15-analytics-test nil="true"/>
<custom-field-14 nil="true"/>
<date nil="true"/>
<projected-headcount nil="true"/>
<estimated-savings nil="true"/>
<evycustom-field-11>TESTING</evycustom-field-11>
<n2 nil="true"/>
<text-box></text-box>
<multi-select nil="true"/>
<custom-attachment nil="true"/>
<custom-field-8 type="boolean">false</custom-field-8>
<cfproattachment nil="true"/>
<start-date1 nil="true"/>
</custom-fields>
</project>'
https://domain.com/projects?fields=["id","created_at","updated_at","name","active","open","description","mention-name","start-date","project-id","status",{"template-group": ["id","name"]},{"category": ["id","name","active"]},{"commodities": ["id","name"]},{"created_by": ["id","login","email"]},{"updated_by": ["id","login","email"]},{"custom_fields": {}}]
Postman Collection Item JSON
{
"name": "Create a Project",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "<project>\n <name>RR API Creation</name>\n <active type=\"boolean\">true</active>\n <open type=\"boolean\">true</open>\n <description>Random Description comes from intake</description>\n <start-date type=\"dateTime\">2021-11-22T00:00:00-07:00</start-date>\n <enabled-tabs type=\"array\">\n <enabled-tab>contracts</enabled-tab>\n <enabled-tab>quote_requests</enabled-tab>\n <enabled-tab>suppliers</enabled-tab>\n </enabled-tabs>\n <status>draft</status>\n <template-group>\n <id type=\"integer\">1</id>\n <name>Jason Test - Single Task</name>\n </template-group>\n <custom-fields>\n <checkbox type=\"boolean\">false</checkbox>\n <cf15-analytics-test nil=\"true\"/>\n <custom-field-14 nil=\"true\"/>\n <date nil=\"true\"/>\n <projected-headcount nil=\"true\"/>\n <estimated-savings nil=\"true\"/>\n <evycustom-field-11>TESTING</evycustom-field-11>\n <n2 nil=\"true\"/>\n <text-box></text-box>\n <multi-select nil=\"true\"/>\n <custom-attachment nil=\"true\"/>\n <custom-field-8 type=\"boolean\">false</custom-field-8>\n <cfproattachment nil=\"true\"/>\n <start-date1 nil=\"true\"/>\n </custom-fields>\n</project>",
"options": {
"raw": {
"language": "xml"
}
}
},
"url": {
"raw": "{{URL}}/projects?fields=[\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention-name\",\"start-date\",\"project-id\",\"status\",{\"template-group\": [\"id\",\"name\"]},{\"category\": [\"id\",\"name\",\"active\"]},{\"commodities\": [\"id\",\"name\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]},{\"custom_fields\": {}}]",
"host": [
"{{URL}}"
],
"path": [
"projects"
],
"query": [
{
"key": "fields",
"value": "[\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention-name\",\"start-date\",\"project-id\",\"status\",{\"template-group\": [\"id\",\"name\"]},{\"category\": [\"id\",\"name\",\"active\"]},{\"commodities\": [\"id\",\"name\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]},{\"custom_fields\": {}}]"
}
]
}
},
"response": [
]
}
