Class CaseData

Hierarchy

CaseData

Index

Data Details Methods

addDetail

addDetail(caDataGroupId: number, caseDataDetailId: number, options?: Object): Promise<unknown>
Attach Case Data Detail

Returns
Returns Promise that represents an object describing CaDataGroupItemBase.
Parameters
- caDataGroupId: number
  
  The Case Data Group ID to attach the data detail to.
- caseDataDetailId: number
  
  caseDataDetailId to attach.
- Optional options: Object
  
  Options
Returns Promise<unknown>
- Defined in case_data.ts:229

getAllDataDetails

getAllDataDetails(caseId: number): Promise<any[]>
Get the Case Data Details for a Case by Case ID

Returns
Returns Promise that represents a collection of Case Data Detail Items
Parameters
- caseId: number
  
  The case ID to get the details for
Returns Promise<any[]>
- Defined in case_data.ts:473

lockDetail

lockDetail(caDataDetailId: number): Promise<unknown>
Lock Case Data Detail

Returns
Returns Promise which represents an object describing the CaDataDetailItem.
Parameters
- caDataDetailId: number
  
  The Case Data Detail ID to lock
Returns Promise<unknown>
- Defined in case_data.ts:277

searchForDetails

searchForDetails(filters?: Object): Promise<any[]>
Search for Case Data Details. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

Returns
Returns Promise that represents an object describing CaDataDetailItemBase.
Parameters
- Optional filters: Object
  
  The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
Returns Promise<any[]>
- Defined in case_data.ts:319

setCaseData

setCaseData(caseId: number, items: {
code: string;
value: any;
}[]): Promise<unknown>
Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference

Returns
Returns Promise that represents a collection
Parameters
- caseId: number
  
  The case ID to get the details for
- items: {
  code: string;
  value: any;
  }[]
  
  The parameters to search by. (DataGroup/Item string, Value) (e.g. {code: 'GroupCode.ItemCode', value: 'Value goes here'})
Returns Promise<unknown>
- Defined in case_data.ts:494

setCaseDataItem

setCaseDataItem(caseId: number, detailGroupAndItemCode: string, value: any): Promise<unknown>
Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference

Returns
Returns Promise
Parameters
- caseId: number
  
  The Case ID to set the detail for
- detailGroupAndItemCode: string
  
  The parameters to search (e.g. 'GroupCode.ItemCode')
- value: any
  
  The value to set the specified detail to
Returns Promise<unknown>
- Defined in case_data.ts:543

unlockDetail

unlockDetail(caDataDetailId: number): Promise<unknown>
Unlock Case Data Detail

Returns
Returns Promise which represents an object describing the CaDataDetailItem.
Parameters
- caDataDetailId: number
  
  The Case Data Group ID to unlock
Returns Promise<unknown>
- Defined in case_data.ts:298

updateDetail

updateDetail(caDataDetailId: number, options?: Object): Promise<unknown>
Update Case Data Detail

Returns
Returns Promise that represents an object describing CaDataGroupItemBase.
Parameters
- caDataDetailId: number
  
  The Case Data Group ID to attach the data detail to.
- Optional options: Object
  
  Options
Returns Promise<unknown>
- Defined in case_data.ts:254

updateDetailItemValue

updateDetailItemValue(dataDetailId: number, value: any): Promise<unknown>
Set a data detail item's value without needing to find the type

Returns
Promise that represents
Parameters
- dataDetailId: number
  
  The data detail item's ID
- value: any
  
  the value to set the data detail item to
Returns Promise<unknown>
- Defined in case_data.ts:425

Data Groups Methods

addDefaultGroups

addDefaultGroups(caObjectId: number, busCaseId: number): Promise<unknown>
Add Default Case Data Groups

Returns
Returns Promise that represents a collection of the default CaDataGroupItemBases.
Parameters
- caObjectId: number
  
  The Case Object to attach the data group to.
- busCaseId: number
  
  The business case ID
Returns Promise<unknown>
- Defined in case_data.ts:54

addGroup

addGroup(caObjectId: number, caseDataGroupId: number, groupCode: string, options?: {
    GroupDesc?: string;
    GroupSum?: number;
    SumFlag?: string;
}): Promise<unknown>
Add Case Data Group

Returns
Returns Promise that represents an object describing CaDataGroupItemBase.
Parameters
- caObjectId: number
  
  The Case Object to attach the data group to.
- caseDataGroupId: number
  
  CaseDataGroupId as defined in CaseDataGroup admin.
- groupCode: string
  
  The Group Code.
- Optional options: {
      GroupDesc?: string;
      GroupSum?: number;
      SumFlag?: string;
  }
  
  Options for CaseDataGroup including GroupDesc, GroupSum, and SumFlag
  - Optional GroupDesc?: string
  - Optional GroupSum?: number
  - Optional SumFlag?: string
Returns Promise<unknown>
- Defined in case_data.ts:28

checkGIS

checkGIS(entityType: string, entityUid: string, options: {
    CaObjectId?: number;
    CaseDataDetailId?: number;
    CaseDataGroupId?: number;
}): Promise<unknown>
Get Case Data Groups by Case ObjectId

Returns
Returns Promise that represents a collection of the default CaDataGroupItemBases.
Parameters
- entityType: string
  
  The entity type to check
- entityUid: string
  
  The specific entityUID to check
- options: {
      CaObjectId?: number;
      CaseDataDetailId?: number;
      CaseDataGroupId?: number;
  }
  
  The other options for checkGIS. Either CaObjectId or CaseDataGroupId is required.
  - Optional CaObjectId?: number
  - Optional CaseDataDetailId?: number
  - Optional CaseDataGroupId?: number
Returns Promise<unknown>
- Defined in case_data.ts:168

deleteGroupsByCaseId

deleteGroupsByCaseId(caObjectId: number): Promise<unknown>
Delete Case Data Groups by Case Object ID.

Returns
Returns Promise that represents a number that is the CaObjectId (?)
Parameters
- caObjectId: number
  
  The Case Object to attach the data group to.
Returns Promise<unknown>
- Defined in case_data.ts:125

getGroupsByCaseId

getGroupsByCaseId(caseId: number): Promise<unknown>
Get groups by CaObjectId

Returns
Returns Promise that represents a collection of the CaDataGroupItemBases.
Parameters
- caseId: number
  
  The Case Object to get the attached data groups.
Returns Promise<unknown>
- Defined in case_data.ts:105

searchForGroups

searchForGroups(filters?: Object): Promise<any[]>
Search for Case Data Groups. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

Returns
Returns Promise that represents a number that is the CaObjectId (?)
Parameters
- Optional filters: Object
  
  The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
Returns Promise<any[]>
- Defined in case_data.ts:145

updateGroupsFromAsset

updateGroupsFromAsset(caObjectId: number, entityType: string, entityUid: string, caDataGroupId?: number): Promise<unknown>
Update data groups on a case based on asset value mappings.

Returns
Returns Promise that represents a collection of the default CaDataGroupItemBases.
Parameters
- caObjectId: number
  
  The case to update
- entityType: string
  
  The entity type to check
- entityUid: string
  
  The specific entityUID to check
- Optional caDataGroupId: number
  
  The specific data group ID to limit updates to
Returns Promise<unknown>
- Defined in case_data.ts:202

wipAddDetail

wipAddDetail(caseDataDetailId: number, caDataGroupId: number, columnSequence: string, detailCode: string, detailSequence: number, options?: Object): Promise<unknown>
Adds a data detail entry to the case data group specified by the CaDataGroupId. The CaDataGroupId is associated to a case.

Returns
Returns Promise that represents an object describing CaDataDetailItemBase.
Parameters
- caseDataDetailId: number
  
  The Data Detail template ID
- caDataGroupId: number
  
  The Case Instance Data Group ID
- columnSequence: string
  
  The column sequence
- detailCode: string
  
  The detail Code
- detailSequence: number
  
  The detail order number
- Optional options: Object
  
  Other options for CaseDataDetail. See WIPAdd here: /{subdirectory}/apidocs/#/service-info/Pll/CaseDataDetail
Returns Promise<unknown>
- Defined in case_data.ts:80

Data List Values Methods

addListValue

addListValue(caDataDetailId: number, listValue: string): Promise<unknown>
Adds a list of possible values to the data detail entry specified by the CaDataDetailId.

Returns
Returns Promise that represents an object describing CaDataListValuesItemBase.
Parameters
- caDataDetailId: number
  
  The Case Object to attach the data group to.
- listValue: string
  
  The Group Code.
Returns Promise<unknown>
- Defined in case_data.ts:341

deleteListValue

deleteListValue(caDataDetailId: number): Promise<unknown>
Delete by Id (Ca Data List Id)

Returns
Returns Promise that represents an object describing CaDataListValuesItemBase.
Parameters
- caDataDetailId: number
Returns Promise<unknown>
- Defined in case_data.ts:362

searchForListValueIds

searchForListValueIds(filters?: Object): Promise<unknown>
Search for List Value IDs. 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 CaDataListIds
Parameters
- Optional filters: Object
  
  The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)
Returns Promise<unknown>
- Defined in case_data.ts:382

searchForListValueObjects

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

Returns
Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
Parameters
- Optional filters: Object
  
  The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)
Returns Promise<unknown>
- Defined in case_data.ts:403

Class CaseData

Hierarchy

Index

Methods - Data Details

Methods - Data Groups

Methods - Data List Values

Data Details Methods

addDetail

Returns

Parameters

caDataGroupId: number

caseDataDetailId: number

Optional options: Object

Returns Promise<unknown>

getAllDataDetails

Returns

Parameters

caseId: number

Returns Promise<any[]>

lockDetail

Returns

Parameters

caDataDetailId: number

Returns Promise<unknown>

searchForDetails

Returns

Parameters

Optional filters: Object

Returns Promise<any[]>

setCaseData

Returns

Parameters

caseId: number

items: { code: string; value: any; }[]

Returns Promise<unknown>

setCaseDataItem

Returns

Parameters

caseId: number

detailGroupAndItemCode: string

value: any

Returns Promise<unknown>

unlockDetail

Returns

Parameters

caDataDetailId: number

Returns Promise<unknown>

updateDetail

Returns

Parameters

caDataDetailId: number

Optional options: Object

Returns Promise<unknown>

updateDetailItemValue

Returns

Parameters

dataDetailId: number

value: any

Returns Promise<unknown>

Data Groups Methods

addDefaultGroups

Returns

Parameters

caObjectId: number

busCaseId: number

Returns Promise<unknown>

addGroup

Returns

Parameters

caObjectId: number

caseDataGroupId: number

groupCode: string

Optional options: { GroupDesc?: string; GroupSum?: number; SumFlag?: string; }

Optional GroupDesc?: string

Optional GroupSum?: number

Optional SumFlag?: string

Returns Promise<unknown>

checkGIS

Returns

Parameters

`Optional` options: Object

`Optional` filters: Object

items: {
code: string;
value: any;
}[]

`Optional` options: Object

`Optional` options: {
GroupDesc?: string;
GroupSum?: number;
SumFlag?: string;
}

`Optional` GroupDesc?: string

`Optional` GroupSum?: number

`Optional` SumFlag?: string

options: {
CaObjectId?: number;
CaseDataDetailId?: number;
CaseDataGroupId?: number;
}

`Optional` CaObjectId?: number

`Optional` CaseDataDetailId?: number

`Optional` CaseDataGroupId?: number

`Optional` filters: Object

`Optional` caDataGroupId: number

`Optional` options: Object

`Optional` filters: Object

`Optional` filters: Object