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"?>
; <task>
; <title>Updatetitle Task for a project</title>
; <description>Learning Tasks update API</description>
; <start-date>2021-11-22T00:00:00-08:00</start-date>
; <percentage>0</percentage>
; <linkable-id>15</linkable-id>
; <linkable-type>Project</linkable-type>
; <linkable>
; <id>15</id>
; </linkable>
; </task>
;
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "task")
CkXml::ckUpdateChildContent(xml,"title","Updatetitle Task for a project")
CkXml::ckUpdateChildContent(xml,"description","Learning Tasks update API")
CkXml::ckUpdateChildContent(xml,"start-date","2021-11-22T00:00:00-08:00")
CkXml::ckUpdateChildContentInt(xml,"percentage",0)
CkXml::ckUpdateChildContentInt(xml,"linkable-id",15)
CkXml::ckUpdateChildContent(xml,"linkable-type","Project")
CkXml::ckUpdateChildContentInt(xml,"linkable|id",15)
; 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,"PUT","[" + Chr(34) + "id" + Chr(34) + "]}]",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 PUT
-H "Authorization: Bearer <access_token>"
-d '<task>
<title>Updatetitle Task for a project</title>
<description>Learning Tasks update API</description>
<start-date>2021-11-22T00:00:00-08:00</start-date>
<percentage>0</percentage>
<linkable-id>15</linkable-id>
<linkable-type>Project</linkable-type>
<linkable>
<id>15</id>
</linkable>
</task>'
https://domain.com/projects/:project_id/tasks/:task_id?fields=["id","created_at","updated_at","title","description","status","owner_id","due_date","start_date","duration","percentage","linkable_type","linkable_id",{ "owner": [ "id"]},{ "resolved_by": [ "id"]},{ "linkable": ["id","created_at","updated_at","name","active","open","description","mention_name","start_date","external_reference_number","end_date","commodity_id","status",{"template_group":["id","name",{"custom_fields": {}}]},{"category": ["id","name",{"custom_fields": {}}]},{"department":["id","name",{"custom_fields": {}}]},{"users": ["id","email",{"custom_fields": {}}]},{"commodity":["id","name",{"custom_fields": {}}]},{"custom_fields": {}}]},{ "created_by": [ "id"]},{ "updated_by": ["id"]}]
Postman Collection Item JSON
{
"name": "Update existing Task",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "<task>\n <title>Updatetitle Task for a project</title>\n <description>Learning Tasks update API</description>\n <start-date>2021-11-22T00:00:00-08:00</start-date>\n <percentage>0</percentage>\n <linkable-id>15</linkable-id>\n <linkable-type>Project</linkable-type>\n <linkable>\n <id>15</id>\n </linkable>\n</task>",
"options": {
"raw": {
"language": "xml"
}
}
},
"url": {
"raw": "{{URL}}/projects/:project_id/tasks/:task_id?fields=[\"id\",\"created_at\",\"updated_at\",\"title\",\"description\",\"status\",\"owner_id\",\"due_date\",\"start_date\",\"duration\",\"percentage\",\"linkable_type\",\"linkable_id\",{ \"owner\": [ \"id\"]},{ \"resolved_by\": [ \"id\"]},{ \"linkable\": [\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention_name\",\"start_date\",\"external_reference_number\",\"end_date\",\"commodity_id\",\"status\",{\"template_group\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"category\": [\"id\",\"name\",{\"custom_fields\": {}}]},{\"department\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"users\": [\"id\",\"email\",{\"custom_fields\": {}}]},{\"commodity\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"custom_fields\": {}}]},{ \"created_by\": [ \"id\"]},{ \"updated_by\": [\"id\"]}]",
"host": [
"{{URL}}"
],
"path": [
"projects",
":project_id",
"tasks",
":task_id"
],
"query": [
{
"key": "fields",
"value": "[\"id\",\"created_at\",\"updated_at\",\"title\",\"description\",\"status\",\"owner_id\",\"due_date\",\"start_date\",\"duration\",\"percentage\",\"linkable_type\",\"linkable_id\",{ \"owner\": [ \"id\"]},{ \"resolved_by\": [ \"id\"]},{ \"linkable\": [\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention_name\",\"start_date\",\"external_reference_number\",\"end_date\",\"commodity_id\",\"status\",{\"template_group\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"category\": [\"id\",\"name\",{\"custom_fields\": {}}]},{\"department\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"users\": [\"id\",\"email\",{\"custom_fields\": {}}]},{\"commodity\":[\"id\",\"name\",{\"custom_fields\": {}}]},{\"custom_fields\": {}}]},{ \"created_by\": [ \"id\"]},{ \"updated_by\": [\"id\"]}]"
}
],
"variable": [
{
"key": "project_id",
"value": "15"
},
{
"key": "task_id",
"value": "845"
}
]
}
},
"response": [
]
}
