Jump to

• Request
• Response

Get form for creating an issue

get

/issues/v3/issues/create-form

Return the template, which contains all fields, that's used to create a new issue.

Request

Header Parameters

• Accept(required): string
  Default Value:

Body ()

Root Schema : HttpServletResponse

Type: object

Show Source

• bufferSize: integer(int32)
• characterEncoding: string
• committed: boolean
  Default Value: false
• contentType: string
• locale: object Locale
• outputStream: object ServletOutputStream
• writer: object PrintWriter

{
    "type":"object",
    "properties":{
        "locale":{
            "$ref":"#/definitions/Locale"
        },
        "contentType":{
            "type":"string"
        },
        "outputStream":{
            "$ref":"#/definitions/ServletOutputStream"
        },
        "writer":{
            "$ref":"#/definitions/PrintWriter"
        },
        "committed":{
            "type":"boolean",
            "default":false
        },
        "bufferSize":{
            "type":"integer",
            "format":"int32"
        },
        "characterEncoding":{
            "type":"string"
        }
    }
}

Nested Schema : Locale

Type: object

Show Source

• country: string
• displayCountry: string
• displayLanguage: string
• displayName: string
• displayScript: string
• displayVariant: string
• extensionKeys: array extensionKeys
  Unique Items Required: true
• iso3Country: string
• iso3Language: string
• language: string
• script: string
• unicodeLocaleAttributes: array unicodeLocaleAttributes
  Unique Items Required: true
• unicodeLocaleKeys: array unicodeLocaleKeys
  Unique Items Required: true
• variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "extensionKeys":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleAttributes":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : ServletOutputStream

Type: object

Nested Schema : PrintWriter

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Back to Top

Response

200 Response

Successful operation

Body ()

Root Schema : CreateIssue

Type: object

Show Source

• component: object Component
• links: array links
• priority: object Priority
• product: object Product
• release: object Release
• resolution: object Resolution
• severity: object Severity
• status: object Status
• summary: string
• type: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "summary":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "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"
        }
    }
}

Nested Schema : Component

Type: object

Show Source

• description: string
• id: integer(int32)
• initialOwner: object User
• links: array links
• name: 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 : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Priority

Type: object

Show Source

• id: integer(int32)
• links: array links
• sortkey: integer(int32)
• value: 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: array components
• defaultComponent: object Component
• description: string
• id: integer(int32)
• isActive: boolean
  Default Value: false
• links: array links
• name: string
• releases: array releases
• releaseTags: 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: integer(int32)
• links: array links
• product: object Product
• sortkey: integer(int32)
• value: 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: integer(int32)
• links: array links
• sortkey: integer(int32)
• value: 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: integer(int32)
• links: array links
• sortkey: integer(int32)
• value: 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 : Status

Type: object

Show Source

• id: integer(int32)
• isActive: boolean
  Default Value: false
• isOpen: boolean
  Default Value: false
• links: array links
• sortkey: integer(int32)
• value: 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 : User

Type: object

Show Source

• gravatarHash: string
• id: integer(int32)
• links: array links
• loginName: string
• realname: 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 : 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 : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string

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

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: integer(int32)
• links: array links
• value: 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"
    }
}

406 Response

Media type not acceptable

Body ()

Root Schema : RestException

Type: object

Show Source

• cause: object Throwable
• detail: string
• localizedMessage: string
• message: string
• stackTrace: array stackTrace
• status: integer(int32)
• suppressed: 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: string
• message: string
• stackTrace: array stackTrace
• suppressed: 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: string
• fileName: string
• lineNumber: integer(int32)
• methodName: string
• nativeMethod: 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
        }
    }
}

Back to Top