Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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>
--
DECLARE @xml int
-- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT
EXEC sp_OASetProperty @xml, 'Tag', 'project'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'name', 'RR API Creation'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'active', 1, 'type', 'boolean'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'active', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'open', 1, 'type', 'boolean'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'open', 'true'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'description', 'Random Description comes from intake'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'start-date', 1, 'type', 'dateTime'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'start-date', '2021-11-22T00:00:00-07:00'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'enabled-tabs', 1, 'type', 'array'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'enabled-tabs|enabled-tab', 'contracts'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'enabled-tabs|enabled-tab[1]', 'quote_requests'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'enabled-tabs|enabled-tab[2]', 'suppliers'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'status', 'draft'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'template-group|id', 1, 'type', 'integer'
EXEC sp_OAMethod @xml, 'UpdateChildContentInt', NULL, 'template-group|id', 1
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'template-group|name', 'Jason Test - Single Task'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|checkbox', 1, 'type', 'boolean'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'custom-fields|checkbox', 'false'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|cf15-analytics-test', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|custom-field-14', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|date', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|projected-headcount', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|estimated-savings', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'custom-fields|evycustom-field-11', 'TESTING'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|n2', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'custom-fields|text-box', ''
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|multi-select', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|custom-attachment', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|custom-field-8', 1, 'type', 'boolean'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'custom-fields|custom-field-8', 'false'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|cfproattachment', 1, 'nil', 'true'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|start-date1', 1, 'nil', 'true'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @xml, 'GetXmlSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'POST', '{}}]', @sbRequestBody, 'utf-8', 'application/xml', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @xml
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @xml
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
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": [
]
}
