/
Rest API - Metadata for Jira 5.3 pre-rendered

Rest API - Metadata for Jira 5.3 pre-rendered

May 27, 2024

You can create/read/update/delete metadata value via UI or the following Rest API
Version 1.0

APIs

Base path for the Rest API: Jira_Base_Url/rest/metadata/1.0

e.g. get the first 20 metadata for project JM (as project-admin): https://jira.atlassian.internal/rest/metadata/1.0/project/JM?includeHidden=true&startAt=0&maxResults=20

/admin/cleanupProjectAuditLog

GET

internal: removes defect project metadata entries from audit log

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/admin/copyAssigneeMetadata

GET

limited use-cases: admins can copy assignee metadata values to issue fields

Request

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

metadataKey

query

no

 

 

>string

fieldId

query

no

 

 

>string

jql

query

no

 

 

>string

max

query

no

 

 

>integer (int32)

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/admin/copyProjectMetadata

GET

limited use-cases: admins can copy project metadata values to issue fields

Request

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

metadataKey

query

no

 

 

>string

fieldId

query

no

 

 

>string

jql

query

no

 

 

>string

max

query

no

 

 

>integer (int32)

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/admin/copyReporterMetadata

GET

limited use-cases: admins can copy reporter metadata values to issue fields

Request

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

metadataKey

query

no

 

 

>string

fieldId

query

no

 

 

>string

jql

query

no

 

 

>string

max

query

no

 

 

>integer (int32)

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/admin/disableMetadataEventSubSystem

GET

experimental: should only be used in exceptional cases. Disables the metadata event sub system (auditlog, indexing)

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/admin/enableMetadataEventSubSystem

GET

experimental: should only be used in exceptional cases. Enables the metadata event sub system (auditlog, indexing)

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

Request was processed and there are more details within the server log

 

403

User has no Admin permission

 

/component/{projectkey}/{identifier}

GET

get metadata values for a given object (e.g. version/component) as object array (not unlimited since 4.2)

Request

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectkey

path

yes

the project key

 

>string

identifier

path

yes

the version/component identifier

 

>string

includeHidden

query

no

will include the hidden metadata values, if the user has the permission to edit (create/update) metadata values

 

>boolean

startAt

query

no

the index of the first metadata value to return (0-based)

 

>integer (int32)

maxResults

query

no

the maximum number of metadata values to return (defaults to 100 (if startAt >= 1)). The maximum allowable value is dictated to 500. If you specify a value that is higher than this number, your search results will be truncated.

 

>integer (int32)

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

successful operation

Array[ JiraMetadata ]

PUT

create / update metadata as object array

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectkey

path

yes

the project key

 

>string

identifier

path

yes

the version/component identifier

 

>string

JiraMetadata

body

yes

the to change metadata object array

 

Array[ JiraMetadata ]

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

-------------

-------------

----------------

200

successful operation

Array[ JiraMetadata ]

400

the specified version/component can't be loaded

 

403

User has no permission to create / update metadata

 

503

Invalid license

 

/component/{projectkey}/{identifier}/{key}

GET

get the specified metadata

Request

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectkey

path

yes

the project key

 

>string

identifier

path

yes

the version/component identifier

 

>string

key

path

yes

the user-defined key of the metadata

 

>string

Response

**Content-Type: ** application/json