• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / / REST API

component

Postman Collection
OpenAPI
Operations
POST/api/2/componentGET/api/2/component/pageGET/api/2/component/{id}PUT/api/2/component/{id}DEL/api/2/component/{id}GET/api/2/component/{id}/relatedIssueCounts
POST

Create component

Create a component via POST.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

the request containing value of the component's property. The value has to be a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.

archived

boolean

assigneeType

string

deleted

boolean

description

string

id

string

lead

UserBean

leadUserName

string

name

string

project

string

self

string

Responses

Returned if the component is created successfully.

application/json

ComponentBean
POST/api/2/component
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/component' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Get paginated componentsExperimental

Returns paginated list of filtered active components

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

maxResults

string

query

string

projectIds

string

startAt

string

Responses

Returns paginated list of components

application/json

PageBean
GET/api/2/component/page
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/component/page' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get project component

Returns a project component.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Responses

Returns a full JSON representation of a project component.

application/json

ComponentBean
GET/api/2/component/{id}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/component/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Update a component

Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Request bodyapplication/json

the request containing value of the component's property. The value has to be a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.

archived

boolean

assigneeType

string

deleted

boolean

description

string

id

string

lead

UserBean

leadUserName

string

name

string

project

string

self

string

Responses

Returned if the component is successfully updated.

application/json

ComponentBean
PUT/api/2/component/{id}
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/component/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Delete a project component

Delete a project component.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Query parameters

moveIssuesTo

string

Responses

Returned if the component is successfully deleted.

DEL/api/2/component/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/component/{id}' \ --user 'email@example.com:<api_token>'
GET

Get component related issues

Returns counts of issues related to this component.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Responses

Returns counts of issues related to this component.

application/json

ComponentIssueCountsBean
GET/api/2/component/{id}/relatedIssueCounts
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/component/{id}/relatedIssueCounts' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: