Skip to main content

What is the OData Reporting Interface?

Updated

Data from applications, job openings, and onboardings can be transferred to external systems via the Reporting API and thus be used for greater evaluations.

What is oData
For the interface we use the Open Data Protocol, OData for short. This is an HTTP-based and open source protocol published by Microsoft for data exchange between compatible software systems.
Compatible with d.vinci are external systems that support the current OData version OData v4.0. This includes most major business intelligence tools (BI tools).

Microsoft Excel 2016 and äolder versions are not compatible as they do not support OData v4.0.

Benefit
OData allows you to aggregate data from different sources for analysis purposes - so not only from applicant management, but also, for example, visitor statistics from websites or even manually collected metrics. This data can be displayed on a dashboard.

Configuration

Get started with: Reporting API

Behavior in the system

  • Permission to view 
    The data is restricted according to the permissions of the organizational unit of the API user. This means: With an API user on a specific organizational unit, only the data of this and underlying organizational units is output. You can create different API users for different purposes and thus restrict and control the output of reporting data. 
  • Deletion of organizational units
    If organizational units are deleted, their objects are no longer output in the OData reporting interface. Statistical data that was linked to a deleted organizational unit is no longer available in OData. 
  • Data Output
    The reporting data is always anonymized. It is not directly possible to draw conclusions about individuals.

Transmission values

The following values are transmitted via the OData API

Application Management

Organization Units (OrgUnits)
  • Name
  • ID of the organizational unit
  • d.vinci organizational unit url (deep link into d.vinci system)
  • d.vinci REST API URL
User (DvinciUsers)
  • Division
  • d.vinci user ID
  • d.vinci user url (deep link into d.vinci system)
  • First name
  • Last name
  • ID of the organizational unit
  • d.vinci REST API URL
  • Salutation
Job Openins (JobOpenings)
  • Company
  • Contract period
  • Cost unit
  • Date of creation
  • Department
  • Earliest entry date
  • Own form fields (single)
  • ID of the job opening
  • URL of the job opening
  • Main title
  • ID of the organizational unit
  • Reference
  • Responsible user
  • ID of the responsible user
  • d.vinci REST API URL
  • Bonus
  • Start search
  • Start of search: time zone
  • Unsolicited job opening
  • Workflow
  • Permanent posts
WorkingTimes (JobOpeningWorkingTimes)
  • ID of the job opening
  • ID of the working time of the job opening
  • Working time ID
  • Name
Categories (JobOpeningCategories)
  • ID of the category
  • Name
  • ID of the category of th job opening
  • ID of the publication
TargetGroups (JobOpeningTargetGroups)
  • ID of the job opening
  • ID of the target group of the job opening
  • ID of the target audience
  • Name
Costs (JobCosts)

Per job posting

  • Amount
  • Cost type
  • Date
  • ID of the cost 
  • ID of the job opening
  • Purpose
Locations (Locations)
  • City
  • Country
  • Latitude (Geographic coordinate)
  • ID of the location
  • Name
  • Longitude (Geographic coordinate)
  • Zip Code
Persons (Persons)
  • d.vinci REST API URL
  • City
  • Country
  • Degree
  • Education
  • Global ID
  • ID of the person
  • Salutation
  • Special characters (single)
  • Study
  • Year of birth
  • Zip Code
Applications (ApplicationPapers)
  • ID of the application
  • URL of the application
  • Application status (Available, Reduced, Deleted)
  • Name of the Application status
  • Date created
    • Date hierarchy
  • Initial job opening name
  • ID of the job opening
  • Last test result
  • ID of the person
  • Rating
  • Last reason for rejection
  • Application type
  • d.vinci REST API URL
  • Screening questions (single)
  • Source
  • Type of application (online etc.) 
Processes (ApplicationPaperEvents)
  • ID of the Event of the application
  • ID of the application
  • Date
    • date hierarchy
  • Type of event
  • Process time since application was received
  • Process time since the start of the tender
Status change (ApplicationStatusChanges)
  • ID of the application
  • ID of the status change
  • application status
  • Time
    • date hierarchy
  • Idle time 
Appointments (Appointments)
  • ID of the application
  • Application status
  • ID of the appointment
  • Date
    • date hierarchy
  • Duration
  • Location
  • Time zone
Appointment Participants (AppointmentParticipants)
  • ID of the appointment
  • ID of the appointment participants
  • Status in Cronofy
  • ID of the participants
Locations of the call (JobOpeningLocations)
  • ID of the job opening
  • ID of the location of the job opening
  • ID of the location
Hiring Request (HiringRequest)
  • ID of the Hiring Request
  • URL of the Hiring Request
  • URL of the REST API
  • Job Title
  • Creation Date
  • Status
  • Approval Status
  • ID of the Job Opening
  • Organizational Unit
  • Name of the Superior
  • ID of the Superior
  • Name of the HR Contact
  • ID of the HR Contact
  • Reason to Hire
  • Number of Openings
  • Company
  • Department
  • Cost Unit
  • Contract Period
  • Pay Grade
  • Occupational Group
  • Function Group
  • Wage/Salary Range
  • Budgeted
  • Planned Starting Date
  • Form Fields
  • Remark
Locations of the Hiring Request (HiringRequestLocations)
  • ID of the Location of the Hiring Request
  • ID of the Hiring Request
  • ID of the Location
Working Times of the Hiring Request (HiringRequestWorkingTimes)
  • ID of the Working Time of the Hiring Request
  • ID of the Hiring Request
  • ID of the Working Times 
  • Working Times
Applicant Feedback and Feedback with kununu (ApplicantFeedback)
  • ID of the applicant feedback
  • Date of the feedback
  • Question
  • Questiontype
  • Answer
  • ID of the job opening
  • Name of the job opening
  • Reference of the job opening
  • Name of the organizational unit Organisationseinheit
  • Published on kununu
Applicant Tracking (ApplicantTracking)
  • ID of the applicant
  • date
  • viewed application portal page in the application process
  • ID of the job opening
  • ID of the application portal
Event Module (VamEvent and VamBooking)
  • ID of the organizational unit
  • Title of the event
  • Start date and time
  • End date and time
  • Timezone
  • Status of the event
  • ID of the application
Permanent Posts (PermanentPosts)
  • Permanent Posts number
  • Permanent Post date of hire
  • Application
  • Job Opening

Onboarding

Dates of onboarding (Onboardings)
  • Company
  • Date created
  • Date of contract
  • Date of Employment
  • End of onboarding
  • Start of onboarding
  • Reason for entry
  • Sprache
  • ID of onboarding
  • ID of the onboardee
  • ID of the organizational unit
  • Position
  • Reason for termination
  • Status
  • ID of the application (if it was previously processed in the applicant tracking system)
Data of the onboardee (OnbPersons)
  • City
  • Country
  • Global ID
  • ID of the onboardee
  • Salutation
  • Year of birth
  • Zip Code
Onboarding tasks (Tasks)
  • Date Created
  • Due date
  • Enabled
  • Has Assignments
  • Has portal tasks
  • Resolved
  • Responsibility
  • ID of the task
  • Title

Caution

When in the d. vinci system IP policy is stored, only sources/tools from the IP access range can retrieve data from the reporting interface.

 

How our customers use this

Customers with larger BI tools or PowerBI from Microsoft use the reporting interface to have the data graphically prepared by these tools and to be able to create evaluations for the stakeholders in the company. Whether works council, controlling, HR business partner or the business management, they all may need corresponding evaluations.

 

Related to

Related articles