REST API for Managing Issues in Oracle Developer Cloud Service

Return repository data

get

/*/issues/issues/v2/repository

Data that is returned consists of the collections of allowed values for the fields in an issue.

Request

Query Parameters

fields: Type: string

A comma-separated list of the names of the fields to return.

Response

200 Response

successful operation

Body

Root Schema : Repository

Type: object

Properties

attachmentUploadUrl: Type: string
components: Type: array components
configurationProperties: Type: object configurationProperties

Additional Properties Allowed: additionalProperties
customFields: Type: array customFields
defaultPriority: Type: object Priority
defaultProduct: Type: object Product
defaultResolution: Type: object Resolution
defaultSeverity: Type: object Severity
defaultStatus: Type: object Status
defaultType: Type: string
links: Type: array links
priorities: Type: array priorities
products: Type: array products
releases: Type: array releases
resolutions: Type: array resolutions
searches: Type: array searches
severities: Type: array severities
stateTransitions: Type: array stateTransitions
statuses: Type: array statuses
tags: Type: array tags
types: Type: array types
url: Type: string
users: Type: array users

Nested Schema : components

Type: array

Items

Type: object Component

Nested Schema : configurationProperties

Type: object

Additional Properties Allowed

Type: string

Nested Schema : customFields

Type: array

Items

Type: object FieldDescriptor

Nested Schema : Priority

Type: object

Properties

id: Type: integer (int32)
links: Type: array links
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : Product

Type: object

Properties

components: Type: array components
defaultComponent: Type: object Component
description: Type: string
id: Type: integer (int32)
isActive: Type: boolean

Default Value: false
links: Type: array links
name: Type: string
releases: Type: array releases
releaseTags: Type: array releaseTags

Nested Schema : Resolution

Type: object

Properties

id: Type: integer (int32)
links: Type: array links
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : Severity

Type: object

Properties

id: Type: integer (int32)
links: Type: array links
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : Status

Type: object

Properties

id: Type: integer (int32)
isActive: Type: boolean

Default Value: false
isOpen: Type: boolean

Default Value: false
links: Type: array links
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : priorities

Type: array

Items

Type: object Priority

Nested Schema : products

Type: array

Items

Type: object Product

Nested Schema : releases

Type: array

Items

Type: object Release

Nested Schema : resolutions

Type: array

Items

Type: object Resolution

Nested Schema : searches

Type: array

Items

Type: object Search

Nested Schema : severities

Type: array

Items

Type: object Severity

Nested Schema : stateTransitions

Type: array

Items

Type: object StateTransition

Nested Schema : statuses

Type: array

Items

Type: object Status

Nested Schema : tags

Type: array

Items

Type: object Tag

Nested Schema : types

Type: array

Items

Type: string

Nested Schema : users

Type: array

Items

Type: object User

Nested Schema : Component

Type: object

Properties

description: Type: string
id: Type: integer (int32)
initialOwner: Type: object User
links: Type: array links
name: Type: string

Nested Schema : User

Type: object

Properties

gravatarHash: Type: string
id: Type: integer (int32)
links: Type: array links
loginName: Type: string
realname: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : Link

Type: object

Properties

href: Type: string
mediaType: Type: string
method: Type: string
profile: Type: string
rel: Type: string

Nested Schema : FieldDescriptor

Type: object

Properties

availableForNewTasks: Type: boolean

Default Value: false
description: Type: string
fieldType: Type: string

Allowed Values: [ "TEXT", "SINGLE_SELECT", "MULTI_SELECT", "LONG_TEXT", "TIMESTAMP", "TASK_REFERENCE", "CHECKBOX" ]
id: Type: integer (int32)
name: Type: string
obsolete: Type: boolean

Default Value: false
values: Type: array values

Nested Schema : values

Type: array

Items

Type: object CustomFieldValue

Nested Schema : CustomFieldValue

Type: object

Properties

id: Type: integer (int32)
isActive: Type: boolean

Default Value: false
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : components

Type: array

Items

Type: object Component

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : releases

Type: array

Nested Schema : releaseTags

Type: array

Items

Type: object ReleaseTag

Nested Schema : ReleaseTag

Type: object

Properties

id: Type: integer (int32)
links: Type: array links
value: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : Release

Type: object

Properties

id: Type: integer (int32)
links: Type: array links
product: Type: object Product
sortkey: Type: integer (int32)
value: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : Search

Type: object

Properties

defaultSort: Type: object SortInfo
id: Type: integer (int32)
isReferencedExternally: Type: boolean

Default Value: false
links: Type: array links
name: Type: string
queryString: Type: string
readAccess: Type: string

Allowed Values: [ "QUERY_OWNER", "ALL", "MEMBERS", "OWNERS" ]
writeAccess: Type: string

Allowed Values: [ "QUERY_OWNER", "ALL", "MEMBERS", "OWNERS" ]

Nested Schema : SortInfo

Type: object

Properties

sortField: Type: string
sortOrder: Type: string

Allowed Values: [ "ASCENDING", "DESCENDING" ]

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : StateTransition

Type: object

Properties

actor: Type: string
commentRequired: Type: boolean

Default Value: false
initialStatus: Type: string
newStatus: Type: string

Nested Schema : Tag

Type: object

Properties

description: Type: string
id: Type: integer (int32)
links: Type: array links
name: Type: string

Nested Schema : links

Type: array

Items

Type: object Link

Examples

The following example shows how to submitting a POST request on the REST resource using cURL 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. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

curl -i
-X GET 
-s http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/issues/v2/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 that was retrieved from the repository to update the status of an issue.