Error itgendoc001X
xMsg javascript has not been loaded.
JIRA Cloud API Data Model|
ProjectComponentsByIdOrKey: JIRA Cloud Project Components by ID or Key |
Contents Previous Home Next More |
Catalog: JIRA
Schema: Core
Primary Keys: id
Label: Project Components 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}/components
Insert JIRA Cloud API URL: /project/{projectIdOrKey}/components
Update JIRA Cloud API URL: /project/{projectIdOrKey}/components
Delete JIRA Cloud API URL: /project/{projectIdOrKey}/components
Field Selection Method: NotRequired
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ProjectComponentsByIdOrKey. 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 ProjectComponentsByIdOrKey are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
assigneeType |
string |
|
☐ |
The nominal user type used to determine the assignee for issues created with this component. |
description |
string |
|
☐ |
The description for the component. |
id |
string |
|
☐ |
The unique identifier for the component. |
isAssigneeTypeValid |
boolean |
|
☐ |
Indicates whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned. |
lead_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. |
lead_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 |
lead_active |
boolean |
|
☐ |
Indicates whether the user is active. |
lead_displayName |
string |
|
☐ |
The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
lead_emailAddress |
string |
|
☐ |
The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
lead_key |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon |
lead_locale |
string |
|
☐ |
The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
lead_name |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon. |
lead_timeZone |
string |
|
☐ |
The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null. |
name |
string |
|
☐ |
The unique name for the component in the project. |
project |
string |
|
☐ |
The key of the project the component is assigned to. |
projectId |
int64 |
|
☐ |
The ID of the project the component is assigned to. |
realAssignee_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. |
realAssignee_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 |
realAssignee_active |
boolean |
|
☐ |
Indicates whether the user is active. |
realAssignee_displayName |
string |
|
☐ |
The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
realAssignee_emailAddress |
string |
|
☐ |
The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
realAssignee_key |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon |
realAssignee_locale |
string |
|
☐ |
The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
realAssignee_name |
string |
|
☐ |
This property is no longer available and will be removed from the documentation soon. |
realAssignee_timeZone |
string |
|
☐ |
The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null. |
realAssigneeType |
string |
|
☐ |
The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. |
self |
string |
|
☐ |
The URL of the component. |
29-09-2021 12:42 Version 20.2.43-PROD+3437
