Jump to

• Request
• Response

View Available Global Permission Sets

get

/api/restapi/globalPermissions/permissionSets

Send a request to this endpoint to view the global permission sets.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityPermissionSets

Type: object

Title: ApiEntityPermissionSets

Show Source

• customLog: array customLog
  Custom log permission sets.
  Applicable for workspace, project, program, customLogTypeObject retrieve APIs.
• file: array file
  File permission sets.
  Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.
• globalPermissions: array globalPermissions
  Global permission sets.
  Applicable for globalPermissions retrieve API.
• idea: array idea
  Idea permission sets.
  Applicable for workspace, idea retrieve APIs.
• portfolio: array portfolio
  Portfolio permission sets.
  Applicable for workspace, portfolio retrieve APIs.
• program: array program
  Program permission sets.
  Applicable for workspace, program retrieve APIs.
• project: array project
  Project permission sets.
  Applicable for workspace, project retrieve APIs.
• report: array report
  Report permission sets.
  Applicable for workspace, project, program, portfolio, report retrieve APIs.
• workspace: array workspace
  Workspace permission sets.
  Applicable for workspace retrieve API.

{
    "title":"ApiEntityPermissionSets",
    "type":"object",
    "properties":{
        "file":{
            "type":"array",
            "description":"File permission sets. <br>Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspace":{
            "type":"array",
            "description":"Workspace permission sets. <br>Applicable for workspace retrieve API.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "portfolio":{
            "type":"array",
            "description":"Portfolio permission sets. <br>Applicable for workspace, portfolio retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "report":{
            "type":"array",
            "description":"Report permission sets. <br>Applicable for workspace, project, program, portfolio, report retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "globalPermissions":{
            "type":"array",
            "description":"Global permission sets. <br>Applicable for globalPermissions retrieve API.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "customLog":{
            "type":"array",
            "description":"Custom log  permission sets. <br>Applicable for workspace, project, program, customLogTypeObject retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "program":{
            "type":"array",
            "description":"Program permission sets. <br>Applicable for workspace, program retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "idea":{
            "type":"array",
            "description":"Idea permission sets. <br>Applicable for workspace, idea retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "project":{
            "type":"array",
            "description":"Project permission sets. <br>Applicable for workspace, project retrieve APIs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfile",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : customLog

Type: array

Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Custom log  permission sets. <br>Applicable for workspace, project, program, customLogTypeObject retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : file

Type: array

File permission sets.
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"File permission sets. <br>Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : globalPermissions

Type: array

Global permission sets.
Applicable for globalPermissions retrieve API.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Global permission sets. <br>Applicable for globalPermissions retrieve API.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : idea

Type: array

Idea permission sets.
Applicable for workspace, idea retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Idea permission sets. <br>Applicable for workspace, idea retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : portfolio

Type: array

Portfolio permission sets.
Applicable for workspace, portfolio retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Portfolio permission sets. <br>Applicable for workspace, portfolio retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : program

Type: array

Program permission sets.
Applicable for workspace, program retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Program permission sets. <br>Applicable for workspace, program retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : project

Type: array

Project permission sets.
Applicable for workspace, project retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Project permission sets. <br>Applicable for workspace, project retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : report

Type: array

Report permission sets.
Applicable for workspace, project, program, portfolio, report retrieve APIs.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Report permission sets. <br>Applicable for workspace, project, program, portfolio, report retrieve APIs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workspace

Type: array

Workspace permission sets.
Applicable for workspace retrieve API.

Show Source

• Array of: object ApiEntityProfile
  Title: ApiEntityProfile

{
    "type":"array",
    "description":"Workspace permission sets. <br>Applicable for workspace retrieve API.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfile",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProfile

Type: object

Title: ApiEntityProfile

Show Source

• description: string
  Maximum Length: 4000

  Description.
• profileId: string
  Maximum Length: 255

  Profile ID.
• profileName: string
  Maximum Length: 255

  Profile Name.

{
    "title":"ApiEntityProfile",
    "type":"object",
    "properties":{
        "description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "profileId":{
            "maxLength":255,
            "type":"string",
            "description":"Profile ID.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "profileName":{
            "maxLength":255,
            "type":"string",
            "description":"Profile Name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

Back to Top