Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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"
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('main','api.raml');
$json->UpdateString('apiVersion','1.0.0');
$json->UpdateString('version','1.0.0');
$json->UpdateString('assetId','publish-project-doc');
$json->UpdateString('groupId','gid1234');
$json->UpdateString('classifier','oas');
$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer {{token}}" header.
$http->AuthToken = '{{token}}';
$http->SetRequestHeader('X-ANYPNT-ORG-ID','{{organization_id}}');
$http->SetRequestHeader('x-owner-id','{{owner_id}}');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$assetId = $jResp->stringOf('assetId');
$groupId = $jResp->stringOf('groupId');
$organizationId = $jResp->stringOf('organizationId');
$version = $jResp->stringOf('version');
?>
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": ""
}
]
}
