cityworks
    Preparing search index...

    Class Equipment

    A plugin that contains equipment methods for a Cityworks install

    Index

    Properties

    Changeout operations for equipment

    Cost operations for equipment

    Reservation operations for equipment

    Methods

    • Add new equipment

      Parameters

      • equipment: EquipmentBase

        The equipment information. EquipmentUid is a required field.

      Returns Promise<unknown>

      Returns Promise object that represents an object that is the newly-added equipment

    • Get all equipment

      Parameters

      • viewableOnly: boolean = true

      Returns Promise<unknown>

    • Get equipment custom data fields by id

      Parameters

      • equipmentSid: number
      • OptionalcustFieldIds: number[]

      Returns Promise<unknown>

    • Delete equipment by ID

      Parameters

      • equipmentSids: number[]

      Returns Promise<unknown>

    • Get equipment by ID

      Parameters

      • equipmentSid: number

      Returns Promise<unknown>

    • Get equipment by IDs

      Parameters

      • equipmentSids: number[]

      Returns Promise<unknown>

    • Search for equipment

      Parameters

      • searchParameters: {
            Description?: string[];
            EquipmentSid?: number[];
            EquipmentUid?: string[];
            ForCheckout?: boolean;
            Manufacturer?: string[];
            Model?: string[];
            RateType?: string[];
            Viewable?: boolean;
        }
      • maxResults: number = 20

      Returns Promise<unknown>

    • Update existing equipment

      Parameters

      • equipmentSids: number | number[]

        The SIDs of the equipment to update.

      • equipmentProperties: EquipmentBase

        The equipment information to update. EquipmentSid cannot be included in the equipmentProperties object, as those are used to identify which equipment to update and could cause unintended consequences if included in the update information.

      Returns Promise<unknown>

      Returns Promise object that represents an object that is the updated equipment