Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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 JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "subject": {
; "type": "<string>",
; "identifier": "<string>"
; },
; "operation": {
; "key": "<string>",
; "target": "<string>"
; },
; "id": "<long>",
; "_links": {}
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"subject.type","<string>")
CkJsonObject::ckUpdateString(json,"subject.identifier","<string>")
CkJsonObject::ckUpdateString(json,"operation.key","<string>")
CkJsonObject::ckUpdateString(json,"operation.target","<string>")
CkJsonObject::ckUpdateString(json,"id","<long>")
CkJsonObject::ckUpdateNewObject(json,"_links")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "subject": {
; "type": "<string>",
; "identifier": "<string>"
; },
; "operation": {
; "key": "<string>",
; "target": "<string>"
; },
; "id": "<long>",
; "_links": {}
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Type.s = CkJsonObject::ckStringOf(jResp,"subject.type")
Identifier.s = CkJsonObject::ckStringOf(jResp,"subject.identifier")
Key.s = CkJsonObject::ckStringOf(jResp,"operation.key")
Target.s = CkJsonObject::ckStringOf(jResp,"operation.target")
id.s = CkJsonObject::ckStringOf(jResp,"id")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-d '{
"subject": {
"type": "<string>",
"identifier": "<string>"
},
"operation": {
"key": "<string>",
"target": "<string>"
},
"id": "<long>",
"_links": {}
}'
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission
Postman Collection Item JSON
{
"name": "Add new permission to space",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey",
"value": "<string>",
"type": "string",
"description": "(Required) The key of the space to be queried for its content."
}
]
},
"description": "Adds new permission to space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space."
},
"response": [
{
"name": "Returned if the requested content is returned.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
{
"name": "Used for various errors. Such as:\n- Permission already exists for the given user or group.\n- 'read space' permission doesn't exist for the given user or group.\n- No group found with the given groupName",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the authentication credentials are incorrect or missing\nfrom the request.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the user isn't authorized.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if any of the following is true:\n- There is no space with the given key.\n- The calling user does not have permission to view the space.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": {\n \"key\": \"<string>\",\n \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/api/space/:spaceKey/permission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"space",
":spaceKey",
"permission"
],
"variable": [
{
"key": "spaceKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
