Rest API - Metadata for Jira 4.7 pre-rendered

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

/admin/cleanupProjectAuditLog

GET

internal: removes defect project metadata entries from audit log

 Details

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/disableMetadataEventSubSystem

GET

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

 Details

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)

 Details

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)

 Details

Request

Parameters

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

 Details

Request

**Content-Type: ** application/json

Parameters

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

 Details

Request

Parameters

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

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

create / update one metadata

 Details

Request

**Content-Type: ** application/json

Parameters

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

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object, the specified version/component can't be loaded or something went wrong while loading the saved metadata


403

User has no permission to create / update metadata


500

something went wrong while saving the metadata


503

Invalid license


DELETE

delete the specified metadata

 Details

Request

Parameters

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

Status Code

Reason

Response Model

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

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

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

400

the specified version/component can't be loaded


403

User has no permission to create / update metadata


404

there is no metadata object with the given key


503

Invalid license


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

GET

get the specified metadata value

 Details

Request

Parameters

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: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation


/configuration/field/project

PUT

experimental: the given (valid) project field will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataField

body

yes

the to change metadata field



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


DELETE

experimental: the specified project field will be deleted

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataField

body

yes

the to delete metadata field



Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no Jira Admin permission


500

Error while deleting


/configuration/field/project/all

GET

experimental: get all project fields

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/field/project/allEnriched

GET

experimental: get all project fields with related screens (used within admin interface)

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/field/user

PUT

experimental: the given (valid) user field will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataField

body

yes

the to change metadata field



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


DELETE

experimental: the specified user field will be deleted

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataField

body

yes

the to delete metadata field



Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no Jira Admin permission


500

Error while deleting


/configuration/field/user/all

GET

experimental: get all user fields

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/field/user/allEnriched

GET

experimental: get all project fields with related screens (used within admin interface)

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/project/{projectKey}

GET

experimental: returns the project configuration for the specified project

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes



>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

ProjectConfiguration

/configuration/project/{projectKey}/screen/{screenKey}

GET

experimental: applies the project screen to the specified project

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes

the project key


>string

screenKey

path

yes

the screen key


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no Project Admin permission


/configuration/screen/enrichedproject

PUT

experimental: the given (valid) project screen will be updated and unknown project fields will be created

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen with additional field information



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


/configuration/screen/project

PUT

experimental: the given (valid) project screen will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


/configuration/screen/project/all

GET

experimental: get all project screens

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

excludeFieldInformation

query

no

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/screen/project/default

GET

experimental: get the default project screen

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

excludeFieldInformation

query

no

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


PUT

experimental: the specified project screen becomes the default project screen

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen



Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


/configuration/screen/project/{identifier}

DELETE

experimental: the specified project screen will be deleted

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the screen identifier


>string

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no Jira Admin permission


500

Error when deleting


/configuration/screen/user

PUT

experimental: the given (valid) user screen will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission


/configuration/screen/user/all

GET

experimental: get all user screens

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

excludeFieldInformation

query

no

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/screen/user/default

GET

experimental: get the default user screen

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

excludeFieldInformation

query

no

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/configuration/screen/user/profile

GET

experimental: get the default user profile screen

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

excludeFieldInformation

query

no

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


/group/{identifier}

GET

get metadata values for a given object (e.g. project/group/user) as object array (not unlimited since 4.2)

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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 ]

403

User has no permission to create / update metadata


503

Invalid license


/group/{identifier}/{key}

GET

get the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

create / update one metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object or something went wrong while loading the saved metadata


403

User has no permission to create / update metadata


500

something went wrong while saving the metadata


503

Invalid license


DELETE

delete the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

403

User has no permission to create / update metadata


404

there is no metadata object with the given key


503

Invalid license


/group/{identifier}/{key}/value

GET

get the specified metadata value

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation


/project/{identifier}

GET

get metadata values for a given object (e.g. project/group/user) as object array (not unlimited since 4.2)

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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 ]

403

User has no permission to create / update metadata


503

Invalid license


/project/{identifier}/{key}

GET

get the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

create / update one metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object or something went wrong while loading the saved metadata


403

User has no permission to create / update metadata


500

something went wrong while saving the metadata


503

Invalid license


DELETE

delete the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

403

User has no permission to create / update metadata


404

there is no metadata object with the given key


503

Invalid license


/project/{identifier}/{key}/value

GET

get the specified metadata value

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation


/projects/filter

PUT

experimental: the given (valid) project screen will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

filter

body

yes

the to change filter



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


/projects/filter/all

GET

experimental: get all filter for the current user

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


510

No License provided


/projects/filter/{identifier}

DELETE

experimental: the specified project screen will be deleted

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the filter identifier


>integer (int32)

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

500

Error when deleting


/projects/fullReindex

GET

experimental: starts the reindex for all projects

 Details

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

full reindex started, consult server logs for details


400

the projects can't be indexed


403

User has no Jira Admin permission


/projects/index/{identifier}

GET

experimental: reindex the specified project

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes



>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

the specified project has been indexed.


400

the project can't be indexed


403

User has no Project Admin or Jira Admin permission


/projects/search

POST

experimental: search for projects with the specified metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

searchParams

body

yes

the users search params


SearchParams

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

returns the search results

SearchResult

/servicedesk/customer/profile/{identifier}

GET

experimental: returns the customer screen (with it's metadata values for the specfied user

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the user identifier


>string

Response

Status Code

Reason

Response Model

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

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

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

500

the user defined by identifier is not the current user


/servicedesk/customer/profile/{identifier}/{key}

PUT

experimental: create / update the specified metadata as non hidden metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object or something went wrong while loading the saved metadata


403

User (found by the user identifier) is not the calling user or the metadata is not part of the customer screen


500

something went wrong while saving the metadata


503

Invalid license


/servicedesk/{projectKey}/agent/ascustomer/profile/{identifier}

GET

experimental: returns the customer screen (with it's metadata values for the specified user, like the call was done by the customer

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes

the service desk project key


>string

identifier

path

yes

the user identifier


>string

Response

Status Code

Reason

Response Model

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

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

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

500

current user is not an agent for the specified project or the project can't be found


/servicedesk/{projectKey}/agent/customer/profile/{identifier}

GET

experimental: returns the customer screen (with it's metadata values for the specified user

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes

the service desk project key


>string

identifier

path

yes

the user identifier


>string

Response

Status Code

Reason

Response Model

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

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

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

500

current user is not an agent for the specified project or the project can't be found


/servicedesk/{projectKey}/agent/customer/profile/{identifier}/{key}

PUT

experimental: create / update the specified metadata as non hidden metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes

the service desk project key


>string

identifier

path

yes

the user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object or something went wrong while loading the saved metadata


403

The calling user is not in the Agent role or the metadata is not part of the customer screen


500

something went wrong while saving the metadata


503

Invalid license


/user/{identifier}

GET

get metadata values for a given object (e.g. project/group/user) as object array (not unlimited since 4.2)

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user 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 ]

403

User has no permission to create / update metadata


503

Invalid license


/user/{identifier}/{key}

GET

get the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

create / update one metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object or something went wrong while loading the saved metadata


403

User has no permission to create / update metadata


500

something went wrong while saving the metadata


503

Invalid license


DELETE

delete the specified metadata

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

403

User has no permission to create / update metadata


404

there is no metadata object with the given key


503

Invalid license


/user/{identifier}/{key}/value

GET

get the specified metadata value

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

key

path

yes

the user-defined key of the metadata


>string

Response

**Content-Type: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation


/users/filter

PUT

experimental: the given (valid) filter will be updated

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

filter

body

yes

the to change filter



Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid


/users/filter/all

GET

experimental: get all filter for the current user

 Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission


510

No License provided


/users/filter/{identifier}

DELETE

experimental: the specified filter will be deleted

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the filter identifier


>integer (int32)

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

500

Error when deleting


/users/fullReindex

GET

experimental: starts the reindex for all user

 Details

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

full reindex started, consult server logs for details


400

all user can't be indexed


403

User has no Jira Admin permission


/users/index/{userName}

GET

experimental: reindex the specified user

 Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

userName

path

yes



>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

the specified user has been indexed.


400

the user can't be indexed


403

User has no User Admin or Jira Admin permission


/users/search

POST

experimental: search for user with the specified metadata

 Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

searchParams

body

yes

the users search params


SearchParams

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

returns the search results

SearchResult

/version/{projectkey}/{identifier}

GET

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

 Details

Request

Parameters

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

 Details

Request

**Content-Type: ** application/json

Parameters

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


/version/{projectkey}/{identifier}/{key}

GET

get the specified metadata

 Details

Request

Parameters

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

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

create / update one metadata

 Details

Request

**Content-Type: ** application/json

Parameters

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

JiraMetadata

body

yes

the to change metadata


JiraMetadata

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

400

the given key doesn't match to the key of the JiraMetadata object, the specified version/component can't be loaded or something went wrong while loading the saved metadata


403

User has no permission to create / update metadata


500

something went wrong while saving the metadata


503

Invalid license


DELETE

delete the specified metadata

 Details

Request

Parameters

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

Status Code

Reason

Response Model

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

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

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

400

the specified version/component can't be loaded


403

User has no permission to create / update metadata


404

there is no metadata object with the given key


503

Invalid license


/version/{projectkey}/{identifier}/{key}/value

GET

get the specified metadata value

 Details

Request

Parameters

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: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation


Json-Objects

JiraMetadata

name

type

required

description

example

key

string

required

the userdefined key of the metadata


group

string

optional



value

string

optional



hidden

boolean

optional



Message

name

type

required

description

example

message

string

optional

status message for the call (e.g. ok)


ProjectConfiguration

name

type

required

description

example

editPermission

boolean

optional

will be true to indicate that the user has edit permission


selectionItems

array[ #/definitions/SelectionItem ]

optional

list of selectable items (e.g. Project, Component, Version)


screen

string

optional

the selected project screen


SearchParams

name

type

required

description

example

start

integer (int32)

optional

the user defined start (last start + limit)


limit

integer (int32)

optional

the user defined limit (must be lower than 50 and higher than 25)


returnAllFields

boolean

optional

default is false, so only the specified fields will be returned


projectSearchValues

arraystring

optional

project (key, name) releated search params


searchValues

object

optional

metadata releated search params


SearchResult

name

type

required

description

example

searchParams

#/definitions/SearchParams

optional

the used search params


moreResultsAvailable

boolean

optional

indicates that even more values could be returned


results

array[ #/definitions/SearchResultProjectItem ]

optional

the search result


SearchResultProjectItem

name

type

required

description

example

project

object

optional

project related values (e.g. projectId, projectKey)


metadata

object

optional

the metadata as key value pairs


SearchResultUserItem

name

type

required

description

example

user

object

optional

user related values (e.g. userId, username)


metadata

object

optional

the metadata as key value pairs


SelectionItem

name

type

required

description

example

label

string

optional

the label (e.g. Project, Component, Version, 1.0)


value

string

optional

the value (e.g. project, component, version, 1.0)


projectKey

string

optional

the project key


items

array[ #/definitions/SelectionItem ]

optional

list of selectable sub items (e.g. Version: 1.2, 1.3. 2.0)