SMsmartrecruiters
files

Get report file

Use this endpoint to get a specific report file details.

get/files/{reportFileId}

Request

  • Base URL
    https://api.smartrecruiters.com/reporting-api/v201804
  • URL
    https://api.smartrecruiters.com/reporting-api/v201804/files/{reportFileId}
  • Auth
    • OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: reporting_read
    • or API key in header x-smarttoken

Path parameters

reportFileIdstring required

Report file identifier

Response

Successful response.

reportFileIdstring
reportIdstring
reportFileStatus'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED'
scheduleType'AD_HOC' | 'SCHEDULED'
schedulingDatestring date-time
generationDatestring date-time
requestorIdstring
accessGroupIdstring
systemRoleIdstring
rowEntityTypeIdstring
rowEntityInstanceIdstring
errorReason'UNKNOWN' | 'MISSING_ACCESS_GROUP' | 'ACCESS_GROUP_MISMATCH' | 'MISSING_SYSTEM_ROLE' | 'SYSTEM_ROLE_MISMATCH' | 'REPORTING_AREA_RESTRICTED' | 'INCORRECT_ACCESS_CONFIGURATION' | 'MISSING_REPORT_CREATOR_EMPLOYEE' | 'MAX_REPORT_FILE_SIZE_EXCEEDED'

Changes

No recorded changes to this operation across all 1 revision of this API.