Error itgendoc001X
xMsg javascript has not been loaded.
JIRA Service Desk Data ModelCatalog: JIRA
Schema: Service
Primary Keys: id
Label: Request by ID or Key
This is a read-only table function. The JIRA Service Desk API may not support changing the data or the Invantive SQL driver for JIRA Service Desk does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Service Desk API.
Select JIRA Service Desk API URL: /request/{issueIdOrKey}?expand=requestType,serviceDesk,action
Insert JIRA Service Desk API URL: /request/{issueIdOrKey}?expand=requestType,serviceDesk,action
Update JIRA Service Desk API URL: /request/{issueIdOrKey}?expand=requestType,serviceDesk,action
Delete JIRA Service Desk API URL: /request/{issueIdOrKey}?expand=requestType,serviceDesk,action
Field Selection Method: NotRequired
Table Function Parameters
The following parameters can be used to control the behaviour of the table function RequestByIdOrKey. 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 |
|---|---|---|---|---|
issueIdOrKey |
string |
☑ |
|
The ID or key to be retrieved. |
Table Function Columns
The columns of the table function RequestByIdOrKey are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
actions_addAttachment_allowed |
boolean |
|
☐ |
Indicates whether the user can undertake the action (true) or not (false). |
actions_addComment_allowed |
boolean |
|
☐ |
Indicates whether the user can undertake the action (true) or not (false). |
actions_addParticipant_allowed |
boolean |
|
☐ |
Indicates whether the user can undertake the action (true) or not (false). |
actions_removeParticipant_allowed |
boolean |
|
☐ |
Indicates whether the user can undertake the action (true) or not (false). |
createdDate |
datetime |
|
☐ |
Date on which the request was created. |
currentStatus_status |
string |
|
☐ |
Name of the status condition. |
currentStatus_statusCategory |
string |
|
☐ |
Status category the status belongs to.Valid values: UNDEFINED, NEW, INDETERMINATE, DONE. |
currentStatus_statusDate |
datetime |
|
☐ |
Date on which the status was attained. |
issueId |
string |
|
☐ |
ID of the request, as the peer issue ID. |
issueKey |
string |
|
☐ |
Key of the request, as the peer issue key. |
reporter_accountId |
string |
|
☐ |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user. |
reporter_accountType |
string |
|
☐ |
The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk |
reporter_active |
boolean |
|
☐ |
Indicates whether the user is active. |
reporter_displayName |
string |
|
☐ |
The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
reporter_emailAddress |
string |
|
☐ |
The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
reporter_key |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon |
reporter_locale |
string |
|
☐ |
The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
reporter_name |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon. |
reporter_timeZone |
string |
|
☐ |
The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null. |
requestType_description |
string |
|
☐ |
Description of the request type. |
requestType_fields_canAddRequestParticipants |
boolean |
|
☐ |
Flag indicating if participants can be added to a request (true) or not. |
requestType_fields_canRaiseOnBehalfOf |
boolean |
|
☐ |
Flag indicating if a request can be raised on behalf of another user (true) or not. |
requestType_helpText |
string |
|
☐ |
Help text for the request type. |
requestType_icon_id |
string |
|
☐ |
ID of the request type icon. |
requestType_id |
string |
|
☐ |
ID for the request type. |
requestType_issueTypeId |
string |
|
☐ |
ID of the issue type the request type is based upon. |
requestType_name |
string |
|
☐ |
Short name for the request type. |
requestType_serviceDeskId |
string |
|
☐ |
ID of the service desk the request type belongs to. |
requestTypeId |
string |
|
☐ |
ID of the request type for the request. |
serviceDesk_id |
string |
|
☐ |
ID of the service desk. |
serviceDesk_projectId |
string |
|
☐ |
ID of the peer project for the service desk. |
serviceDesk_projectKey |
string |
|
☐ |
Key of the peer project of the service desk. |
serviceDesk_projectName |
string |
|
☐ |
Name of the project and service desk. |
serviceDeskId |
string |
|
☐ |
ID of the service desk the request belongs to. |
29-09-2021 12:46 Version 20.2.43-PROD+3437
