Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAssetId
LOCAL lcGroupId
LOCAL lcOrganizationId
LOCAL lcVersion
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.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"
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("main","api.raml")
loJson.UpdateString("apiVersion","1.0.0")
loJson.UpdateString("version","1.0.0")
loJson.UpdateString("assetId","publish-project-doc")
loJson.UpdateString("groupId","gid1234")
loJson.UpdateString("classifier","oas")
loHttp.SetRequestHeader("Content-Type","application/json")
* Adds the "Authorization: Bearer {{token}}" header.
loHttp.AuthToken = "{{token}}"
loHttp.SetRequestHeader("X-ANYPNT-ORG-ID","{{organization_id}}")
loHttp.SetRequestHeader("x-owner-id","{{owner_id}}")
loResp = loHttp.PostJson3("https://domain.com/projects/{{project_id}}/branches/{{branch_name}}/publish/exchange","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAssetId = loJResp.StringOf("assetId")
lcGroupId = loJResp.StringOf("groupId")
lcOrganizationId = loJResp.StringOf("organizationId")
lcVersion = loJResp.StringOf("version")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
