Jump to

• Request
• Response

Get query description for searching issues

get

/issues/v3/issues/search-form

Return the form for the query that was used to search for an issue (or issues).

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 : SearchIssue

Type: object

Show Source

• links: array links
• searchFields: object searchFields
  Additional Properties Allowed: SearchFieldObject
• syntax: object SearchSyntax

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "syntax":{
            "$ref":"#/definitions/SearchSyntax"
        },
        "searchFields":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/SearchFieldObject"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : searchFields

Type: object

Additional Properties Allowed

Show Source

• object SearchFieldObject

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/SearchFieldObject"
    }
}

Nested Schema : SearchSyntax

Type: object

Show Source

• logicalOperators: object logicalOperators
  Additional Properties Allowed: Oper
• operators: object operators
  Additional Properties Allowed: Oper
• precedenceGrouping: string
• termDelimiter: array termDelimiter

{
    "type":"object",
    "properties":{
        "operators":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/Oper"
            }
        },
        "logicalOperators":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/Oper"
            }
        },
        "termDelimiter":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "precedenceGrouping":{
            "type":"string"
        }
    }
}

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 : SearchFieldObject

Type: object

Show Source

• example: string
• operators: array operators
  Read Only: true

{
    "type":"object",
    "properties":{
        "example":{
            "type":"string"
        },
        "operators":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : operators

Type: array

Read Only: true

Show Source

• Array of: string

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

Nested Schema : logicalOperators

Type: object

Additional Properties Allowed

Show Source

• object Oper

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/Oper"
    }
}

Nested Schema : operators

Type: object

Additional Properties Allowed

Show Source

• object Oper

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/Oper"
    }
}

Nested Schema : termDelimiter

Type: array

Show Source

• Array of: string

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

Nested Schema : Oper

Type: object

Show Source

• code: array code
• description: string
• example: string
• types: array types

{
    "type":"object",
    "properties":{
        "code":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "type":"string"
        },
        "example":{
            "type":"string"
        }
    }
}

Nested Schema : code

Type: array

Show Source

• Array of: string

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

Nested Schema : types

Type: array

Show Source

• Array of: string

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

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