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. |
| Component ID | The ID of the component. Can be obtained via the List Project Components action. |
| Description | The description for the component. Optional when creating or updating a component. |
| Lead User Name | The username of the component’s lead user. |
| Name | The unique name for the component in the project. Required when creating a component. Optional when updating a component. |
Example Output
{
"id": "https://docs.atlassian.com/jira/REST/schema/component#",
"title": "Component",
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"lead": {
"$ref": "#/definitions/user"
},
"leadUserName": {
"type": "string"
},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {
"$ref": "#/definitions/user"
},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"realAssignee": {
"$ref": "#/definitions/user"
},
"isAssigneeTypeValid": {
"type": "boolean"
},
"project": {
"type": "string"
},
"projectId": {
"type": "integer"
},
"archived": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
}
},
"definitions": {
"simple-list-wrapper": {
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {
"type": "integer"
},
"max-results": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"title": "Group",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"self": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"size"
]
},
"user": {
"title": "User",
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"avatarUrls": {
"type": "object",
"patternProperties": {
".+": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"displayName": {
"type": "string"
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"timeZone": {
"type": "string"
},
"locale": {
"type": "string"
},
"groups": {
"$ref": "#/definitions/simple-list-wrapper"
},
"applicationRoles": {
"$ref": "#/definitions/simple-list-wrapper"
},
"expand": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"active"
]
}
},
"additionalProperties": false,
"required": [
"isAssigneeTypeValid"
]
}