You can create/read/update/delete metadata value via UI or the following Rest API
Version 1.0
APIs
/component/{projectkey}/{identifier}.
GET
get metadata values for a given object (e.g. version/component) as object array (not unlimited since 4.2)
RequestParametersName | 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
|
PUT
create / update metadata as object array
Request**Content-Type: ** application/json ParametersName | 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[ Rest API - Metadata for Jira 4.2 - 4.4#JiraMetadata ] |
---|
Response**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Array[ Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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
|
PUT
create / update one metadata
Request**Content-Type: ** application/json ParametersName | 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 |
| Rest API - Metadata for Jira 4.2 - 4.4#JiraMetadata |
---|
Response**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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 | ------------- | ------------- | ---------------- | 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
RequestParametersName | 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 |
|
|
/group/{identifier}.
GET
get metadata values for a given object (e.g. project/group/user) as object array (not unlimited since 4.2)
RequestParametersName | 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
|
PUT
create / update metadata as object array
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json
|
/group/{identifier}/{key}.
GET
get the specified metadata
RequestParametersName | 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
|
PUT
create / update one metadata
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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 | ------------- | ------------- | ---------------- | 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
RequestParametersName | 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)
RequestParametersName | 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
|
PUT
create / update metadata as object array
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json
|
/project/{identifier}/{key}.
GET
get the specified metadata
RequestParametersName | 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
|
PUT
create / update one metadata
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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 | ------------- | ------------- | ---------------- | 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
RequestParametersName | 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 |
|
|
/user/{identifier}.
GET
get metadata values for a given object (e.g. project/group/user) as object array (not unlimited since 4.2)
RequestParametersName | 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
|
PUT
create / update metadata as object array
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json
|
/user/{identifier}/{key}.
GET
get the specified metadata
RequestParametersName | 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
|
PUT
create / update one metadata
Request**Content-Type: ** application/json ParametersResponse**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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 | ------------- | ------------- | ---------------- | 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
RequestParametersName | 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 |
|
|
/version/{projectkey}/{identifier}.
GET
get metadata values for a given object (e.g. version/component) as object array (not unlimited since 4.2)
RequestParametersName | 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
|
PUT
create / update metadata as object array
Request**Content-Type: ** application/json ParametersName | 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[ Rest API - Metadata for Jira 4.2 - 4.4#JiraMetadata ] |
---|
Response**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Array[ Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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
|
PUT
create / update one metadata
Request**Content-Type: ** application/json ParametersName | 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 |
| Rest API - Metadata for Jira 4.2 - 4.4#JiraMetadata |
---|
Response**Content-Type: ** application/json Status Code | Reason | Response Model | ------------- | ------------- | ---------------- | 200 | successful operation | Rest API - Metadata for Jira 4.2 - 4.4#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
RequestParametersName | 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 | ------------- | ------------- | ---------------- | 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
RequestParametersName | 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 |
|
|