Demisto Incidentfields API

openapi: 3.2.0
info:
  description: 'This is the public REST API to integrate with the demisto server.

    HTTP request can be sent using any HTTP-client.


    For an example dedicated client take a look at: https://github.com/demisto/demisto-py.


    Requests must include API-key that can be generated in the Demisto web client under ''Settings'' -> ''Integrations'' -> ''API keys''



    Optimistic Locking and Versioning\:


    When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item).

    In addition, you can pass ''version\: -1'' to force data override (make sure that other users data might be lost).


    Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s?

    To solve this, each data item in Demisto has a numeric incremental version.

    If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error.

    Bob will need to get the latest item and work on it so Alice work will not get lost.


    Example request using ''curl''\:


    ```

    curl ''https://hostname:443/incidents/search'' -H ''content-type: application/json'' -H ''accept: application/json'' -H ''Authorization: <API Key goes here>'' --data-binary ''{"filter":{"query":"-status:closed -category:job","period":{"by":"day","fromValue":7}}}'' --compressed

    ```'
  title: Demisto Apikeys Incidentfields API
  version: 2.0.0
servers:
- url: https://hostname:443
security:
- api_key: []
- csrf_token: []
- x-xdr-auth-id: []
tags:
- name: Incidentfields
paths:
  /incidentfields/associatedTypes/{type}:
    get:
      description: Get all incident fields associated with incident type
      summary: Get all incident fields associated with incident type
      operationId: getIncidentsFieldsByIncidentType
      parameters:
      - description: the name (case sensitive) of the incident type
        name: type
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a list of incident fields associated with the incident type
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IncidentField'
      tags:
      - Incidentfields
  /incidentfields/import:
    post:
      description: Import an incidents field to Cortex XSOAR
      summary: Import an incidents field
      operationId: importIncidentFields
      responses:
        '200':
          description: The saved incident field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentField'
      tags:
      - Incidentfields
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: file
                  format: binary
              required:
              - file
components:
  schemas:
    GridColumn:
      type: object
      title: GridColumn ...
      properties:
        displayName:
          type: string
          x-go-name: DisplayName
        fieldCalcScript:
          type: string
          x-go-name: FieldCalcScript
        isDefault:
          type: boolean
          x-go-name: IsDefault
        isReadOnly:
          type: boolean
          x-go-name: IsReadOnly
        key:
          type: string
          x-go-name: Key
        required:
          type: boolean
          x-go-name: Required
        script:
          type: string
          x-go-name: Script
        selectValues:
          type: array
          items:
            type: string
          x-go-name: SelectValues
        type:
          type: string
          x-go-name: Type
        width:
          type: integer
          format: int64
          x-go-name: Width
      x-go-package: github.com/demisto/server/domain
    FieldGroup:
      description: FieldGroup is the field group
      type: number
      format: double
      x-go-package: github.com/demisto/server/domain
    IncidentField:
      type: object
      title: IncidentField ...
      properties:
        associatedToAll:
          type: boolean
          x-go-name: AssociatedToAll
        associatedTypes:
          description: AssociatedTypes - list of incident (case) types IDs related to specific incident field
          type: array
          items:
            type: string
          x-go-name: AssociatedTypes
        breachScript:
          type: string
          x-go-name: BreachScript
        caseInsensitive:
          type: boolean
          x-go-name: CaseInsensitive
        cliName:
          type: string
          x-go-name: CliName
        closeForm:
          type: boolean
          x-go-name: CloseForm
        columns:
          type: array
          items:
            $ref: '#/components/schemas/GridColumn'
          x-go-name: GridColumns
        commitMessage:
          type: string
          x-go-name: CommitMessage
        content:
          type: boolean
          x-go-name: Content
        defaultRows:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
          x-go-name: DefaultRows
        description:
          type: string
          x-go-name: Description
        editForm:
          type: boolean
          x-go-name: EditForm
        fieldCalcScript:
          type: string
          x-go-name: FieldCalcScript
        group:
          $ref: '#/components/schemas/FieldGroup'
        hidden:
          type: boolean
          x-go-name: Hidden
        id:
          type: string
          x-go-name: ID
        isReadOnly:
          type: boolean
          x-go-name: IsReadOnly
        locked:
          type: boolean
          x-go-name: Locked
        modified:
          type: string
          format: date-time
          x-go-name: Modified
        name:
          type: string
          x-go-name: Name
        neverSetAsRequired:
          type: boolean
          x-go-name: NeverSetAsRequired
        ownerOnly:
          type: boolean
          x-go-name: OwnerOnly
        placeholder:
          type: string
          x-go-name: Placeholder
        prevName:
          type: string
          x-go-name: PrevName
        required:
          type: boolean
          x-go-name: Required
        script:
          type: string
          x-go-name: Script
        selectValues:
          type: array
          items:
            type: string
          x-go-name: SelectValues
        shouldCommit:
          type: boolean
          x-go-name: ShouldCommit
        sla:
          type: integer
          format: int64
          x-go-name: SLA
        sortValues:
          type: array
          items:
            type: string
          x-go-name: SortValues
        system:
          type: boolean
          x-go-name: System
        systemAssociatedTypes:
          type: array
          items:
            type: string
          x-go-name: SystemAssociatedTypes
        threshold:
          type: number
          format: double
          x-go-name: Threshold
        type:
          type: string
          x-go-name: Type
        unmapped:
          type: boolean
          x-go-name: Unmapped
        unsearchable:
          type: boolean
          x-go-name: UnSearchable
        useAsKpi:
          type: boolean
          x-go-name: UseAsKpi
        validatedError:
          type: string
          x-go-name: ValidatedError
        validationRegex:
          type: string
          x-go-name: ValidationRegex
        vcShouldIgnore:
          type: boolean
          x-go-name: VCShouldIgnore
        version:
          type: integer
          format: int64
          x-go-name: Versn
      x-go-package: github.com/demisto/server/domain
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    csrf_token:
      type: apiKey
      name: X-XSRF-TOKEN
      in: header
    x-xdr-auth-id:
      type: apiKey
      name: x-xdr-auth-id
      in: header