This page includes commonly requested API calls to AiM.
Notes:
- tableName is a required parameter.
- fields is an optional parameter. If omitted, all available fields in the target tablename are returned.
- rowLimit is an optional parameter (default is 10 records). Developers should use this option to optimize performance.
- sortBy is an optional parameter for sorting results. It’s value can be one or more fields from the target table (comma-separated).
- sortOrder is an optional parameter in conjunction with sortBy. Values are “ascending” or “descending”.
More advanced parameters can found in the AiM IQ REST API documentation, as provided by the vendor.
Property
| Description |
API Call |
Notes |
| Active Campuses |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=multitenantId,facId,description&tableName=AeBFacE&active=Y&rowLimit=100
|
Returns all active campuses |
| Active Buildings by Campus |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=multitenantId,facId,bldg,description,bldgStatus&tableName=AeSBldC&bldgStatus=IN SERVICE,NOT IN SERVICE,RENOVATION,UNINHABITABLE&facId=01&sortOrder=ascending&sortBy=bldg&rowLimit=1000
|
Returns all active buildings for the given campus (facId)
To return all active buildings across all campuses, remove parameter “facId=” and its associated value. |
| Active Floors by Building |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=multitenantId,facId,bldg,flrId,description&tableName=AeSFlrD&activeYn=Y&bldg=0004&sortOrder=ascending&sortBy=flrId&rowLimit=100
|
Returns all active floors for the given building (bldg) |
| Active Rooms by Building |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=multitenantId,facId,bldg,flrId,locationCode,description,locStatus,locType,dept,ocCode,grossSqft&tableName=AeBLocD&bldg=0004&locStatus=IN SERVICE,NOT IN SERVICE,RENOVATION,UNINHABITABLE&sortOrder=ascending&sortBy=flrId,locationCode&rowLimit=1000
|
Returns all active floors for the given building (bldg) |
Assets
| Description |
API Call |
Notes |
| Asset by Asset Tag |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=assetTag,description,serialNo,manufactureCode,manuPartNumber,assetType,assetGroup,bldg,locationCode&tableName=AeAAssetE&statusCode=Active&assetTag=UCONN-0029764
|
Returns a single asset for the given asset tag (assetTag) |
| Assets by Building |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=assetTag,description,serialNo,manufactureCode,manuPartNumber,assetType,assetGroup,bldg,locationCode&tableName=AeAAssetE&statusCode=Active&bldg=0004
|
Returns all active assets for a given building (bldg) |
| Assets by Building & Room |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=assetTag,description,serialNo,manufactureCode,manuPartNumber,assetType,assetGroup,bldg,locationCode&tableName=AeAAssetE&statusCode=Active&bldg=0004&locationCode=103
|
Returns all active assets for a given building (bldg) and room (locationCode) |
| Assets by Asset Type |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=assetTag,description,serialNo,manufactureCode,manuPartNumber,assetType,assetGroup,bldg,locationCode&tableName=AeAAssetE&statusCode=Active&assetType=SERIALIZED&rowLimit=100
|
Returns all active assets for a given asset type (assetType) |
| Assets by Asset Group |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=assetTag,description,serialNo,manufactureCode,manuPartNumber,assetType,assetGroup,bldg,locationCode&tableName=AeAAssetE&statusCode=Active&assetGroup=D3023&rowLimit=100
|
Returns all active assets for a given asset group (assetGroup) |
Work Management
| Description |
API Call |
Notes |
| Work Order (Single) |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=proposal,description,statusCode,facId,bldg,category,orderType&tableName=AePProE&proposal=171111-001079
|
Returns a single Work Order for the given number (proposal) |
| Phases by Work Order |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=proposal,description,statusCode,facId,bldg,category,orderType&tableName=AePPhsE&proposal=171111-001079
|
Returns all phases for the given Work Order number (proposal) |
| Active Work Orders by Shop |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=proposal,description,statusCode,facId,bldg,category,orderType&tableName=AePProE&statusCode=OPEN,HOLD,REOPENED&shop=ELECTRICAL&rowLimit=100
|
Returns all active Work Orders for the given shop |
| Active Phases by Shop |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?fields=proposal,description,statusCode,facId,bldg,category,orderType&tableName=AePPhsE&statusCode=ACTIVE,OPEN,ON HOLD,SCHEDULED,ASSIGNED,AWAITING PARTS,DELIVERED,WORK COMPLETE,FINANCIAL CLOSEOUT&shop=ELECTRICAL&rowLimit=100
|
Returns all active Phases for the given shop |
| Count of Active Work Orders by Shop |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?tableName=AePProE&statusCode=OPEN,HOLD,REOPENED&groupBy=shop&aggregation=COUNT
|
Returns a count of all active Work Orders for the given shop |
| Count of Active Phases by Shop |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?tableName=AePPhsE&statusCode=ACTIVE,OPEN,ON HOLD,SCHEDULED,ASSIGNED,AWAITING PARTS,DELIVERED,WORK COMPLETE,FINANCIAL CLOSEOUT&groupBy=shop&aggregation=COUNT
|
Returns a count of all active Phases for the given shop |
| Work Orders Created in Current Month |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?tableName=AePProE&date=entDate&timePeriod=CM
|
Returns all Work Orders created within the current month |
| Phases Created in Current Month |
https://uconnapp.assetworks.com:6443/fmax/api/v3/iq-reports/custom-resource?tableName=AePPhsE&date=entDate&timePeriod=CM
|
Returns all Phases created within the current month |