Update component - JIRA 7.6.1

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/component/' \ --header 'Content-Type: application/json' \ --data-raw '{ "assigneeType": "PROJECT_LEAD", "description": "This is a Jira component", "isAssigneeTypeValid": false, "leadAccountId": "5b10a2844c20165700ede21g", "name": "Component 1" }'

{ "self": "https://your-domain.atlassian.net/rest/api/3/component/10000", "id": "10000", "name": "Component 1", "description": "This is a Jira component", "lead": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "key": "", "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "name": "", "avatarUrls": { "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32" }, "displayName": "Mia Krystof", "active": false }, "assigneeType": "PROJECT_LEAD", "assignee": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "key": "", "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "name": "", "avatarUrls": { "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32" }, "displayName": "Mia Krystof", "active": false }, "realAssigneeType": "PROJECT_LEAD", "realAssignee": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "key": "", "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "name": "", "avatarUrls": { "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32" }, "displayName": "Mia Krystof", "active": false }, "isAssigneeTypeValid": false, "project": "HSP", "projectId": 10000 }

Request

Path Params

string

required

The ID of the component.

Body Params application/json

Details about a project component.

assigneeType

enum<string>

optional

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.

Allowed values:

PROJECT_DEFAULTCOMPONENT_LEADPROJECT_LEADUNASSIGNED

description

string

optional

The description for the component. Optional when creating or updating a component.

leadAccountId

string

write-onlyoptional

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

<= 128 characters

leadUserName

string

optional

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

name

string

optional

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.

project

string

optional

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details about a project component.

assignee

object

read-onlyoptional

The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.

assigneeType

enum<string>

optional

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.

Allowed values:

PROJECT_DEFAULTCOMPONENT_LEADPROJECT_LEADUNASSIGNED

description

string

optional

The description for the component. Optional when creating or updating a component.

string

read-onlyoptional

The unique identifier for the component.

isAssigneeTypeValid

boolean

read-onlyoptional

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

object

read-onlyoptional

The user details for the component's lead user.

leadUserName

string

optional

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

name

string

optional

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.

project

string

optional

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectId

integer <int64>

read-onlyoptional

The ID of the project the component is assigned to.

realAssignee

object

read-onlyoptional

The user assigned to issues created with this component, when assigneeType does not identify a valid assignee.

realAssigneeType

enum<string>

read-onlyoptional

The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:

PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.

COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.

UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.

PROJECT_DEFAULT when none of the preceding cases are true.

Allowed values:

PROJECT_DEFAULTCOMPONENT_LEADPROJECT_LEADUNASSIGNED

self

string <uri>

read-onlyoptional

The URL of the component.

🟠400Returned if: * the user is not found. * `assigneeType` is an invalid value. * `name` is over 255 characters in length.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira.

🟠404Returned if the component is not found or the user does not have permission to browse the project containing the component.