REST API for Oracle Visual Builder Studio

Create issue

post

/issues/issues/v3/issues

Create a new issue.

Request

Header Parameters

Accept: string

Default Value:

Issue to create

Root Schema : Issue

Type: object

Show Source

attachments(optional): array attachments
ccs(optional): array ccs
comments(optional): array comments
commits(optional): array commits
component(optional): object Component
creationDate(optional): string(date-time)
customFields(optional): object customFields

Additional Properties Allowed: additionalProperties
deadline(optional): string(date-time)
description(optional): string
duplicates(optional): object duplicates
estimatedTime(optional): number(double)
externalLinks(optional): array externalLinks
foundInRelease(optional): string
id(optional): integer(int32)
links(optional): array links
modificationDate(optional): string(date-time)
owner(optional): object User
priority(optional): object Priority
product(optional): object Product
release(optional): object Release
remainingTime(optional): number(double)
reporter(optional): object User
resolution(optional): object Resolution
severity(optional): object Severity
sprint(optional): object Sprint
status(optional): object Status
storyPoints(optional): number(double)
subIssues(optional): object subIssues
summary(optional): string
sumOfSubIssuesEstimatedTime(optional): number(double)
sumOfSubIssuesRemainingTime(optional): number(double)
sumOfSubIssuesStoryPoints(optional): number(double)
sumOfSubIssuesTimeSpent(optional): number(double)
tags(optional): array tags
timeSpent(optional): array timeSpent
type(optional): string
url(optional): string
version(optional): string
wikiRenderedDescription(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "version":{
            "type":"string"
        },
        "foundInRelease":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "summary":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "wikiRenderedDescription":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "estimatedTime":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesEstimatedTime":{
            "type":"number",
            "format":"double"
        },
        "remainingTime":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesRemainingTime":{
            "type":"number",
            "format":"double"
        },
        "storyPoints":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesStoryPoints":{
            "type":"number",
            "format":"double"
        },
        "deadline":{
            "type":"string",
            "format":"date-time"
        },
        "url":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "sprint":{
            "$ref":"#/definitions/Sprint"
        },
        "externalLinks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalLink"
            }
        },
        "reporter":{
            "$ref":"#/definitions/User"
        },
        "owner":{
            "$ref":"#/definitions/User"
        },
        "ccs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "severity":{
            "$ref":"#/definitions/Severity"
        },
        "status":{
            "$ref":"#/definitions/Status"
        },
        "resolution":{
            "$ref":"#/definitions/Resolution"
        },
        "priority":{
            "$ref":"#/definitions/Priority"
        },
        "release":{
            "$ref":"#/definitions/Release"
        },
        "product":{
            "$ref":"#/definitions/Product"
        },
        "component":{
            "$ref":"#/definitions/Component"
        },
        "subIssues":{
            "type":"object"
        },
        "timeSpent":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TimeSpent"
            }
        },
        "sumOfSubIssuesTimeSpent":{
            "type":"number",
            "format":"double"
        },
        "attachments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attachment"
            }
        },
        "duplicates":{
            "type":"object"
        },
        "customFields":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "commits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "comments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Comment"
            }
        }
    }
}

Nested Schema : attachments

Type: array

Show Source

Array of: object Attachment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Attachment"
    }
}

Nested Schema : ccs

Type: array

Show Source

Array of: object User

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : comments

Type: array

Show Source

Array of: object Comment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Comment"
    }
}

Nested Schema : commits

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Component

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "initialOwner":{
            "$ref":"#/definitions/User"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : customFields

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : duplicates

Type: object

Nested Schema : externalLinks

Type: array

Show Source

Array of: object ExternalLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExternalLink"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : User

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "loginName":{
            "type":"string"
        },
        "realname":{
            "type":"string"
        },
        "gravatarHash":{
            "type":"string"
        }
    }
}

Nested Schema : Priority

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Product

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isActive":{
            "type":"boolean",
            "default":false
        },
        "defaultComponent":{
            "$ref":"#/definitions/Component"
        },
        "releases":{
            "type":"array"
        },
        "components":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Component"
            }
        },
        "releaseTags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReleaseTag"
            }
        }
    }
}

Nested Schema : Release

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        },
        "product":{
            "$ref":"#/definitions/Product"
        }
    }
}

Nested Schema : Resolution

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Severity

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Sprint

Type: object

Show Source

id(optional): integer(int32)
links(optional): array links
name(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Status

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "isActive":{
            "type":"boolean",
            "default":false
        },
        "isOpen":{
            "type":"boolean",
            "default":false
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : subIssues

Type: object

Nested Schema : tags

Type: array

Show Source

Array of: object Tag

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Tag"
    }
}

Nested Schema : timeSpent

Type: array

Show Source

Array of: object TimeSpent

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TimeSpent"
    }
}

Nested Schema : Attachment

Type: object

Show Source

attachmentData(optional): array attachmentData
byteSize(optional): integer(int32)
creationDate(optional): string(date-time)
description(optional): string
filename(optional): string
id(optional): integer(int32)
issueHandle(optional): object IssueHandle
links(optional): array links
mimeType(optional): string
submitter(optional): object User
url(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "issueHandle":{
            "$ref":"#/definitions/IssueHandle"
        },
        "description":{
            "type":"string"
        },
        "filename":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "byteSize":{
            "type":"integer",
            "format":"int32"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "submitter":{
            "$ref":"#/definitions/User"
        },
        "url":{
            "type":"string"
        },
        "attachmentData":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        }
    }
}

Nested Schema : attachmentData

Type: array

Show Source

Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : IssueHandle

Type: object

Show Source

id(optional): integer(int32)
version(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "version":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href(optional): string
mediaType(optional): string
method(optional): string
profile(optional): string
rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        }
    }
}

Nested Schema : Comment

Type: object

Show Source

author(optional): object User
commentText(optional): string
creationDate(optional): string(date-time)
id(optional): integer(int32)
links(optional): array links
modificationTime(optional): string(date-time)
wikiRenderedText(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationTime":{
            "type":"string",
            "format":"date-time"
        },
        "commentText":{
            "type":"string"
        },
        "author":{
            "$ref":"#/definitions/User"
        },
        "wikiRenderedText":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ExternalLink

Type: object

Show Source

kind(optional): string
links(optional): array links
type(optional): string
uri(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "type":{
            "type":"string"
        },
        "kind":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : components

Type: array

Show Source

Array of: object Component

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Component"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : releases

Type: array

Nested Schema : releaseTags

Type: array

Show Source

Array of: object ReleaseTag

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReleaseTag"
    }
}

Nested Schema : ReleaseTag

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Tag

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeSpent

Type: object

Show Source

author(optional): object User
comment(optional): string
dateWorked(optional): string(date-time)
hoursWorked(optional): number(double)
id(optional): integer(int32)
links(optional): array links
modificationTime(optional): string(date-time)
wikiRenderedText(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "author":{
            "$ref":"#/definitions/User"
        },
        "dateWorked":{
            "type":"string",
            "format":"date-time"
        },
        "hoursWorked":{
            "type":"number",
            "format":"double"
        },
        "comment":{
            "type":"string"
        },
        "modificationTime":{
            "type":"string",
            "format":"date-time"
        },
        "wikiRenderedText":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Response

200 Response

Successful operation

Root Schema : Issue

Type: object

Show Source

attachments(optional): array attachments
ccs(optional): array ccs
comments(optional): array comments
commits(optional): array commits
component(optional): object Component
creationDate(optional): string(date-time)
customFields(optional): object customFields

Additional Properties Allowed: additionalProperties
deadline(optional): string(date-time)
description(optional): string
duplicates(optional): object duplicates
estimatedTime(optional): number(double)
externalLinks(optional): array externalLinks
foundInRelease(optional): string
id(optional): integer(int32)
links(optional): array links
modificationDate(optional): string(date-time)
owner(optional): object User
priority(optional): object Priority
product(optional): object Product
release(optional): object Release
remainingTime(optional): number(double)
reporter(optional): object User
resolution(optional): object Resolution
severity(optional): object Severity
sprint(optional): object Sprint
status(optional): object Status
storyPoints(optional): number(double)
subIssues(optional): object subIssues
summary(optional): string
sumOfSubIssuesEstimatedTime(optional): number(double)
sumOfSubIssuesRemainingTime(optional): number(double)
sumOfSubIssuesStoryPoints(optional): number(double)
sumOfSubIssuesTimeSpent(optional): number(double)
tags(optional): array tags
timeSpent(optional): array timeSpent
type(optional): string
url(optional): string
version(optional): string
wikiRenderedDescription(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "version":{
            "type":"string"
        },
        "foundInRelease":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "summary":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "wikiRenderedDescription":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "estimatedTime":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesEstimatedTime":{
            "type":"number",
            "format":"double"
        },
        "remainingTime":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesRemainingTime":{
            "type":"number",
            "format":"double"
        },
        "storyPoints":{
            "type":"number",
            "format":"double"
        },
        "sumOfSubIssuesStoryPoints":{
            "type":"number",
            "format":"double"
        },
        "deadline":{
            "type":"string",
            "format":"date-time"
        },
        "url":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "sprint":{
            "$ref":"#/definitions/Sprint"
        },
        "externalLinks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalLink"
            }
        },
        "reporter":{
            "$ref":"#/definitions/User"
        },
        "owner":{
            "$ref":"#/definitions/User"
        },
        "ccs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "severity":{
            "$ref":"#/definitions/Severity"
        },
        "status":{
            "$ref":"#/definitions/Status"
        },
        "resolution":{
            "$ref":"#/definitions/Resolution"
        },
        "priority":{
            "$ref":"#/definitions/Priority"
        },
        "release":{
            "$ref":"#/definitions/Release"
        },
        "product":{
            "$ref":"#/definitions/Product"
        },
        "component":{
            "$ref":"#/definitions/Component"
        },
        "subIssues":{
            "type":"object"
        },
        "timeSpent":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TimeSpent"
            }
        },
        "sumOfSubIssuesTimeSpent":{
            "type":"number",
            "format":"double"
        },
        "attachments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attachment"
            }
        },
        "duplicates":{
            "type":"object"
        },
        "customFields":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "commits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "comments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Comment"
            }
        }
    }
}

Nested Schema : attachments

Type: array

Show Source

Array of: object Attachment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Attachment"
    }
}

Nested Schema : ccs

Type: array

Show Source

Array of: object User

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : comments

Type: array

Show Source

Array of: object Comment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Comment"
    }
}

Nested Schema : commits

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Component

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "initialOwner":{
            "$ref":"#/definitions/User"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : customFields

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : duplicates

Type: object

Nested Schema : externalLinks

Type: array

Show Source

Array of: object ExternalLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ExternalLink"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : User

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "loginName":{
            "type":"string"
        },
        "realname":{
            "type":"string"
        },
        "gravatarHash":{
            "type":"string"
        }
    }
}

Nested Schema : Priority

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Product

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isActive":{
            "type":"boolean",
            "default":false
        },
        "defaultComponent":{
            "$ref":"#/definitions/Component"
        },
        "releases":{
            "type":"array"
        },
        "components":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Component"
            }
        },
        "releaseTags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReleaseTag"
            }
        }
    }
}

Nested Schema : Release

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        },
        "product":{
            "$ref":"#/definitions/Product"
        }
    }
}

Nested Schema : Resolution

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Severity

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Sprint

Type: object

Show Source

id(optional): integer(int32)
links(optional): array links
name(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Status

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "isActive":{
            "type":"boolean",
            "default":false
        },
        "isOpen":{
            "type":"boolean",
            "default":false
        },
        "sortkey":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : subIssues

Type: object

Nested Schema : tags

Type: array

Show Source

Array of: object Tag

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Tag"
    }
}

Nested Schema : timeSpent

Type: array

Show Source

Array of: object TimeSpent

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TimeSpent"
    }
}

Nested Schema : Attachment

Type: object

Show Source

attachmentData(optional): array attachmentData
byteSize(optional): integer(int32)
creationDate(optional): string(date-time)
description(optional): string
filename(optional): string
id(optional): integer(int32)
issueHandle(optional): object IssueHandle
links(optional): array links
mimeType(optional): string
submitter(optional): object User
url(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "issueHandle":{
            "$ref":"#/definitions/IssueHandle"
        },
        "description":{
            "type":"string"
        },
        "filename":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "byteSize":{
            "type":"integer",
            "format":"int32"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "submitter":{
            "$ref":"#/definitions/User"
        },
        "url":{
            "type":"string"
        },
        "attachmentData":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        }
    }
}

Nested Schema : attachmentData

Type: array

Show Source

Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : IssueHandle

Type: object

Show Source

id(optional): integer(int32)
version(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "version":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href(optional): string
mediaType(optional): string
method(optional): string
profile(optional): string
rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        }
    }
}

Nested Schema : Comment

Type: object

Show Source

author(optional): object User
commentText(optional): string
creationDate(optional): string(date-time)
id(optional): integer(int32)
links(optional): array links
modificationTime(optional): string(date-time)
wikiRenderedText(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationTime":{
            "type":"string",
            "format":"date-time"
        },
        "commentText":{
            "type":"string"
        },
        "author":{
            "$ref":"#/definitions/User"
        },
        "wikiRenderedText":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ExternalLink

Type: object

Show Source

kind(optional): string
links(optional): array links
type(optional): string
uri(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "type":{
            "type":"string"
        },
        "kind":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : components

Type: array

Show Source

Array of: object Component

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Component"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : releases

Type: array

Nested Schema : releaseTags

Type: array

Show Source

Array of: object ReleaseTag

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReleaseTag"
    }
}

Nested Schema : ReleaseTag

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Tag

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeSpent

Type: object

Show Source

author(optional): object User
comment(optional): string
dateWorked(optional): string(date-time)
hoursWorked(optional): number(double)
id(optional): integer(int32)
links(optional): array links
modificationTime(optional): string(date-time)
wikiRenderedText(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32"
        },
        "author":{
            "$ref":"#/definitions/User"
        },
        "dateWorked":{
            "type":"string",
            "format":"date-time"
        },
        "hoursWorked":{
            "type":"number",
            "format":"double"
        },
        "comment":{
            "type":"string"
        },
        "modificationTime":{
            "type":"string",
            "format":"date-time"
        },
        "wikiRenderedText":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

400 Response

Invalid issue property

Root Schema : RestException

Type: object

Show Source

cause(optional): object Throwable
detail(optional): string
localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
status(optional): integer(int32)
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "cause":{
            "$ref":"#/definitions/Throwable"
        },
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Throwable"
            }
        }
    }
}

Nested Schema : Throwable

Type: object

Show Source

localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array"
        }
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Show Source

Array of: object Throwable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Throwable"
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Nested Schema : StackTraceElement

Type: object

Show Source

className(optional): string
fileName(optional): string
lineNumber(optional): integer(int32)
methodName(optional): string
nativeMethod(optional): boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "methodName":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "lineNumber":{
            "type":"integer",
            "format":"int32"
        },
        "className":{
            "type":"string"
        },
        "nativeMethod":{
            "type":"boolean",
            "default":false
        }
    }
}

404 Response

Unknown issue property

Root Schema : RestException

Type: object

Show Source

cause(optional): object Throwable
detail(optional): string
localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
status(optional): integer(int32)
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "cause":{
            "$ref":"#/definitions/Throwable"
        },
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Throwable"
            }
        }
    }
}

Nested Schema : Throwable

Type: object

Show Source

localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array"
        }
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Show Source

Array of: object Throwable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Throwable"
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Nested Schema : StackTraceElement

Type: object

Show Source

className(optional): string
fileName(optional): string
lineNumber(optional): integer(int32)
methodName(optional): string
nativeMethod(optional): boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "methodName":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "lineNumber":{
            "type":"integer",
            "format":"int32"
        },
        "className":{
            "type":"string"
        },
        "nativeMethod":{
            "type":"boolean",
            "default":false
        }
    }
}

406 Response

Media type not acceptable

Root Schema : RestException

Type: object

Show Source

cause(optional): object Throwable
detail(optional): string
localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
status(optional): integer(int32)
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "cause":{
            "$ref":"#/definitions/Throwable"
        },
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Throwable"
            }
        }
    }
}

Nested Schema : Throwable

Type: object

Show Source

localizedMessage(optional): string
message(optional): string
stackTrace(optional): array stackTrace
suppressed(optional): array suppressed

{
    "type":"object",
    "properties":{
        "stackTrace":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StackTraceElement"
            }
        },
        "message":{
            "type":"string"
        },
        "localizedMessage":{
            "type":"string"
        },
        "suppressed":{
            "type":"array"
        }
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Show Source

Array of: object Throwable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Throwable"
    }
}

Nested Schema : stackTrace

Type: array

Show Source

Array of: object StackTraceElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StackTraceElement"
    }
}

Nested Schema : suppressed

Type: array

Nested Schema : StackTraceElement

Type: object

Show Source

className(optional): string
fileName(optional): string
lineNumber(optional): integer(int32)
methodName(optional): string
nativeMethod(optional): boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "methodName":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "lineNumber":{
            "type":"integer",
            "format":"int32"
        },
        "className":{
            "type":"string"
        },
        "nativeMethod":{
            "type":"boolean",
            "default":false
        }
    }
}

Examples

The following example shows how to create a VB Studio issue by submitting a POST request on the REST resource using curl. The example uses an input file, issues-new, that contains the complete JSON representation of the issue to be created.


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

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 POST and PUT 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.


{"issue":{
  "links":[
    {"rel":"self",
     "href":"https://myinstance.oraclecloud.com/myorg-org/rest/myorg_pubapi_203132/issues/v3/issues/1"},
    {"rel":"canonical",
     "href":"https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/issues/1"},
    {"rel":"create-form",
     "href":"https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/issues/create-form"},
    {"rel":"collection",
     "href":"https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/issues"},
    {"rel":"search-form",
     "href":"https://myinstance.oraclecloud.com/myorg/rest/myorg_pubapi_203132/issues/v3/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":"https://myinstance.oraclecloud.com/myorg/rest/myorg_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":"UNCONFIRMED",
    "isActive":true,
    "isOpen":true,
    "sortkey":100},
  "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":[]
}}