Update Component
Updates a component. Any fields included in the request are overwritten. If leadAccountId
is an empty string ("") the component lead is removed.
This operation can be accessed anonymously.
Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
External Documentation
To learn more, visit the Jira documentation.
Parameters
Parameter | Description |
---|---|
Assignee Type | The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.UNASSIGNED an assignee is not set for issues created with this component.PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.Default value: PROJECT_DEFAULT .Optional when creating or updating a component. |
Description | The description for the component. Optional when creating or updating a component. |
ID | The ID of the component. Can be obtained via the List Project Components action. |
Lead Account ID | The accountId of the component's lead user.The accountId uniquely identifies the user across all Atlassian products.For example, 5b10ac8d82e05b22cc7d4ef5 . |
Name | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
Example Output
{
"assignee": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": false,
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48"
},
"displayName": "Mia Krystof",
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"assigneeType": "PROJECT_LEAD",
"description": "This is a Jira component",
"id": "10000",
"isAssigneeTypeValid": false,
"lead": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": false,
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48"
},
"displayName": "Mia Krystof",
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"name": "Component 1",
"project": "HSP",
"projectId": 10000,
"realAssignee": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": false,
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48"
},
"displayName": "Mia Krystof",
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"realAssigneeType": "PROJECT_LEAD",
"self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
}
Workflow Library Example
Update Component with Jira and Send Results Via Email