Skip to main content

Add New Case

POST 
/cases

Adds new case; available as an Add-On Module

Request​

Query Parameters

    siteId string

    Site Identifier

Body

required

    case

    object

    required

    name stringrequired

    Case Name

    status CaseStatus (string)

    Status of the Case

    Possible values: [NEW, ASSIGNED, IN_PROGRESS, ON_HOLD, ESCALATED, RESOLVED, CLOSED, UNDER_REVIEW, AWAITING_CLIENT_RESPONSE]

    plannedStartDate string

    Planned Start Date

    startDate string

    Start Date

    endDate string

    End Date

    dueDate string

    Due Date

    description string

    Case Description

    documentNumberFormat

    object[]

    Format of Document Number

  • Array [

    • type StringGeneratorType (string)

    Generate Strings of Type

    Possible values: [AUTO_INCREMENT, STATIC, DATE_YYYYMMDD]

    staticValue string

    Static Value

    padding integer

    Optional padding for AUTO_INCREMENT number

  • ]

    • caseNumberFormat

    object[]

    Format of Case Number

  • Array [

    • type StringGeneratorType (string)

    Generate Strings of Type

    Possible values: [AUTO_INCREMENT, STATIC, DATE_YYYYMMDD]

    staticValue string

    Static Value

    padding integer

    Optional padding for AUTO_INCREMENT number

  • ]

    • metadata

    object

    documentIds string[]

Responses​

200 OK

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    caseId string

    Case Identifier

Loading...