This resource represents entitlements, including their details. Use this to manage entitlement details and detail fields.
Returns all entitlement detail fields, including their configuration. You can use the get entitlement
API to get details for a particular entitlement.
Permissions required: Administer Jira global permission.
read:entitlement.detail-field:jira-service-managementThis request has no parameters.
Returns a list of detail fields.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"results": [
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"configuration": {
"position": 1
}
}
]
}Creates an entitlement detail field. You can create up to 50 detail fields.
Permissions required: Administer Jira global permission.
write:entitlement.detail-field:jira-service-managementstring
RequiredDetailFieldType
RequiredReturns the created detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Renames an entitlement detail field and/or changes the available options for SELECT or MULTISELECT fields.
Permissions required: Administer Jira global permission.
write:entitlement.detail-field:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the edited entitlement detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"options": [
"AU",
"EU",
"US"
]
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Deletes an entitlement detail field and all values stored for it for all entitlements. You cannot restore a detail field once it has been deleted.
Permissions required: Administer Jira global permission.
delete:entitlement.detail-field:jira-service-managementstring
RequiredReturns no response if the entitlement detail field is deleted.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>'Returns an entitlement, including its details. You can get entitlements for a customer using the get customer entitlements API,
and get entitlements for an organization using the get organization entitlements API.
Permissions required: Jira Service Management agent.
read:entitlement:jira-service-managementread:entitlement.detail:jira-service-managementstring
RequiredReturns the requested entitlement.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/{entitlementId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
]
}Deletes the specified entitlement along with its detail fields. You cannot restore an entitlement once it has been deleted.
Permissions required: Administer Jira global permission.
delete:entitlement:jira-service-managementstring
RequiredReturns no response if the entitlement is deleted.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/{entitlementId}' \
--header 'Authorization: Bearer <access_token>'Permissions required: Jira Service Management agent.
write:entitlement.detail:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the updated field.
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/entitlement/{entitlementId}/details?fieldName=Tier' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"values": [
"EU"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
]
}Rate this page: