Developer Portal (REST API)

The Developer Portal navigates authorized users to REST API documentation for this application. To view this area, a user must have the API Management authority level located in System > Authority Levels.

REST API area contents include:

• Application Event API: Rest APIs for managing application event status
• External Position: Rest APIs for External Positions
• Job Title: Rest APIs for Job Title
• Organization Structure: Rest APIs for Organization Structure
• Person: Rest APIs for Person1 Person import limit is 500 at one time.
• Schedule API: Rest APIs for Schedules
• Specialty: Rest APIs for Specialty
• Roster: REST APIs for Roster2 Roster fetch limit is 368 days.

Application version 7.2.5.2 addresses missing profiles via the person import API. As a result, new logic was added to this application requiring both a Profile and an External ID to exist for a person when importing people via the Person Import API. If either is missing from the Dimensions person import, then this application disables the person’s profile. The profile re-enables when both the profile and the external ID are present in the import. If the profile passes via the import with no External ID, then the profile remains disabled.

KB Article 000181231 UKG TeleStaff Cloud REST API Models provides visibility to the properties available in the Models section of the Developer Portal as-is in this application and available for reference purposes only in PDF format and intended to help customer decision makers review the REST API area and determine whether the fields they query for reporting purposes are available in the UKG TeleStaff Cloud application. Generally, these users do not have access to the Developer Portal or knowledge of.