v1
latestOpenAPI 3.0.02026-07-2653703.5 MBCreate a new batch report task.
The report's time filter can be specified either via the relativeTime field or via the filter field.<br/><br/>The relativeTime field supports these possible values: today, thisWeek, thisMonth, thisQuarter, thisYear, lastHour, last4Hours, last12Hours, last24Hours, last7Days, last30Days, yesterday, lastFullWeek, lastFullMonth, lastFullQuarter, lastFullYear, last6FullMonths, last12FullMonths.<br/><br/>The options field supports withWeekends which is used for occupancyOrg reports.The filter field specifies the report date and time range and other filters. It uses the same syntax and field names from the /orgs/{orgId}/reports/activity API. Example: "filter": "time:(1609459200--1612137600)" means filter to all records with a /orgs/{orgId}/reports/activity time field value of Jan 1, 2021 00:00:00 UTC inclusive to Feb 1, 2021 00:00:00 UTC inclusive. If you also wanted to filter for sideIds, you would specify "filter": "time:(1609459200--1612137600) siteId:(123,456,789)". That will return results for that same date range plus filtering for siteIds 123, 456, or 789.<br/><br/>The columns field is an in-order list of CSV columns to output. Possible values depend on the report type: For activityLogsOrg, the possible values are time, category, subCategory, result, device, deviceDetail, deviceDetailName, deviceTimezone, deviceTime, user, userEmail, userOrg, userIdpName, userExternalId, initialCredentialTypeName, initialCredentialDetail, credentialTypeName, credentialDetail, target, initialRequest, request, location, entryName, entryName2, zoneName, zoneName2, siteName, siteName2, source, deniedReason, requestId. For alarmsOrg, the possible values are alarmId, alarmConfigName, time, eventName, siteName2, zoneName2, entryName2, alarmActionName, userName, assignee, alarmStatusName, acuName, readerName, note. For occupancyOrg, the possible values are user, userEmail, userGroups. Include a customFieldIdx# column name to specify customFieldIds column placement. Example: where customFieldId for id 49 has a name of Department and the payload is ..., "columns": ["time", "category", "customFieldIdx0"], "customFieldIds": [49], ... means output "time", "category", "Department" column headers and subsequent lines with respective values in that columns specified order. In this example, customFieldIdx0 is the 0th index in the customFieldsIds array.<br/><br/>The difference between entryName, zoneName, and siteName vs. entryName2, zoneName2, and siteName2 is that the *Name2 fields can potentially return "Multiple" as the name. This occurs when there are multiple unique ids for that resource type. Whereas the entryId, entryName, zoneId, zoneName, siteId, and siteName values always equal the first entry's values (entries[0]).<br/><br/>The expiresAfter specification can be specified either via a concrete date in expiresAfter or via a relative number of days from the expiresAfterDays field.<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o-support:w,o:w,s-o:w<br/><br/>Endpoint name: createTasksReport
Path parameters
Request body
Response
Created