Class General

A plugin that contains "general" methods for a Cityworks install

Index

Methods

addHoliday amIWatching batchExecute deleteHolidays getActivityMetadataByIds getHistory getHolidays getWOEntityCostSummary notifications searchWOEntityCostSummary

Methods

addHoliday

addHoliday(holiday: Date, description: string): Promise<unknown>
Add Holiday
Parameters
- holiday: Date
  The holiday's date
- description: string
  The holiday's name/description
Returns Promise<unknown>
Returns Promise object that represents a holiday that was added
- Defined in general.ts:212

amIWatching

amIWatching(activityType: any, activityId: number): Promise<unknown>
Find out if the current user is watching a particular activity (case, task, null [as a string])
Parameters
- activityType: any
  which activity type the following ID will be for.
- activityId: number
  activity Case or CaseTask (task instance) ID to check
Returns Promise<unknown>
Returns Promise object that represents a boolean indicating the currently authenticated user is watching the provided activity
- Defined in general.ts:43

batchExecute

batchExecute(
    requestBatch:
        | { Method: string; Request: Record<string, any> }
        | { Method: string; Request: Record<string, any> }[],
): Promise<unknown>
Execute a batch of API requests in a single call.
Parameters
- requestBatch:
  | { Method: string; Request: Record<string, any> }
  | { Method: string; Request: Record<string, any> }[]
  Either a single request object with Request and Method properties, or an array of such objects.
Returns Promise<unknown>
Returns Promise object that represents the batch execution response
- Defined in general.ts:110

deleteHolidays

deleteHolidays(holidays: Date[]): Promise<unknown>
Delete Holidays
Parameters
- holidays: Date[]
  List of datetimes which should have holidays deleted
Returns Promise<unknown>
Returns Promise object that represents a
- Defined in general.ts:233

getActivityMetadataByIds

getActivityMetadataByIds(ids: number[], table: string): Promise<unknown>
Get CwMetatData by Type and CwSid
Parameters
- ids: number[]
- table: string
Returns Promise<unknown>
Returns Promise object that represents a
- Defined in general.ts:68

getHistory

getHistory(): Promise<unknown>
Get recent history for authenticated user

Returns Promise<unknown>
Returns Promise object that represents a collection of RecentActivity objects
- Defined in general.ts:92

getHolidays

getHolidays(startDate?: Date, endDate?: Date): Promise<unknown>
Get All Holidays. Will return all holidays in the system. If start and end date parameters are included, they are used to filter the response.
Parameters
- OptionalstartDate: Date
  Date to search for Holidays, including this date.
- OptionalendDate: Date
  If not specified, Holidays on startDate are returned. If specified, Holidays on startDate up to, but not including endDate are returned.
Returns Promise<unknown>
Returns Promise object that represents a list of the holiday(s) found
- Defined in general.ts:175

getWOEntityCostSummary

getWOEntityCostSummary(object_ids: number[]): Promise<unknown>
Get cost summary for WorkOrder entities
Parameters
- object_ids: number[]
Returns Promise<unknown>
Returns Promise object that represents a
- Defined in general.ts:134

notifications

notifications(): Promise<unknown>
Get notifications for currently authenticated user

Returns Promise<unknown>
Returns Promise object that represents a collection of available notifications
- Defined in general.ts:25

searchWOEntityCostSummary

searchWOEntityCostSummary(search_id: number): Promise<unknown>
Get cost summary for WorkOrder entities selected through a search definition
Parameters
- search_id: number
Returns Promise<unknown>
Returns Promise object that represents a
- Defined in general.ts:154