The file object is representing a file of a report that you have created in the ReportBuilder of the SmartRecruiters system. The file contains data points of interest specified on the Report
obect.
{
"reportFileId": "string",
"reportId": "string",
"reportFileStatus": "PENDING",
"scheduleType": "AD_HOC",
"schedulingDate": "2021-07-30T20:56:58.565Z",
"generationDate": "2021-07-30T20:56:58.565Z",
"requestorId": "string",
"rowEntityTypeId": "string",
"rowEntityInstanceId": "string",
"columns": [
{
"entityTypeId": "string",
"entityInstanceId": "string",
"dataPointId": "string",
"dataPointInstanceId": "string",
"dataPointInstanceName": "string",
"dataPointName": "string",
"dataPointType": "ID"
}
],
"filters": [
{
"column": {
"entityTypeId": "string",
"entityInstanceId": "string",
"dataPointId": "string",
"dataPointInstanceId": "string",
"dataPointInstanceName": "string",
"dataPointName": "string",
"dataPointType": "ID"
},
"dateRange": {
"from": "2021-07-30T20:56:58.565Z",
"to": "2021-07-30T20:56:58.565Z"
},
"datePeriod": {
"period": 0,
"unit": "DAYS",
"fullPeriod": true
},
"rowValues": {
"noneValue": true,
"values": [
"string"
]
}
}
]
}
The report file object
reportFileId string
Unique report file identifier
reportId string
Unique report identifier that the file belongs to
reportFileStatus string
The status of the file. Possible value: PENDING
, RUNNING
, COMPLETED
, FAILED
scheduleType string
The schedule type of the file. Possible value: AD_HOC
and SCHEDULED
schedulingDate date-time
The date that the file was scheduled to be generated
generationDate date-time
The date that the file was created
requestorId string
Unique user identifier who requests the report file
rowEntityTypeId string
Unique row entity type identifier. Row entity is the entity of interest in a report you can choose to base your column data on.
rowEntityInstanceId string
Unique row entity instance identifier
columns array of objects
Data columns of the report
- columns.apiColumnResponse object
A single column of the report- columns.apiColumnResponse.entityTypeId string
Unique column data entity type identifier - columns.apiColumnResponse.entityInstanceId string
Unique column data entity instance identifier - columns.apiColumnResponse.dataPointId string
Unique data point identifier - columns.apiColumnResponse.dataPointInstanceId string
Unique data point instance identifier - columns.apiColumnResponse.dataPointName string
The name of the data point - columns.apiColumnResponse.dataPointType string
The data type of the data point. Possible values:ID
,DATE
,NUMBER
,TEXT
,ENUM
,BOOLEAN
,DECIMAL
- columns.apiColumnResponse.entityTypeId string
filters array of objects
Filters applied on the data of the report
- filters.apiFilterResponse object
A single filter applied on a column of the report- filters.apiFilterResponse.column object
A single column of the report- filters.apiFilterResponse.column.entityTypeId string
Unique column data entity type identifier - filters.apiFilterResponse.column.entityInstanceId string
Unique column data entity instance identifier - filters.apiFilterResponse.column.dataPointId string
Unique data point identifier - filters.apiFilterResponse.column.dataPointInstanceId string
Unique data point instance identifier - filters.apiFilterResponse.column.dataPointName string
The name of the data point - filters.apiFilterResponse.column.dataPointType string
The data type of the data point. Possible values:ID
,DATE
,NUMBER
,TEXT
,ENUM
,BOOLEAN
,DECIMAL
- filters.apiFilterResponse.column.entityTypeId string
- filters.apiFilterResponse.dateRange object
The data range filter applied on the column- filters.apiFilterResponse.dateRange.from date-time
A filter that includes data on and after thefrom
date. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ. - filters.apiFilterResponse.dateRange.to date-time
A filter that includes data on and before theto
date. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.
- filters.apiFilterResponse.dateRange.from date-time
- filters.apiFilterResponse.column object
- filters.apiFilterResponse.datePeriod object
The data period filter applied on the column- filters.apiFilterResponse.datePeriod.period integer
A time period filter on the data that defines the length of the period (i.e. if the value is 5 and the unit isDAYS
, then the report is going to include data in the last 5 days) - filters.apiFilterResponse.datePeriod.unit string
Defined unit for the time period filter. Possible values:DAYS
,WEEKS
,MONTHS
,YEARS
- filters.apiFilterResponse.datePeriod.period integer
- filters.apiFilterResponse.rowValues object
The data value filter applied on the column- filters.apiFilterResponse.datePeriod.boolean boolean
A boolean filter on the data if the value of the data point contains only True or False (Yes and No) values. - filters.apiFilterResponse.datePeriod.values array
Value based filters on the data depending on the available values of the data point
- filters.apiFilterResponse.datePeriod.boolean boolean