You
...
can
...
create/read/update/delete
...
metadata
...
value
...
via
...
UI
...
or
...
the
...
following
...
Rest
...
API
...
Version
...
1.0
...
| Table of Contents |
|---|
...
|
...
|
...
...
APIs
...
| Info |
|---|
...
|
...
e.g. |
...
get |
...
the |
...
first |
...
20 |
...
metadata |
...
for |
...
project |
...
JM |
...
(as |
...
project-admin): |
...
...
...
/admin/cleanupProjectAuditLog
...
GET
internal:
...
removes
...
defect
...
project
...
metadata
...
entries
...
from
...
audit
...
log
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/admin/copyAssigneeMetadata
...
GET
limited
...
use-cases:
...
admins
...
can
...
copy
...
assignee
...
metadata
...
values
...
to
...
issue
...
fields
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/admin/copyProjectMetadata
...
GET
limited
...
use-cases:
...
admins
...
can
...
copy
...
project
...
metadata
...
values
...
to
...
issue
...
fields
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/admin/copyReporterMetadata
...
GET
limited
...
use-cases:
...
admins
...
can
...
copy
...
reporter
...
metadata
...
values
...
to
...
issue
...
fields
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/admin/disableMetadataEventSubSystem
...
GET
experimental:
...
should
...
only
...
be
...
used
...
in
...
exceptional
...
cases.
...
Disables
...
the
...
metadata
...
event
...
sub
...
system
...
(auditlog,
...
indexing)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/admin/enableMetadataEventSubSystem
GET
experimental: should only be used in exceptional cases. Enables the metadata event sub system (auditlog, indexing)
| Expand | ||||
|---|---|---|---|---|
| ||||
RequestParametersResponse**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/component/{projectkey}/{identifier}
GET
get metadata values for a given object (e.g.
...
version/component)
...
as
...
object
...
array
...
(not
...
unlimited
...
since
...
4.2)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
metadata
...
as
...
object
...
array
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/component/{projectkey}/{identifier}/{key}
GET
get the specified metadata
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
one
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
delete the specified metadata
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
...
|
/component/{projectkey}/{identifier}/{key}/value
GET
get the specified metadata value
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
text/plain |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/field/project
...
PUT
experimental:
...
the
...
given
...
(valid)
...
project
...
field
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
experimental: the specified project field will be deleted
| Expand | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
RequestParameters
Response
|
...
|
...
|
...
...
|
/configuration/field/project/all
...
GET
experimental:
...
get
...
all
...
project
...
fields
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/field/project/allEnriched
...
GET
experimental:
...
get
...
all
...
project
...
fields
...
with
...
related
...
screens
...
(used
...
within
...
admin
...
interface)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/field/user
...
PUT
experimental:
...
the
...
given
...
(valid)
...
user
...
field
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
experimental: the specified user field will be deleted
| Expand | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
RequestParameters
Response
|
...
|
...
|
...
...
|
/configuration/field/user/all
...
GET
experimental:
...
get
...
all
...
user
...
fields
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/field/user/allEnriched
...
GET
experimental:
...
get
...
all
...
project
...
fields
...
with
...
related
...
screens
...
(used
...
within
...
admin
...
interface)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/project/
...
{projectKey
...
}
...
GET
experimental:
...
returns
...
the
...
project
...
configuration
...
for
...
the
...
specified
...
project
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/project/
...
{projectKey
...
}/screen/
...
{screenKey
...
}
...
GET
experimental:
...
applies
...
the
...
project
...
screen
...
to
...
the
...
specified
...
project
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/screen/enrichedproject
...
PUT
experimental:
...
the
...
given
...
(valid)
...
project
...
screen
...
will
...
be
...
updated
...
and
...
unknown
...
project
...
fields
...
will
...
be
...
created
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/screen/project
...
PUT
experimental:
...
the
...
given
...
(valid)
...
project
...
screen
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/screen/project/all
...
GET
experimental:
...
get
...
all
...
project
...
screens
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/configuration/screen/project/default
...
GET
experimental:
...
get
...
the
...
default
...
project
...
screen
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
PUT
experimental:
...
the
...
specified
...
project
...
screen
...
becomes
...
the
...
default
...
project
...
screen
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/configuration/screen/project/
...
{identifier
...
}
...
DELETE
experimental:
...
the
...
specified
...
project
...
screen
...
will
...
be
...
deleted
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/configuration/screen/user
...
PUT
experimental:
...
the
...
given
...
(valid)
...
user
...
screen
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/configuration/screen/user/all
...
GET
experimental:
...
get
...
all
...
user
...
screens
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/configuration/screen/user/default
...
GET
experimental:
...
get
...
the
...
default
...
user
...
screen
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/configuration/screen/user/profile
...
GET
experimental:
...
get
...
the
...
default
...
user
...
profile
...
screen
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/group/
...
{identifier
...
}
...
GET
get
...
metadata
...
values
...
for
...
a
...
given
...
object
...
(e.g.
...
project/group/user)
...
as
...
object
...
array
...
(not
...
unlimited
...
since
...
4.2)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
metadata
...
as
...
object
...
array
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/group/{identifier}/{key}
GET
get the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
one
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
delete the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/group/{identifier}/{key}/value
GET
get the specified metadata value
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
text/plain |
...
|
...
|
...
|
...
|
...
|
...
...
|
/project/
...
{identifier
...
}
...
GET
get
...
metadata
...
values
...
for
...
a
...
given
...
object
...
(e.g.
...
project/group/user)
...
as
...
object
...
array
...
(not
...
unlimited
...
since
...
4.2)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
metadata
...
as
...
object
...
array
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/project/{identifier}/{key}
GET
get the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
one
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
delete the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/project/{identifier}/{key}/value
GET
get the specified metadata value
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
text/plain |
...
|
...
|
...
|
...
|
...
|
...
...
|
/projects/filter
...
PUT
experimental:
...
the
...
given
...
(valid)
...
project
...
screen
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/projects/filter/all
...
GET
experimental:
...
get
...
all
...
filter
...
for
...
the
...
current
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/projects/filter/
...
{identifier
...
}
...
DELETE
experimental:
...
the
...
specified
...
project
...
screen
...
will
...
be
...
deleted
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/projects/fullReindex
GET
experimental:
...
starts
...
the
...
reindex
...
for
...
all
...
projects
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
/projects/index/
...
{identifier
...
}
...
GET
experimental:
...
reindex
...
the
...
specified
...
project
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/projects/search
...
POST
experimental:
...
search
...
for
...
projects
...
with
...
the
...
specified
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/servicedesk/customer/profile/
...
{identifier
...
}
...
GET
experimental:
...
returns
...
the
...
customer
...
screen
...
(with
...
it
...
's
...
metadata
...
values
...
for
...
the
...
specfied
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/servicedesk/customer/profile/
...
{identifier
...
}/
...
{key
...
}
...
PUT
experimental:
...
create
...
/
...
update
...
the
...
specified
...
metadata
...
as
...
non
...
hidden
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/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
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/servicedesk/{projectKey}/agent/customer/profile/
...
{identifier
...
}
...
GET
experimental:
...
returns
...
the
...
customer
...
screen
...
(with
...
it
...
's
...
metadata
...
values
...
for
...
the
...
specified
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/servicedesk/{projectKey}/agent/customer/profile/
...
{identifier
...
}/
...
{key
...
}
...
PUT
experimental:
...
create
...
/
...
update
...
the
...
specified
...
metadata
...
as
...
non
...
hidden
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/user/{identifier}
GET
get metadata values for a given object (e.g. project/group/user)
...
as
...
object
...
array
...
(not
...
unlimited
...
since
...
4.2)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
metadata
...
as
...
object
...
array
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/user/{identifier}/{key}
GET
get the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
one
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
|
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
delete the specified metadata
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/user/{identifier}/{key}/value
GET
get the specified metadata value
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
text/plain |
...
|
...
|
...
|
...
|
...
|
...
...
|
/users/filter
...
PUT
experimental:
...
the
...
given
...
(valid)
...
filter
...
will
...
be
...
updated
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/users/filter/all
...
GET
experimental:
...
get
...
all
...
filter
...
for
...
the
...
current
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response |
...
|
...
|
...
|
...
|
...
|
...
...
|
/users/filter/
...
{identifier
...
}
...
DELETE
experimental:
...
the
...
specified
...
filter
...
will
...
be
...
deleted
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response
|
...
|
...
|
...
...
|
/users/fullReindex
...
GET
experimental:
...
starts
...
the
...
reindex
...
for
...
all
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
/users/index/
...
{userName
...
}
...
GET
experimental:
...
reindex
...
the
...
specified
...
user
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
...
|
/users/search
...
POST
experimental:
...
search
...
for
...
user
...
with
...
the
...
specified
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
/version/
...
{projectkey
...
}/
...
{identifier
...
}
...
GET
get
...
metadata
...
values
...
for
...
a
...
given
...
object
...
(e.g.
...
version/component)
...
as
...
object
...
array
...
(not
...
unlimited
...
since
...
4.2)
...
| Expand |
|---|
...
|
...
...
Request |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
metadata
...
as
...
object
...
array
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
|
/version/{projectkey}/{identifier}/{key}
GET
get the specified metadata
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
...
|
PUT
create
...
/
...
update
...
one
...
metadata
...
| Expand |
|---|
...
|
...
...
Request**Content-Type: |
...
** |
...
application/json |
...
Parameters |
...
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
DELETE
delete the specified metadata
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
application/json |
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
...
|
/version/{projectkey}/{identifier}/{key}/value
GET
get the specified metadata value
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
RequestParameters
Response**Content-Type: |
...
** |
...
text/plain |
...
|
...
|
...
|
...
|
...
|
...
...
|
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 | optional | the used search params | ||
moreResultsAvailable | boolean | optional | indicates that even more values could be returned | |
results | 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) |