Reports

This is an object representing the report that you have created in the ReportBuilder of the SmartRecruiters system. A report contains list of reporting files

{
  "reportId": "string",
  "name": "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-30T01:00:01.744Z",
        "to": "2021-07-30T01:00:01.744Z"
      },
      "datePeriod": {
        "period": 0,
        "unit": "DAYS",
        "fullPeriod": true
      },
      "rowValues": {
        "noneValue": true,
        "values": [
          "string"
        ]
      }
    }
  ],
  "creationDate": "2021-07-30T01:00:01.744Z",
  "modificationDate": "2021-07-30T01:00:01.744Z",
  "creatorId": "string",
  "modifierId": "string",
  "grantees": [
    "string"
  ],
  "schedule": {
    "frequency": "ANNUALLY",
    "activityPeriod": {
      "from": "2021-07-30T01:00:01.744Z",
      "to": "2021-07-30T01:00:01.744Z"
    }
  }
}

The report object

reportId string
Unique report identifier

name string
The name of the report

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

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.dateRange object
      The data range filter applied on the column
      • filters.apiFilterResponse.dateRange.from date-time
        A filter that includes data on and after the from 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 the to date. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.
  • 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 is DAYS, 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.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

creationDate date-time
The date when the report was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

modificationDate date-time
The date when any of the properties of the report was modified. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

creatorId string
Unique user identifier of the user who created the report

modifierId string
Unique user identifier of the user who last updated the report

grantees array of strings
List of unique user identifiers of users who are granted access to the report

schedule object
The scheduled time which a new file of the report should be created

  • schedule.frequency string
    The rate that a new file should be created based on the entity, column and filter specified on the report. Possible values: ANNUALLY, MONTHLY, WEEKLY, DAILY
  • schedule.activityPeriod object
    The date range that the schedule report setting is expected to run
    • schedule.activityPeriod.from string
      The start date when the schedule report setting is expected to run
    • schedule.activityPeriod.to string
      The last date when the schedule report setting is expected to run