1. REST API for Oracle Visual Builder Studio
  2. Tasks
  3. Issues
  4. Issues

Update issue

put

/issues/issues/v3/issues/{issueId}

Update an issue with new information.

Request

Header Parameters
Body ()
Issue to update
Root Schema : Issue
Type: object
Show Source
Nested Schema : attachments
Type: array
Show Source
Nested Schema : ccs
Type: array
Show Source
Nested Schema : comments
Type: array
Show Source
Nested Schema : commits
Type: array
Show Source
Nested Schema : Component
Type: object
Show Source
Nested Schema : customFields
Type: object
Additional Properties Allowed
Show Source
Nested Schema : duplicates
Type: object
Nested Schema : User
Type: object
Show Source
Nested Schema : Priority
Type: object
Show Source
Nested Schema : Product
Type: object
Show Source
Nested Schema : Release
Type: object
Show Source
Nested Schema : Resolution
Type: object
Show Source
Nested Schema : Severity
Type: object
Show Source
Nested Schema : Sprint
Type: object
Show Source
Nested Schema : Status
Type: object
Show Source
Nested Schema : subIssues
Type: object
Nested Schema : tags
Type: array
Show Source
Nested Schema : timeSpent
Type: array
Show Source
Nested Schema : Attachment
Type: object
Show Source
Nested Schema : attachmentData
Type: array
Show Source
Nested Schema : IssueHandle
Type: object
Show Source
Nested Schema : Comment
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 : Tag
Type: object
Show Source
Nested Schema : TimeSpent
Type: object
Show Source
Back to Top

Response

200 Response

Successful operation
Body ()
Root Schema : Issue
Type: object
Show Source
Nested Schema : attachments
Type: array
Show Source
Nested Schema : ccs
Type: array
Show Source
Nested Schema : comments
Type: array
Show Source
Nested Schema : commits
Type: array
Show Source
Nested Schema : Component
Type: object
Show Source
Nested Schema : customFields
Type: object
Additional Properties Allowed
Show Source
Nested Schema : duplicates
Type: object
Nested Schema : User
Type: object
Show Source
Nested Schema : Priority
Type: object
Show Source
Nested Schema : Product
Type: object
Show Source
Nested Schema : Release
Type: object
Show Source
Nested Schema : Resolution
Type: object
Show Source
Nested Schema : Severity
Type: object
Show Source
Nested Schema : Sprint
Type: object
Show Source
Nested Schema : Status
Type: object
Show Source
Nested Schema : subIssues
Type: object
Nested Schema : tags
Type: array
Show Source
Nested Schema : timeSpent
Type: array
Show Source
Nested Schema : Attachment
Type: object
Show Source
Nested Schema : attachmentData
Type: array
Show Source
Nested Schema : IssueHandle
Type: object
Show Source
Nested Schema : Comment
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 : Tag
Type: object
Show Source
Nested Schema : TimeSpent
Type: object
Show Source

400 Response

Invalid issue property
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

404 Response

Unknown issue property
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

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

409 Response

Concurrent update
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 example on this page shows how to update the status of an issue from "UNCONFIRMED" to "NEW" by submitting a PUT request on the REST resource using curl.


curl -i
-X PUT 
-s 
-H "Accept: application/vnd.oracle.resource+json" -H "Content-type: application/vnd.oracle.resource+json" 
-d@issue 
https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/issues/1

Before this command could be issued, several actions must have preceded it:

  1. Retrieve the value of the "status" object from the issues repository.

    The "status" property is an object with its own properties. The entire object must be an exact match with one of the status objects in the repository database. The issue was initially created with a status of "UNCONFIRMED", which is the object:

    
{"id":1,"value":"UNCONFIRMED","isActive":true,"isOpen":true,"sortkey":100}

    To update the status to "NEW", you must specify the entire JSON representation that corresponds to the "NEW" status. To do that, you must know the value of all its properties. To retrieve the value, you query the issues/v3/repository resource and use the "field=" query parameter to limit the results that are returned. The server will return only the objects that pertain to "status". The example for the Return repository data endpoint shows how to perform this query.

    The query returns data for every possible status, including the following object for "NEW":

    
{"id":2,"value":"NEW","isActive":true,"isOpen":true,"sortkey":200},

  2. Retrieve the issue (1) and save its JSON representation in a file (issue). 

    
curl -i 
-X GET 
-H "Accept: application/vnd.oracle.resource+json" -H "Content-type: application/vnd.oracle.resource+json"
-s https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_2031372/issues/v3/issues/1 >issue

  3. Edit the file:

    1. Remove the root resource "issue" and the trailing closing curly brace (}).

    2. Replace the "status" JSON object with the object that corresponds to "NEW", copying its value from the response to the query made to the repository.

    3. Save the file.

  4. Update the issue with the PUT request that is shown at the top of the page.

    Notice that the command uses ?H parameters to specify the Accept and Content-type for the body of the response. These parameters must be specified for all Issues API PUT and POST operations.

Example of Response Header

The following shows an example of the response header.


200 Successful Operation
Content-Type: application/vnd.oracle.resource+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,if the request was successful. The entire JSON representation for the newly created issue is returned in a single line. The output has been formatted to improve readability. The updated status is shown in bold. 


{"issue":{
  "links":[
    {"rel":"self",
     "href":"http://developer.us.oraclecloud.com/dev-org-org/rest/dev-org_pubapi_203132/issues/v2/issues/1"},
    {"rel":"canonical",
     "href":"http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/issues/v2/issues/1"},
    {"rel":"create-form",
     "href":"http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/issues/v2/issues/create-form"},
    {"rel":"collection",
     "href":"http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/issues/v2/issues"},
    {"rel":"search-form",
     "href":"http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/issues/v2/issues/search-form"}
  ],
  "id":1,
  "version":"1498782045181",
  "creationDate":1498782045175,
  "modificationDate":1498782045181,
  "summary":"New Story",
  "description":"",
  "wikiRenderedDescription":"",
  "tags":[],
  "sumOfSubIssuesEstimatedTime":0,
  "remainingTime":0,
  "sumOfSubIssuesRemainingTime":0,
  "sumOfSubIssuesStoryPoints":0,
  "url":"http://developer.us.oraclecloud.com/dev-org/rest/dev-org_pubapi_203132/task/1",
  "type":"Story",
  "externalLinks":[],
  "reporter":{
    "id":1,
    "loginName":"joe@example.com",
    "realname":"Joe",
    "gravatarHash":"68aa64f7d0abfd8929c261f78b60fd27"},
  "ccs":[
    {"id":1,
     "loginName":"joe@example.com",
     "realname":"Joe",
     "gravatarHash":"68aa64f7d0abfd8929c261f78b60fd27"}
   ],
  "severity":{
    "id":4,
    "value":"normal",
    "sortkey":400},
  "status":{ "id":1, "value":"NEW", "isActive":true, "isOpen":true, "sortkey":200},
  "priority":{
    "id":3,
    "value":"Normal",
    "sortkey":300},
  "release":{
    "id":1,
    "value":"---",
    "sortkey":0,
    "product":{
      "id":1}
    },
  "product":{
    "id":1,
    "name":"Default",
    "description":"default product",
    "isActive":true},
  "subIssues":[],
  "timeSpent":[],
  "sumOfSubIssuesTimeSpent":0,
  "attachments":[],
  "duplicates":[],
  "customFields":{
    "iteration":"---"},
  "commits":[],
  "comments":[]
}}
Back to Top