cityworks
    Preparing search index...

    Class CaseData

    Index

    Data Details

    addDetail getAllDataDetails lockDetail searchForDetails setCaseData setCaseDataItem unlockDetail updateDetail updateDetailItemValue

    Data Groups

    addDefaultGroups addGroup checkGIS deleteGroupsByCaseId getGroupsByCaseId searchForGroups updateGroupsFromAsset wipAddDetail

    Data List Values

    addListValue deleteListValue searchForListValueIds searchForListValueObjects

    Data Details

    • Attach Case Data Detail

      Parameters

      • caDataGroupId: number

        The Case Data Group ID to attach the data detail to.

      • caseDataDetailId: number

        caseDataDetailId to attach.

      • Optionaloptions: Object

        Options

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataGroupItemBase.

    • Get the Case Data Details for a Case by Case ID

      Parameters

      • caseId: number

        The case ID to get the details for

      Returns Promise<any[]>

      Returns Promise that represents a collection of Case Data Detail Items

    • Lock Case Data Detail

      Parameters

      • caDataDetailId: number

        The Case Data Detail ID to lock

      Returns Promise<unknown>

      Returns Promise which represents an object describing the CaDataDetailItem.

    • Search for Case Data Details. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

      Parameters

      • Optionalfilters: Object

        The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)

      Returns Promise<any[]>

      Returns Promise that represents an object describing CaDataDetailItemBase.

    • Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference

      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>

      Returns Promise that represents a collection

    • Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference

      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>

      Returns Promise

    • Unlock Case Data Detail

      Parameters

      • caDataDetailId: number

        The Case Data Group ID to unlock

      Returns Promise<unknown>

      Returns Promise which represents an object describing the CaDataDetailItem.

    • Update Case Data Detail

      Parameters

      • caDataDetailId: number

        The Case Data Group ID to attach the data detail to.

      • Optionaloptions: Object

        Options

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataGroupItemBase.

    • Set a data detail item's value without needing to find the type

      Parameters

      • dataDetailId: number

        The data detail item's ID

      • value: any

        the value to set the data detail item to

      • Optionalrate: number

        the rate to set the data detail item to

      • Optionalquantity: number

        the quantitye to set the data detail item to

      Returns Promise<unknown>

      Promise that represents

    Data Groups

    • Add Default Case Data Groups

      Parameters

      • caObjectId: number

        The Case Object to attach the data group to.

      • busCaseId: number

        The business case ID

      Returns Promise<unknown>

      Returns Promise that represents a collection of the default CaDataGroupItemBases.

    • Add Case Data Group

      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.

      • Optionaloptions: { GroupDesc?: string; GroupSum?: number; SumFlag?: string }

        Options for CaseDataGroup including GroupDesc, GroupSum, and SumFlag

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataGroupItemBase.

    • Get Case Data Groups by Case ObjectId

      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.

      Returns Promise<unknown>

      Returns Promise that represents a collection of the default CaDataGroupItemBases.

    • Delete Case Data Groups by Case Object ID.

      Parameters

      • caObjectId: number

        The Case Object to attach the data group to.

      Returns Promise<unknown>

      Returns Promise that represents a number that is the CaObjectId (?)

    • Get groups by CaObjectId

      Parameters

      • caseId: number

        The Case Object to get the attached data groups.

      Returns Promise<unknown>

      Returns Promise that represents a collection of the CaDataGroupItemBases.

    • Search for Case Data Groups. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

      Parameters

      • Optionalfilters: Object

        The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)

      Returns Promise<any[]>

      Returns Promise that represents a number that is the CaObjectId (?)

    • Update data groups on a case based on asset value mappings.

      Parameters

      • caObjectId: number

        The case to update

      • entityType: string

        The entity type to check

      • entityUid: string

        The specific entityUID to check

      • OptionalcaDataGroupId: number

        The specific data group ID to limit updates to

      Returns Promise<unknown>

      Returns Promise that represents a collection of the default CaDataGroupItemBases.

    • Adds a data detail entry to the case data group specified by the CaDataGroupId. The CaDataGroupId is associated to a case.

      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

      • Optionaloptions: Object

        Other options for CaseDataDetail. See WIPAdd here: /{subdirectory}/apidocs/#/service-info/Pll/CaseDataDetail

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataDetailItemBase.

    Data List Values

    • Adds a list of possible values to the data detail entry specified by the CaDataDetailId.

      Parameters

      • caDataDetailId: number

        The Case Object to attach the data group to.

      • listValue: string

        The Group Code.

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataListValuesItemBase.

    • Delete by Id (Ca Data List Id)

      Parameters

      • caDataDetailId: number

      Returns Promise<unknown>

      Returns Promise that represents an object describing CaDataListValuesItemBase.

    • Search for List Value IDs. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

      Parameters

      • Optionalfilters: Object

        The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)

      Returns Promise<unknown>

      Returns Promise that represents an Array of resulting CaDataListIds

    • Search for List Value Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

      Parameters

      • Optionalfilters: Object

        The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)

      Returns Promise<unknown>

      Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects

    Settings

    Member Visibility

    On This Page

    Data Details
    Data Groups
    Data List Values