This resource represents issue type properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of entity property.
Returns all the issue type property keys of the issue type.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: READ
read:jira-workread:issue-type.property:jirastring
RequiredReturned if the request is successful.
List of property keys.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issuetype/{issueTypeId}/properties`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"keys": [
{
"key": "issue.support",
"self": "https://your-domain.atlassian.net/rest/api/2/issue/EX-2/properties/issue.support"
}
]
}Returns the key and value of the issue type property.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: READ
read:jira-workread:issue-type.property:jirastring
Requiredstring
RequiredReturned if the request is successful.
An entity property, for more information see Entity properties.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issuetype/{issueTypeId}/properties/{propertyKey}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
{
"key": "issue.support",
"value": {
"system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
"system.support.time": "1m"
}
}Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type.property:jirastring
Requiredstring
RequiredThe value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.
any
Returned if the issue type property is updated.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"number": 5,
"string": "string-value"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetype/{issueTypeId}/properties/{propertyKey}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes the issue type property.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationdelete:issue-type.property:jirastring
Requiredstring
RequiredReturned if the issue type property is deleted.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issuetype/{issueTypeId}/properties/{propertyKey}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: