Versions Compared

Old Version 1

changes.mady.by.user Andreas Spall (evolu.software)

Saved on

compared with

New Version 2

changes.mady.by.user Andreas Spall (evolu.software)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
icontrue
titleBase 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

get metadata values for a given object (e.g. version/component) as object array (not unlimited since 4.2)internal: removes defect project metadata entries from audit log

Response

**Content-Type: ** application/json

Expand
Details
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)

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)

Expand
Details
Details

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

Array[ JiraMetadata ]

PUT

...

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)

Expand
Details
Details

Request

Parameters

Response

**Content-Type: ** application/json

Parameters

Status Code

Name

Status Code

Reason

Response Model

Reason

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

Response Model

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

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

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

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

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

200

successful operation

Array[ JiraMetadata ]

400

the specified version/component can't be loaded

200

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


403

User has no Admin permission

to create / update metadata503

Invalid license



/component/{

...

projectKey}/{identifier

...

}

GET

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

Response

**Content-Type: ** application/json

-
Expand
Details
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

includeHidden

path

query

yes

no

will include the

user-defined key of the metadata

>string

Status Code

Reason

Response Model

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

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

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 one metadata as object array

the user-defined key of the metadata
Expand
Details
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


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

...



/component/{projectKey}/{identifier}/{key}

GET

get the specified metadata

Expand
Details
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: ** textapplication/plainjson

Status Code

Reason

Response Model

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

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

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

200

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

successful operation

JiraMetadata


PUT

create / update one metadata

Expand
Details
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: ** textapplication/plainjson

Status Code

Reason

Response Model

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

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

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

200

successful operation

/configuration/project/{projectKey}

GET

...

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

Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

projectkey

path

yes

the project key


>string

Response

**Content-Type: ** application/json

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

ProjectConfiguration

...

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

experimental: applies the project screen to get the specified projectmetadata value

403
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

projectkey

path

yes

the project key


>string

identifier

path

yes

the version/component identifier


>string

screenKey

key

path

yes

the

screen key

user-defined key of the metadata


>string

Response

**Content-Type: ** applicationtext/jsonplain

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

User has no Project Admin permission



/configuration/

...

field/

...

project

...

PUT

experimental: get the default customer screenthe given (valid) project field will be updated

-
Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters
Response

Name

Status Code

Located in

Reason

Required

Response Model

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

application use permission

PUT

...

Jira Admin permission



/configuration/field/project/all

GET

experimental: get all project fields

--
Expand
Details
Details

Request

Parameters
Name

Response

Located in

Status Code

Required

Status Code

Reason

Response Model

Reason

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen

Response

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid

403

User has no

Jira Admin

application use permission



/configuration/

...

field/project/allEnriched

...

GET

experimental: the given (valid) project screen will be updatedget all project fields with related screens (used within admin interface)

-
Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters
Name

Response

Located in

Status Code

Required

Status Code

Reason

Response Model

Reason

Description

Default

Schema

MetadataScreen

body

yes

the to change metadata screen

Response

**Content-Type: ** application/json

Response Model

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

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

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

200

successful operation

Message

400

the given json is invalid

403

User has no

Jira Admin

application use permission



/configuration/

...

field/project/

...

{identifier}

...

DELETE

experimental: get all project screensthe specified project field will be deleted

----
Expand
Details
Details

Request

Parameters

Name

Located in

Response

Required

Status Code

Description

Reason

Default

Response Model

Schema

identifier

path

yes

the field identifier


>string

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no

application use permission

Jira Admin permission


500

Error when deleting



/configuration

...

/project/

...

{projectKey}

GET

experimental: get the default project screenreturns the project configuration for the specified project

Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectKey

path

yes



>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission

...

200

successful operation

ProjectConfiguration


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

GET

experimental: applies the specified project screen becomes to the default specified project screen

body
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

MetadataScreen

projectKey

path

yes

the project key


>string

screenKey

path

yes

the

to change metadata

screen key


>string

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

Project Admin permission



/configuration/screen/

...

customer/

...

default

...

GET

experimental: get the specified project screen will be deleteddefault customer screen

Response

Status

Response

Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the screen identifier

>string

Status Code

Reason

Response Model

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

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

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

200

successful operation

Message

403

User has no

Jira Admin

application use permission

500

Error when deleting

/configuration/screen/user/default

GET

...



PUT

experimental: the specified user screen becomes the default customer screen

User has no application use permission
Expand
Details
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

403

successful operation

Message

400

the given json is invalid


403

User has no Jira Admin permission



/configuration/screen/project

PUT

experimental: the specified user screen becomes the default user screengiven (valid) project screen will be updated

Expand
Details
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

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

...

experimental: get all project screens

includeHidden
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier

>string

excludeFieldInformation

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

-

return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

---

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

200

successful operation

Array[ JiraMetadata ]

PUT

create / update metadata as object array

403

User has no application use permission



/configuration/screen/project/default

GET

experimental: get the default project screen

Response

**Content-Type: ** application/json

Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

excludeFieldInformation

path

query

yes

no

the project/group/user identifier

>string

JiraMetadata

body

yes

the to change metadata object array

Array[ JiraMetadata ]

Status Code

Reason

Response Model

will return the screen without additional field information


>boolean

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Array[ JiraMetadata ]

403

User has no application use permission

to create / update metadata

503

Invalid license

/group/{identifier}/{key}

GET

...



PUT

experimental: the specified project screen becomes the default project screen

Response

**Content-Type: ** application/json

Status
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

MetadataScreen

path

body

yes

the

project/group/user identifier

>string

key

path

yes

the user-defined key of the metadata

>string

to change metadata screen



Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

...

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

Response

**Content-Type: ** application/json

Response

Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the

project/group/user

screen identifier


>string

key

path

yes

the user-defined key of the metadata

>string

JiraMetadata

body

yes

the to change metadata

JiraMetadata

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

Message

403

User has no Jira Admin permission

to create / update metadata


500

something went wrong while saving the metadata

503

Invalid license

DELETE

...

Error when deleting



/configuration/screen/user/default

GET

experimental: get the default user screen

key

Response

**Content-Type: ** text/plain

Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier

>string

path

yes

the user-defined key of the metadata

>string

Status Code

Reason

Response Model

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

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

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

403

User has no application use permission

to create / update metadata

404

there is no metadata object with the given key

503

Invalid license

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

GET

...



PUT

experimental: the specified user screen becomes the default user screen

Response

**Content-Type: ** text/plain
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

MetadataScreen

path

body

yes

the

project/group/user identifier

>string

key

path

yes

the user-defined key of the metadata

>string

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



/group/{identifier}

GET

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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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)

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
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

Expand
Details
Details

Request

Parameters

Response

Status Code

Reason

Response Model

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

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

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

200

successful operation

Array[ JiraMetadata ]

PUT

...

403

User has no application use permission


510

No License provided



/projects/filter/{identifier}

DELETE

experimental: the specified project screen will be deleted

Response

**Content-Type: ** application/json
Expand
Details
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 ]

filter identifier


>integer (int32)

Response

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

...

Message

500

Error when deleting



/projects/fullReindex

GET

experimental: starts the reindex for all projects

Request

Parameters
>string
Expand
Details
Details

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

Request

Parameters

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

PUT

...

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

JiraMetadata

Parameters
Expand
Details
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

Name

Located in

Required

Description

Default

Schema

identifier

path

yes



>string

Response

**Content-Type: ** application/json

Status Code

Reason

Response Model

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

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

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

200

successful operation

JiraMetadata

the specified project has been indexed.


400

the

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

project can't be indexed


403

User has no

permission to create / update metadata

500

something went wrong while saving the metadata

503

Invalid license

DELETE

...

Project Admin or Jira Admin permission



/projects/search

POST

experimental: search for projects with the specified metadata

Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

searchParams

path

body

yes

the

project/group/user identifier

>string

key

path

yes

the user-defined key of the metadata

>string

users search params


SearchParams

Response

**Content-Type: ** textapplication/plainjson

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

...

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

the user-defined key of the metadata
Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the

project/group/

user identifier

>string

key

path

yes


>string

Response

**Content-Type: ** text/plain

Status Code

Reason

Response Model

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

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

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

200

successful operation

500

the user defined by identifier is not the current user



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

...

PUT

experimental: returns the customer screen (with it's metadata values for the specfied usercreate / update the specified metadata as non hidden metadata

Expand
Details
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

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

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

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

500

the user defined by identifier is not the current user

...

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/customer/profile/{identifier

...

}

...

GET

experimental: create / update the specified metadata as non hidden metadatareturns the customer screen (with it's metadata values for the specfied user

the user-defined key of the metadata
Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

projectKey

path

yes

the

user identifier

>string

key

path

yes

service desk project key


>string

JiraMetadata

identifier

body

path

yes

the

to change metadata

JiraMetadata

Response

**Content-Type: ** application/json

user identifier


>string

Response

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

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: returns the customer screen (with it's metadata values for the specfied usercreate / update the specified metadata as non hidden metadata

Response
Expand
Details
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


>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

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

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

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

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

...

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)

JiraMetadata
Expand
Details
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

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

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

...

Array[ JiraMetadata ]


PUT

create / update metadata as object array

>integer (int32)
Expand
Details
Details

Request

**Content-Type: ** application/json

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.

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

Array[ JiraMetadata ]
Expand
Details
Details

Request

**Content-Type: ** application/json

Parameters

Name

Located in

Required

Description

Default

Schema

identifier

path

yes

the project/group/user identifier


>string

JiraMetadata

key

body

path

yes

the to change metadata object array

the user-defined key of the metadata


>string

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

...

-

200

successful operation

JiraMetadata


PUT

create / update one metadata

Expand
Details
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

PUT

...

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

JiraMetadata
Expand
Details
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

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 metadatasomething went wrong while saving the metadata

403

User has no permission to create / update metadata

500


404

there is no metadata object with the given key


503

Invalid license

DELETE

...



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

GET

get the specified metadata value

Expand
Details
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

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

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

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

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

...

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)

Expand
Details
Details

Request

Parameters

Name

Located in

Required

Description

Default

Schema

projectkey

path

yes

the project key


>string

identifier

path

yes

the

project

version/

group/user

component identifier


>string

key

includeHidden

path>string

query

yes

the user-defined key of the metadata

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: ** textapplication/plainjson

Status Code

Reason

Response Model

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

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

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

200

successful operation

/version/{projectkey}/{identifier}

GET

...

Array[ JiraMetadata ]


PUT

create / update metadata as object array

>integer (int32)
Expand
Details
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

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.

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 ]

PUT

...

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

Array[ JiraMetadata ]
Expand
Details
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

key

body

path

yes

the to change metadata object array

the user-defined key of the metadata


>string

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


PUT

create / update one metadata

503
Expand

Invalid license

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

GET

get the specified metadata

Request
Expand
DetailsDetails
Details
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

PUT

...

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

the to change metadata
Expand
Details
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

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,

-

400

the specified version/component can't be loaded

or something went wrong while loading the saved metadatasomething went wrong while saving the metadata


403

User has no permission to create / update metadata

500


404

there is no metadata object with the given key


503

Invalid license

DELETE

...



/version/{projectKey}/{identifier}/{key}/value

GET

get the specified metadata value

Expand
Details
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-

...

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

...

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

...

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



Project

name

type

required

description

example

project

object

optional



metadata

object

optional



ProjectConfiguration

name

type

required

description

example

editPermission

boolean

optional



selectionItems

array[ #/definitions/SelectionItem ]

optional



screen

string

optional



SearchParams

name

type

required

description

example

key

string

required

the userdefined key of the metadata

group

string

optional

value

start

integer (int32)

optional



limit

integer (int32)

optional

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


returnAllFields

boolean

optional



projectSearchValues

arraystring

optional

hidden


searchValues

boolean

object

optional

...



SearchResult

name

type

required

description

example

message

string

name

type

required

description

example

editPermission

searchParams

#/definitions/SearchParams

optional

ProjectConfiguration



moreResultsAvailable

boolean

optional

selectionItems


results

array[ #/definitions/

SelectionItem

Project ]

optional

screen

string

optional



SelectionItem

name

type

required

description

example

label

string

optional



value

string

optional



projectKey

string

optional



items

array[

#/definitions/SelectionItem

#SelectionItem ]

optional