Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *assetId;
const wchar_t *groupId;
const wchar_t *organizationId;
const wchar_t *version;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "main": "api.raml",
// "apiVersion": "1.0.0",
// "version": "1.0.0",
// "assetId": "publish-project-doc",
// "groupId": "gid1234",
// "classifier": "oas"
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"main",L"api.raml");
CkJsonObjectW_UpdateString(json,L"apiVersion",L"1.0.0");
CkJsonObjectW_UpdateString(json,L"version",L"1.0.0");
CkJsonObjectW_UpdateString(json,L"assetId",L"publish-project-doc");
CkJsonObjectW_UpdateString(json,L"groupId",L"gid1234");
CkJsonObjectW_UpdateString(json,L"classifier",L"oas");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
// Adds the "Authorization: Bearer {{token}}" header.
CkHttpW_putAuthToken(http,L"{{token}}");
CkHttpW_SetRequestHeader(http,L"X-ANYPNT-ORG-ID",L"{{organization_id}}");
CkHttpW_SetRequestHeader(http,L"x-owner-id",L"{{owner_id}}");
resp = CkHttpW_PostJson3(http,L"https://domain.com/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "assetId": "test-publish-doc",
// "groupId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
// "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
// "version": "1.0.0"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
assetId = CkJsonObjectW_stringOf(jResp,L"assetId");
groupId = CkJsonObjectW_stringOf(jResp,L"groupId");
organizationId = CkJsonObjectW_stringOf(jResp,L"organizationId");
version = CkJsonObjectW_stringOf(jResp,L"version");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-H "x-owner-id: {{owner_id}}"
-H "X-ANYPNT-ORG-ID: {{organization_id}}"
-H "Content-Type: application/json"
-H "Authorization: Bearer {{token}}"
-d '{
"main": "api.raml",
"apiVersion": "1.0.0",
"version": "1.0.0",
"assetId": "publish-project-doc",
"groupId": "gid1234",
"classifier": "oas"
}'
https://domain.com/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange
Postman Collection Item JSON
{
"name": "Publish Project to Exchange",
"request": {
"method": "POST",
"header": [
{
"description": "(Required) User's ownerId, which identifies the user performing the operation. \nThis is NOT the username, but an UUID that can be found in the users page by the organization administrator.\n",
"key": "x-owner-id",
"value": "{{owner_id}}"
},
{
"description": "(Required) OrganizationId, which identifies the organization to which perform the operation. \nThis can be found in the organizations page by the organization administrator.\n",
"key": "X-ANYPNT-ORG-ID",
"value": "{{organization_id}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"main\": \"api.raml\",\n \"apiVersion\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"assetId\": \"publish-project-doc\",\n \"groupId\": \"gid1234\",\n \"classifier\": \"oas\"\n}"
},
"url": {
"raw": "{{url}}/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange",
"host": [
"{{url}}"
],
"path": [
"projects",
"{{project_id}}",
"branches",
"{{branch_name}}",
"publish",
"exchange"
]
},
"description": "Publish project to Exchange. As a result, an Exchange asset is created."
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "(Required) User's ownerId, which identifies the user performing the operation. \nThis is NOT the username, but an UUID that can be found in the users page by the organization administrator.\n",
"key": "x-owner-id",
"value": "{{owner_id}}"
},
{
"description": "(Required) OrganizationId, which identifies the organization to which perform the operation. \nThis can be found in the organizations page by the organization administrator.\n",
"key": "X-ANYPNT-ORG-ID",
"value": "{{organization_id}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"main\": \"api.raml\",\n \"apiVersion\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"assetId\": \"publish-project-doc\",\n \"groupId\": \"gid1234\",\n \"classifier\": \"oas\"\n}"
},
"url": {
"raw": "{{url}}/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange",
"host": [
"{{url}}"
],
"path": [
"projects",
"{{project_id}}",
"branches",
"{{branch_name}}",
"publish",
"exchange"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"assetId\": \"test-publish-doc\",\n \"groupId\": \"6a2f41a3-c54c-fce8-32d2-0324e1c32e22\",\n \"organizationId\": \"6a2f41a3-c54c-fce8-32d2-0324e1c32e22\",\n \"version\": \"1.0.0\"\n}"
},
{
"name": "401 - Authorization failed",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "(Required) User's ownerId, which identifies the user performing the operation. \nThis is NOT the username, but an UUID that can be found in the users page by the organization administrator.\n",
"key": "x-owner-id",
"value": "{{owner_id}}"
},
{
"description": "(Required) OrganizationId, which identifies the organization to which perform the operation. \nThis can be found in the organizations page by the organization administrator.\n",
"key": "X-ANYPNT-ORG-ID",
"value": "{{organization_id}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer 00001",
"type": "text",
"description": "Generate error with a invalid token "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"main\": \"api.raml\",\n \"apiVersion\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"assetId\": \"publish-project-doc\",\n \"groupId\": \"gid1234\",\n \"classifier\": \"oas\"\n}"
},
"url": {
"raw": "{{url}}/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange",
"host": [
"{{url}}"
],
"path": [
"projects",
"{{project_id}}",
"branches",
"{{branch_name}}",
"publish",
"exchange"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
