Get issue metadata

get

/issues/issues/v3/repository

Return all issue metadata (all valid fields).

Request

Query Parameters
Header Parameters
Body ()
Root Schema : HttpServletResponse
Type: object
Show Source
Nested Schema : Locale
Type: object
Show Source
Nested Schema : ServletOutputStream
Type: object
Nested Schema : PrintWriter
Type: object
Nested Schema : extensionKeys
Type: array
Unique Items Required: true
Show Source
Nested Schema : unicodeLocaleAttributes
Type: array
Unique Items Required: true
Show Source
Nested Schema : unicodeLocaleKeys
Type: array
Unique Items Required: true
Show Source
Back to Top

Response

200 Response

Successful operation
Body ()
Root Schema : Repository
Type: object
Show Source
Nested Schema : components
Type: array
Show Source
Nested Schema : configurationProperties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : customFields
Type: array
Show Source
Nested Schema : Priority
Type: object
Show Source
Nested Schema : Product
Type: object
Show Source
Nested Schema : Resolution
Type: object
Show Source
Nested Schema : Severity
Type: object
Show Source
Nested Schema : Status
Type: object
Show Source
Nested Schema : priorities
Type: array
Show Source
Nested Schema : products
Type: array
Show Source
Nested Schema : releases
Type: array
Show Source
Nested Schema : resolutions
Type: array
Show Source
Nested Schema : searches
Type: array
Show Source
Nested Schema : severities
Type: array
Show Source
Nested Schema : stateTransitions
Type: array
Show Source
Nested Schema : statuses
Type: array
Show Source
Nested Schema : tags
Type: array
Show Source
Nested Schema : types
Type: array
Show Source
Nested Schema : users
Type: array
Show Source
Nested Schema : Component
Type: object
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : FieldDescriptor
Type: object
Show Source
Nested Schema : values
Type: array
Show Source
Nested Schema : CustomFieldValue
Type: object
Show Source
Nested Schema : components
Type: array
Show Source
Nested Schema : releases
Type: array
Nested Schema : releaseTags
Type: array
Show Source
Nested Schema : ReleaseTag
Type: object
Show Source
Nested Schema : Release
Type: object
Show Source
Nested Schema : SortInfo
Type: object
Show Source
Nested Schema : StateTransition
Type: object
Show Source
Nested Schema : Tag
Type: object
Show Source

406 Response

Media type not acceptable
Body ()
Root Schema : RestException
Type: object
Show Source
Nested Schema : Throwable
Type: object
Show Source
Nested Schema : stackTrace
Type: array
Show Source
Nested Schema : suppressed
Type: array
Show Source
Nested Schema : stackTrace
Type: array
Show Source
Nested Schema : suppressed
Type: array
Nested Schema : StackTraceElement
Type: object
Show Source
Back to Top

Examples

The following example shows how to use curl to submit a POST request on the REST resource to retrieve metadata about the "status" issue property from the repository that stores all information about all issue properties. The example uses the "field=3D" URL query parameter to restrict returned data to fields for statuses only.


curl -i
-X GET
-H "Accept: application/vnd.oracle.resource+json"
-s https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/repository?fields="statuses"

Example of Response Header

The following shows an example of the response header.


200 Successful Operation
Content-Type: application/json
Date: Thu, 17 Aug 2017 00:26:10 GMT

Example of Response Body

The following example shows the contents of the response body in JSON format. Notice that the content includes metadata about the "status" property only. Data is returned in a single line. The response has been formatted to improve readability.


{"repository":
  {"statuses":[
    {"id":1,"value":"UNCONFIRMED","isActive":true,"isOpen":true,"sortkey":100},
    {"id":2,"value":"NEW","isActive":true,"isOpen":true,"sortkey":200},
    {"id":3,"value":"ASSIGNED","isActive":true,"isOpen":true,"sortkey":300},
    {"id":4,"value":"REOPENED","isActive":true,"isOpen":true,"sortkey":400},
    {"id":5,"value":"RESOLVED","isActive":true,"isOpen":false,"sortkey":500},
    {"id":6,"value":"VERIFIED","isActive":true,"isOpen":false,"sortkey":600},
    {"id":7,"value":"CLOSED","isActive":true,"isOpen":false,"sortkey":700}
  ]
}}

The "fields=" query parameter can be used with queries made using issues and issues/<issue-id> resources as well.

You would use the status information retrieved from the repository to update the status of an issue.

Back to Top