Class CaseAssets

Hierarchy

CaseAssets

Index

Methods - Case Assets

attach detach detachAll getForCase search

Case Assets Methods

attach

attach(caObjectId: number, updateXY?: boolean, options?: {
    Address?: string;
    AddressId?: number;
    AssetId?: string;
    AssetObjectId?: number;
    AssetType?: string;
    CityName?: string;
    CrossStreet?: string;
    DateExpired?: string;
    ExpiredFlag?: string;
    Facility_Id?: string;
    FeatureAssetId?: string;
    FeatureClass?: string;
    FeatureObjectId?: number;
    LegacyId?: string;
    Level_Id?: string;
    LndObjectId?: number;
    Location?: string;
    MasterFlag?: string;
    ObjectId?: string;
    StateCode?: string;
    StreetDirection?: string;
    StreetFraction?: string;
    StreetName?: string;
    StreetNumber?: number;
    StreetPostDir?: string;
    StreetType?: string;
    Suite?: string;
    TileNo?: string;
    UpdateCaseData?: boolean;
    XCoord?: number;
    YCoord?: number;
    ZCoord?: number;
    ZipCode?: string;
}): Promise<unknown>
Attach asset to case

Returns
Returns Promise that represents an object describing CaAddress. // {"AddressId":OBJECTID,"AssetId":"GUID","AssetType":"ASSET_NAME","CaObjectId":CA_OBJECTID,"FeatureAssetId":"GUID","FeatureClass":"ASSET_NAME","FeatureObjectId":OBJECTID,"Location":"Address string","ObjectId":"OBJECTID","XCoord":,"YCoord":,"UpdateCaseData":false}
Parameters
- caObjectId: number
  
  The Case Object to attach the data group to.
- updateXY: boolean = true
  
  Whether or not to update the Case's X/Y values when attaching the asset. Defaults to true.
- Optional options: {
      Address?: string;
      AddressId?: number;
      AssetId?: string;
      AssetObjectId?: number;
      AssetType?: string;
      CityName?: string;
      CrossStreet?: string;
      DateExpired?: string;
      ExpiredFlag?: string;
      Facility_Id?: string;
      FeatureAssetId?: string;
      FeatureClass?: string;
      FeatureObjectId?: number;
      LegacyId?: string;
      Level_Id?: string;
      LndObjectId?: number;
      Location?: string;
      MasterFlag?: string;
      ObjectId?: string;
      StateCode?: string;
      StreetDirection?: string;
      StreetFraction?: string;
      StreetName?: string;
      StreetNumber?: number;
      StreetPostDir?: string;
      StreetType?: string;
      Suite?: string;
      TileNo?: string;
      UpdateCaseData?: boolean;
      XCoord?: number;
      YCoord?: number;
      ZCoord?: number;
      ZipCode?: string;
  }
  
  Options for CaseDataGroup including Address, AddressId, AssetId, AssetObjectId, AssetType, CityName, CrossStreet, DateExpired, ExpiredFlag, Facility_Id, FeatureAssetId, FeatureClass, FeatureObjectId, LegacyId, Level_Id, LndObjectId, Location, MasterFlag, ObjectId, StateCode, StreetDirection, StreetFraction, StreetName, StreetNumber, StreetPostDir, StreetType, Suite, TileNo, UpdateCaseData, XCoord, YCoord, ZCoord, and ZipCode
  - Optional Address?: string
  - Optional AddressId?: number
  - Optional AssetId?: string
  - Optional AssetObjectId?: number
  - Optional AssetType?: string
  - Optional CityName?: string
  - Optional CrossStreet?: string
  - Optional DateExpired?: string
  - Optional ExpiredFlag?: string
  - Optional Facility_Id?: string
  - Optional FeatureAssetId?: string
  - Optional FeatureClass?: string
  - Optional FeatureObjectId?: number
  - Optional LegacyId?: string
  - Optional Level_Id?: string
  - Optional LndObjectId?: number
  - Optional Location?: string
  - Optional MasterFlag?: string
  - Optional ObjectId?: string
  - Optional StateCode?: string
  - Optional StreetDirection?: string
  - Optional StreetFraction?: string
  - Optional StreetName?: string
  - Optional StreetNumber?: number
  - Optional StreetPostDir?: string
  - Optional StreetType?: string
  - Optional Suite?: string
  - Optional TileNo?: string
  - Optional UpdateCaseData?: boolean
  - Optional XCoord?: number
  - Optional YCoord?: number
  - Optional ZCoord?: number
  - Optional ZipCode?: string
Returns Promise<unknown>
- Defined in case_assets.ts:28

detach

detach(caAddressId: number, updateXY?: boolean): Promise<unknown>
Detach specific asset from case

Returns
Returns Promise that represents a collection of the default CaDataGroupItemBases.
Parameters
- caAddressId: number
- updateXY: boolean = true
  
  Whether or not to update the Case's X/Y values when detaching the assets. Defaults to true.
Returns Promise<unknown>
- Defined in case_assets.ts:53

detachAll

detachAll(caObjectId: number, updateXY?: boolean): Promise<unknown>
Detach all assets from case

Returns
Returns Promise that represents a collection of detached CaAddressIds.
Parameters
- caObjectId: number
  
  The Case Object to detach the assets from.
- updateXY: boolean = false
  
  Whether or not to update the Case's X/Y values when detaching the asset(s). Defaults to false.
Returns Promise<unknown>
- Defined in case_assets.ts:75

getForCase

getForCase(caObjectId: number): Promise<unknown>
Get assets attached to a specific case

Returns
Returns Promise that represents a collection of the default CaAddresses.
Parameters
- caObjectId: number
  
  The Case Object from which to get attached assets
Returns Promise<unknown>
- Defined in case_assets.ts:96

search

search(filters?: Object): Promise<unknown>
Search for Case Assets. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

Returns
Returns Promise that represents an Array of resulting CaAddresses
Parameters
- Optional filters: Object
  
  The parameters to search by. (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode)
Returns Promise<unknown>
- Defined in case_assets.ts:117

Class CaseAssets

Hierarchy

Index

Methods - Case Assets

Case Assets Methods

attach

Returns

Parameters

caObjectId: number

updateXY: boolean = true

Optional Address?: string

Optional AddressId?: number

Optional AssetId?: string

Optional AssetObjectId?: number

Optional AssetType?: string

Optional CityName?: string

Optional CrossStreet?: string

Optional DateExpired?: string

Optional ExpiredFlag?: string

Optional Facility_Id?: string

Optional FeatureAssetId?: string

Optional FeatureClass?: string

Optional FeatureObjectId?: number

Optional LegacyId?: string

Optional Level_Id?: string

Optional LndObjectId?: number

Optional Location?: string

Optional MasterFlag?: string

Optional ObjectId?: string

Optional StateCode?: string

Optional StreetDirection?: string

Optional StreetFraction?: string

Optional StreetName?: string

Optional StreetNumber?: number

Optional StreetPostDir?: string

Optional StreetType?: string

Optional Suite?: string

Optional TileNo?: string

Optional UpdateCaseData?: boolean

Optional XCoord?: number

Optional YCoord?: number

Optional ZCoord?: number

Optional ZipCode?: string

Returns Promise<unknown>

detach

Returns

Parameters

caAddressId: number

updateXY: boolean = true

Returns Promise<unknown>

detachAll

Returns

Parameters

caObjectId: number

updateXY: boolean = false

Returns Promise<unknown>

getForCase

Returns

Parameters

caObjectId: number

Returns Promise<unknown>

search

Returns

Parameters

Optional filters: Object

Returns Promise<unknown>

Settings

Member Visibility

Theme

`Optional` Address?: string

`Optional` AddressId?: number

`Optional` AssetId?: string

`Optional` AssetObjectId?: number

`Optional` AssetType?: string

`Optional` CityName?: string

`Optional` CrossStreet?: string

`Optional` DateExpired?: string

`Optional` ExpiredFlag?: string

`Optional` Facility_Id?: string

`Optional` FeatureAssetId?: string

`Optional` FeatureClass?: string

`Optional` FeatureObjectId?: number

`Optional` LegacyId?: string

`Optional` Level_Id?: string

`Optional` LndObjectId?: number

`Optional` Location?: string

`Optional` MasterFlag?: string

`Optional` ObjectId?: string

`Optional` StateCode?: string

`Optional` StreetDirection?: string

`Optional` StreetFraction?: string

`Optional` StreetName?: string

`Optional` StreetNumber?: number

`Optional` StreetPostDir?: string

`Optional` StreetType?: string

`Optional` Suite?: string

`Optional` TileNo?: string

`Optional` UpdateCaseData?: boolean

`Optional` XCoord?: number

`Optional` YCoord?: number

`Optional` ZCoord?: number

`Optional` ZipCode?: string

`Optional` filters: Object