Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

JIRA Cloud API Data Model

Navigation: Schema: Core > Tables

ProjectRolesByIdOrKey: JIRA Cloud Project Roles by ID or Key

Contents Previous Home Next More

Catalog: JIRA

Schema: Core

Primary Keys: id

Label: Project Roles by ID or Key

This is a read-only table function. The JIRA Cloud API may not support changing the data or the Invantive SQL driver for JIRA Cloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Cloud API.

Select JIRA Cloud API URL: /project/{projectIdOrKey}/roledetails

Insert JIRA Cloud API URL: /project/{projectIdOrKey}/roledetails

Update JIRA Cloud API URL: /project/{projectIdOrKey}/roledetails

Delete JIRA Cloud API URL: /project/{projectIdOrKey}/roledetails

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ProjectRolesByIdOrKey. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

projectIdOrKey

string

 

 

 

Table Function Columns

The columns of the table function ProjectRolesByIdOrKey are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

actors

string

 

The list of users who act in this role.

admin

boolean

 

Whether this role is the admin role for the project.

default

boolean

 

Whether this role is the default role for the project.

description

string

 

The description of the project role.

id

int64

 

The ID of the project role.

name

string

 

The name of the project role.

self

string

 

The URL the project role details.

 

29-09-2021 12:42 Version 20.2.43-PROD+3437