Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("subject.type","<string>")
json.UpdateString("subject.identifier","<string>")
json.UpdateString("operation.key","<string>")
json.UpdateString("operation.target","<string>")
json.UpdateString("id","<long>")
json.UpdateNewObject("_links")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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 = jResp.stringOf("subject.type")
Identifier = jResp.stringOf("subject.identifier")
Key = jResp.stringOf("operation.key")
Target = jResp.stringOf("operation.target")
id = jResp.stringOf("id")
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": ""
}
]
}
