Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcIdentifier
LOCAL lcKey
LOCAL lcTarget
LOCAL lcId
* 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.
* {
* "subject": {
* "type": "<string>",
* "identifier": "<string>"
* },
* "operation": {
* "key": "<string>",
* "target": "<string>"
* },
* "id": "<long>",
* "_links": {}
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("subject.type","<string>")
loJson.UpdateString("subject.identifier","<string>")
loJson.UpdateString("operation.key","<string>")
loJson.UpdateString("operation.target","<string>")
loJson.UpdateString("id","<long>")
loJson.UpdateNewObject("_links")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission","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)
* {
* "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
lcV_Type = loJResp.StringOf("subject.type")
lcIdentifier = loJResp.StringOf("subject.identifier")
lcKey = loJResp.StringOf("operation.key")
lcTarget = loJResp.StringOf("operation.target")
lcId = loJResp.StringOf("id")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
