Please enable JavaScript to view this site.

Made in EU
JIRA Service Desk Forums

Navigation: Schema: Service > Tables

RequestCommentAttachments: JIRA Service Desk Request Comment Attachments

Catalog: JIRA

Schema: Service

Primary Keys: id

Label: Request Comment Attachments

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?expand=requestType,serviceDesk,action,comment,attachment

Insert JIRA Service Desk API URL: /request?expand=requestType,serviceDesk,action,comment,attachment

Update JIRA Service Desk API URL: /request?expand=requestType,serviceDesk,action,comment,attachment

Delete JIRA Service Desk API URL: /request?expand=requestType,serviceDesk,action,comment,attachment

Field Selection Method: NotRequired

Base Path: values[*].comments.value[*].attachments.values[*]

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function RequestCommentAttachments. 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

approvalStatus

string

 

Filters results to customer requests based on their approval status:MY_PENDING_APPROVAL returns customer requests pending the user's approval.MY_HISTORY_APPROVAL returns customer requests where the user was an approver.Note: Valid only when used with requestOwnership = APPROVER.

organizationId

int32

 

Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). Note: Valid only when used with requestOwnership=ORGANIZATION.

requestOwnership

string

 

Filters customer requests using the following values: OWNED_REQUESTS returns customer requests where the user is the creator. PARTICIPATED_REQUESTS returns customer requests where the user is a participant. ORGANIZATION returns customer requests for an organization of which the user is a member when used in conjunction with organizationId. ALL_ORGANIZATIONS returns customer requests that belong to all organizations of which the user is a member. APPROVER returns customer requests where the user is an approver. Can be used in conjunction with approvalStatus to filter pending or complete approvals.

requestStatus

string

 

Filters customer requests where the request is closed, open, or either of the two where: CLOSED_REQUESTS returns customer requests that are closed. OPEN_REQUESTS returns customer requests that are open. ALL_REQUESTS returns all customer requests.

requestTypeId

int32

 

Filters customer requests by request type. Note that the serviceDeskId must be specified for the service desk in which the request type belongs.

searchTerm

string

 

Filters customer requests where the request summary matches the searchTerm. Wildcards can be used in the searchTerm parameter.

serviceDeskId

int32

 

Filters customer requests by service desk.

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

author_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.

author_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

author_active

boolean

 

Indicates whether the user is active.

author_displayName

string

 

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

author_emailAddress

string

 

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

author_key

string

 

This property is no longer available and will be removed from the documentation soon

author_locale

string

 

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

author_name

string

 

This property is no longer available and will be removed from the documentation soon.

author_timeZone

string

 

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

comment_author_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.

comment_author_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

comment_author_active

boolean

 

Indicates whether the user is active.

comment_author_displayName

string

 

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

comment_author_emailAddress

string

 

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

comment_author_key

string

 

This property is no longer available and will be removed from the documentation soon

comment_author_locale

string

 

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

comment_author_name

string

 

This property is no longer available and will be removed from the documentation soon.

comment_author_timeZone

string

 

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

comment_body

string

 

Content of the comment.

comment_created

datetime

 

Date the attachment was added.

comment_id

string

 

ID of the comment.

comment_public

boolean

 

Indicates whether the comment is public (true) or private/internal (false).

comment_renderedBody_html

string

 

HTML representation.

created

datetime

 

Date the attachment was added.

filename

string

 

Filename of the item attached.

mimeType

string

 

MIME type of the attachment.

request_actions_addAttachment_allowed

boolean

 

Indicates whether the user can undertake the action (true) or not (false).

request_actions_addComment_allowed

boolean

 

Indicates whether the user can undertake the action (true) or not (false).

request_actions_addParticipant_allowed

boolean

 

Indicates whether the user can undertake the action (true) or not (false).

request_actions_removeParticipant_allowed

boolean

 

Indicates whether the user can undertake the action (true) or not (false).

request_createdDate

datetime

 

Date on which the request was created.

request_currentStatus_status

string

 

Name of the status condition.

request_currentStatus_statusCategory

string

 

Status category the status belongs to.Valid values: UNDEFINED, NEW, INDETERMINATE, DONE.

request_currentStatus_statusDate

datetime

 

Date on which the status was attained.

request_issueId

string

 

ID of the request, as the peer issue ID.

request_issueKey

string

 

Key of the request, as the peer issue key.

request_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.

request_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

request_reporter_active

boolean

 

Indicates whether the user is active.

request_reporter_displayName

string

 

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

request_reporter_emailAddress

string

 

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

request_reporter_key

string

 

This property is no longer available and will be removed from the documentation soon

request_reporter_locale

string

 

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

request_reporter_name

string

 

This property is no longer available and will be removed from the documentation soon.

request_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.

request_requestType_description

string

 

Description of the request type.

request_requestType_fields_canAddRequestParticipants

boolean

 

Flag indicating if participants can be added to a request (true) or not.

request_requestType_fields_canRaiseOnBehalfOf

boolean

 

Flag indicating if a request can be raised on behalf of another user (true) or not.

request_requestType_helpText

string

 

Help text for the request type.

request_requestType_icon_id

string

 

ID of the request type icon.

request_requestType_id

string

 

ID for the request type.

request_requestType_issueTypeId

string

 

ID of the issue type the request type is based upon.

request_requestType_name

string

 

Short name for the request type.

request_requestType_serviceDeskId

string

 

ID of the service desk the request type belongs to.

request_requestTypeId

string

 

ID of the request type for the request.

request_serviceDesk_id

string

 

ID of the service desk.

request_serviceDesk_projectId

string

 

ID of the peer project for the service desk.

request_serviceDesk_projectKey

string

 

Key of the peer project of the service desk.

request_serviceDesk_projectName

string

 

Name of the project and service desk.

request_serviceDeskId

string

 

ID of the service desk the request belongs to.

size

int64

 

Size of the attachment in bytes.

 

15-06-2022 20:37 Version 22.0.232-PROD+3445

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

  
Disclaimer