All API categories

    Cases API

    8 endpoints

    Case management endpoints.

    GET
    Auth Required

    Build the base path for cases endpoints / function basePath(collectionId: string, appId: string, admin: boolean = false)

    Build the base path for cases endpoints / function basePath(collectionId: string, appId: string, admin: boolean = false)

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/records

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Build the base path for cases endpoints / function basePath(collectionId: string, appId: string, admin: boolean = false)

    Build the base path for cases endpoints / function basePath(collectionId: string, appId: string, admin: boolean = false)

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/records

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    body
    body
    CreateCaseInput
    Required

    See CreateCaseInput schema

    Responses

    200
    Success
    {
  "schema": "AppCase"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Soft delete a case DELETE /cases/:caseId / export async function remove( collectionId: string, appId: string, caseId: st

    Soft delete a case DELETE /cases/:caseId / export async function remove( collectionId: string, appId: string, caseId: st

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/recordse)}/summary

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    body
    body
    CaseSummaryRequest
    Required

    See CaseSummaryRequest schema

    Responses

    200
    Success
    {
  "schema": "CaseSummaryResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Get aggregate statistics for cases POST /cases/aggregate / export async function aggregate( collectionId: string, appId:

    Get aggregate statistics for cases POST /cases/aggregate / export async function aggregate( collectionId: string, appId:

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/recordse)}/{caseId}/history

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    caseId
    path
    string
    Required
    body
    body
    AppendHistoryInput
    Required

    See AppendHistoryInput schema

    Responses

    200
    Success
    {
  "schema": "AppCase"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Update a case PATCH /cases/:caseId Admin can update any field, public (owner) can only update data and owner zones / exp

    Update a case PATCH /cases/:caseId Admin can update any field, public (owner) can only update data and owner zones / exp

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/aggregate

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    body
    body
    AggregateRequest
    Required

    See AggregateRequest schema

    Responses

    200
    Success
    {
  "schema": "AggregateResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Create a new case POST /cases / export async function create( collectionId: string, appId: string, input: CreateCaseInpu

    Create a new case POST /cases / export async function create( collectionId: string, appId: string, input: CreateCaseInpu

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/{caseId}

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    caseId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AppCase"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PATCH
    Auth Required

    List cases with optional query parameters GET /cases / export async function list( collectionId: string, appId: string,

    List cases with optional query parameters GET /cases / export async function list( collectionId: string, appId: string,

    Endpoint

    /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/{caseId}

    Parameters

    zone
    path
    string
    Required
    collectionId
    path
    string
    Required
    appId
    path
    string
    Required
    caseId
    path
    string
    Required
    body
    body
    UpdateCaseInput
    Required

    See UpdateCaseInput schema

    Responses

    200
    Success
    {
  "schema": "AppCase"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found