Class Briefcase

create

• create(
      caseTypeId: number,
      subTypeId: number,
      options?: Object,
  ): Promise<Briefcase>

  Create new case

  Parameters

  • caseTypeId: number

    The case Type ID

  • subTypeId: number

    The case subType ID

  • Optionaloptions: Object

    See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase

  Returns Promise<Briefcase>

  Returns Promise that represents an object describing the newly-created case

createChild

• createChild(
      busCaseId: number,
      parentCaObjectId: number,
      options?: Object,
  ): Promise<Briefcase>

  Create a child case

  Parameters

  • busCaseId: number

    The case Type ID

  • parentCaObjectId: number

    The case subType ID

  • Optionaloptions: Object

    See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase

  Returns Promise<Briefcase>

  Returns Promise that represents an object describing the newly-created case

createFromRequest

• createFromRequest(
      caseTypeId: number,
      subTypeId: number,
      requestId: number,
      options?: Object,
  ): Promise<unknown>

  Create a case from a Service Request

  Parameters

  • caseTypeId: number

    The case Type ID

  • subTypeId: number

    The case subType ID

  • requestId: number

    The service request ID

  • Optionaloptions: Object

    See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase

  Returns Promise<unknown>

  Returns Promise that represents an object describing the newly-created case

delete

• delete(caObjectId: number): Promise<unknown>

  Delete case

  Parameters

  • caObjectId: number

    The case Object ID

  Returns Promise<unknown>

  Returns Promise that represents an object describing the deleted case

deleteMLFs

• deleteMLFs(caObjectId: number): Promise<unknown>

  Delete Map Layer Fields

  Parameters

  • caObjectId: number

    The case object ID to delete the map layer fields for.

  Returns Promise<unknown>

  Returns Promise that represents a collection of Objects describing the case object map layer fields deleted

getById

• getById(caObjectId: number): Promise<Briefcase>

  Get case by ID

  Parameters

  • caObjectId: number

    The case Object ID to get

  Returns Promise<Briefcase>

  Returns Promise that represents an object describing the case

getByIds

• getByIds(caObjectIds: number[]): Promise<Briefcase[]>

  Get cases by IDs

  Parameters

  • caObjectIds: number[]

    The case Object IDs to get

  Returns Promise<Briefcase[]>

  Returns Promise that represents a collection of objects describing the cases

getCountries

• getCountries(): Promise<unknown>

  Get the configured countries for the install

  Returns Promise<unknown>

  Returns Promise that represents a collection of countries configured for the install

getCustomData

• getCustomData(
      caObjectId: number,
      configId: number,
      tableName: string,
  ): Promise<any[]>

  Get the configured custom data for the case, by template and table name

  Parameters

  • caObjectId: number

    The case Object ID to get

  • configId: number

    The configuration ID to get use

  • tableName: string

    The name of the table to get custom data from

  Returns Promise<any[]>

  Returns Promise that represents a collection of custom fields with data for the case instance

getMLFs

• getMLFs(caObjectId: number): Promise<unknown>

  Get Map Layer Fields

  Parameters

  • caObjectId: number

    The case object ID to get the map layer fields for.

  Returns Promise<unknown>

  Returns Promise that represents a collection of Objects describing the case object map layer fields

getPrintTemplates

• getPrintTemplates(caObjectId: number): Promise<unknown>

  Reports available for Case

  Parameters

  • caObjectId: number

    The case object ID to get the report (print template) list for

  Returns Promise<unknown>

  Returns Promise that represents a collection of Objects describing the reports (print templates) available for this case

getRequirements

• getRequirements(busCaseId: number): Promise<Briefcase>

  Get Required items for case by case template id (BusCaseId)

  Parameters

  • busCaseId: number

    The case tmeplate ID (BusCaseId)

  Returns Promise<Briefcase>

  Returns Promise that represents a collection of objects describing the requirements of the case template

getStates

• getStates(): Promise<unknown>

  Get the configured states for the install

  Returns Promise<unknown>

  Returns Promise that represents a collection of states configured for the install

getZips

• getZips(): Promise<unknown>

  Get the configured zip codes for the install

  Returns Promise<unknown>

  Returns Promise that represents a collection of zip codes configured for the install

move

• move(
      caObjectId: number,
      x: number,
      y: number,
      projection: { VcsWKID?: string; WKID?: string; WKT?: string },
      z?: number,
  ): Promise<unknown>

  Move a Case point

  Parameters

  • caObjectId: number
  • x: number
  • y: number
  • projection: { VcsWKID?: string; WKID?: string; WKT?: string }

    Should include at least WKT or WKID attribute. Can also include VcsWKID attribute.

  • Optionalz: number

    Optional Z coordinate

  Returns Promise<unknown>

  Returns Promise that represents an object describing the updated GISPoint

print

• print(caObjectId: number, fileName: string, callback: any): Promise<unknown>

  Print Case

  Parameters

  • caObjectId: number

    The case object ID to delete the map layer fields for.

  • fileName: string

    the filename of the report from the getPrintTemplates method, but w/out the extension

  • callback: any

  Returns Promise<unknown>

  Returns Promise that represents a collection of Objects describing the case object map layer fields deleted

search

• search(filters: Object): Promise<number[]>

  Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

  Parameters

  • filters: Object

    The parameter(s) to search by

  Returns Promise<number[]>

  Returns Promise that represents an Array of case Object IDs

update

• update(caObjectId: number, options?: Object): Promise<Briefcase>

  Update a case

  Parameters

  • caObjectId: number

    The case Object ID to update

  • Optionaloptions: Object

    See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase

  Returns Promise<Briefcase>

  Returns Promise that represents an object describing the updated case

updateMLFs

• updateMLFs(
      caObjectId: number,
      x?: number,
      y?: number,
      domainId?: number,
      z?: number,
  ): Promise<unknown>

  Update Map Layer Fields

  Parameters

  • caObjectId: number

    The case object ID to get the map layer fields for.

  • Optionalx: number
  • Optionaly: number
  • OptionaldomainId: number

    The domain ID for the case in question

  • Optionalz: number

    Optional Z coordinate

  Returns Promise<unknown>

  Returns Promise that represents a collection of Objects describing the case object map layer fields

AcceptedBy

AcceptedByLoginId

ActiveFlag

Optionaladmin

AmountDue

AnonymousFlag

Optionalasset

AssignedTo

AssignedToFirstName

AssignedToLastName

AssignedToLoginId

Optionalattachments

BLicenseFlag

BusCaseDesc

BusCaseId

BusinessCategory

BusinessName

BusinessOrgType

CaObjectId

CaseGroup

CaseName

CaseNumber

CaseStatus

CaseStatusId

CaseType

CaseTypeDesc

CaseTypeId

CloneCaseRelation

Optionalcomment

CreatedBy

CreatedByLoginId

CX

CY

CZ

Optionaldata

DateAccepted

DateCreated

DateEntered

DateExpiration

DateIssued

DateModified

EnteredBy

EnteredByLoginid

ExpiredFlag

Facility_Id

FedTaxId

Optionalfinancial

Optionalflag

GetViewColumns

IssuedBy

IssuedFlag

Level_Id

Location

ModifiedBy

ModifiedByLoginId

OrgId

PACaseFlag

ParentCaObjectId

PendingFlag

Optionalpeople

PriorityLevel

ProjectCode

ProjectDesc

ProjectId

ProjectSid

RegisteredFlag

ServiceRequestDesc

ServiceRequestId

ServiceRequestStatus

StateTaxId

StatusCode

SubType

SubTypeDefaultText

SubTypeDesc

SubTypeId

TableName

TempTableName

Optionalworkflow

WorkOrderDesc

WorkOrderId

WorkOrderStatus