Get issue metadata
/issues/issues/v3/repository
Request
-
fields(optional): string
List of requested fields
-
Accept: string
Default Value:
object
-
country(optional):
string
-
displayCountry(optional):
string
-
displayLanguage(optional):
string
-
displayName(optional):
string
-
displayScript(optional):
string
-
displayVariant(optional):
string
-
extensionKeys(optional):
array extensionKeys
Unique Items Required:
true
-
iso3Country(optional):
string
-
iso3Language(optional):
string
-
language(optional):
string
-
script(optional):
string
-
unicodeLocaleAttributes(optional):
array unicodeLocaleAttributes
Unique Items Required:
true
-
unicodeLocaleKeys(optional):
array unicodeLocaleKeys
Unique Items Required:
true
-
variant(optional):
string
object
object
Response
200 Response
object
-
attachmentUploadUrl(optional):
string
-
components(optional):
array components
-
configurationProperties(optional):
object configurationProperties
Additional Properties Allowed: additionalProperties
-
customFields(optional):
array customFields
-
defaultPriority(optional):
object Priority
-
defaultProduct(optional):
object Product
-
defaultResolution(optional):
object Resolution
-
defaultSeverity(optional):
object Severity
-
defaultStatus(optional):
object Status
-
defaultType(optional):
string
-
links(optional):
array links
-
priorities(optional):
array priorities
-
products(optional):
array products
-
releases(optional):
array releases
-
resolutions(optional):
array resolutions
-
searches(optional):
array searches
-
severities(optional):
array severities
-
stateTransitions(optional):
array stateTransitions
-
statuses(optional):
array statuses
-
tags(optional):
array tags
-
types(optional):
array types
-
url(optional):
string
-
users(optional):
array users
object
-
components(optional):
array components
-
defaultComponent(optional):
object Component
-
description(optional):
string
-
id(optional):
integer(int32)
-
isActive(optional):
boolean
Default Value:
false
-
links(optional):
array links
-
name(optional):
string
-
releases(optional):
array releases
-
releaseTags(optional):
array releaseTags
object
-
id(optional):
integer(int32)
-
isActive(optional):
boolean
Default Value:
false
-
isOpen(optional):
boolean
Default Value:
false
-
links(optional):
array links
-
sortkey(optional):
integer(int32)
-
value(optional):
string
object
-
availableForNewTasks(optional):
boolean
Default Value:
false
-
description(optional):
string
-
fieldType(optional):
string
Allowed Values:
[ "TEXT", "SINGLE_SELECT", "MULTI_SELECT", "LONG_TEXT", "TIMESTAMP", "TASK_REFERENCE", "CHECKBOX" ]
-
id(optional):
integer(int32)
-
name(optional):
string
-
obsolete(optional):
boolean
Default Value:
false
-
values(optional):
array values
array
object
-
defaultSort(optional):
object SortInfo
-
id(optional):
integer(int32)
-
isReferencedExternally(optional):
boolean
Default Value:
false
-
links(optional):
array links
-
name(optional):
string
-
queryString(optional):
string
-
readAccess(optional):
string
Allowed Values:
[ "QUERY_OWNER", "SELECTED_MEMBERS", "ALL" ]
-
writeAccess(optional):
string
Allowed Values:
[ "QUERY_OWNER", "SELECTED_MEMBERS", "ALL" ]
object
-
sortField(optional):
string
-
sortOrder(optional):
string
Allowed Values:
[ "ASCENDING", "DESCENDING" ]
406 Response
array
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.