HR API Supervisory Organizations
The Supervisory Organizations endpoint allows you to navigate the hierarchical structure of supervisory organizations for the Universities of Wisconsin. This API helps understand how various supervisory organizations relate to one another within the organizational tree.
Key Points
- Hierarchy Navigation : Traverse the supervisory organization tree to understand the relationships and structure of different supervisory organizations.
- Root Organization :
- The root of the main supervisory organization tree is
SO00000000, representing UW System Administration. - The root of the supervisory organization tree for former jobs that predate Workday is
SOTERMINATE. This tree only exists because all Workday jobs have to have a supervisory organization, and these jobs ended prior to the main tree's creation. Jobs that ended after the creation of the main tree will remain in whatever supervisory organization they were in at the time.
- The root of the main supervisory organization tree is
- Recommended Workflow :
- Retrieve Organization ID : Use the Person API or Workday to obtain the
supervisoryOrganizationIdfor the organization of interest. - Get Organization Details : Use the retrieved
supervisoryOrganizationIdto fetch detailed information about the supervisory organization.
- Retrieve Organization ID : Use the Person API or Workday to obtain the
Using the Person API
The Person API can assist in obtaining the supervisoryOrganizationId associated with a person's job. This ID is recommended for navigating and retrieving specific supervisory organizational details.
- Retrieve Supervisory Organization ID :
- Use the Person API to get the
supervisoryOrganizationIdfor an individual's job.
- Use the Person API to get the
Using Workday
Alternatively, the supervisoryOrganizationId can be obtained directly from Workday if user has access. Related KB Article regarding Supervisory Organizations in Workday can be found here .
Example Workflow
Step 1: Retrieve the supervisoryOrganizationId using the Person API.
GET /people/{personId}/jobs
This request will return job details, including the supervisoryOrganizationId .
Step 2 : Use the supervisoryOrganizationId to get details about the specific supervisory organization.
GET /hr/supervisoryOrganizations/{supervisoryOrganizationId}
This will provide detailed information about the supervisory organization, including its position within the hierarchy and its relationship to other organizations.
Example Scenario
Scenario : You want to understand the supervisory structure for an employee named Jane Doe.
Step 1: Retrieve Jane Doe's Job Details
GET /people/{jane doe's personId}/jobs
Response:
{ "data": [ { "attributes": { "supervisoryOrganizationId": "SO00001234", "source": "Workday", "institution": "UW-Madison" }, "id": "100", "type": "jobs" } ]}
Step 2: Get Supervisory Organization Details
GET /supervisoryOrganizations/SO00001234
Response:
{ "data": { "attributes": { "code": "UWSOM |", "name": "Badger Department", "supervisoryOrganizationType": "Department" }, "id": "SO00005678", "type": "supervisoryOrganizations", "relationships": { "subordinateOrganizations": { "data": [ { "id": "SO00002345", "type": "supervisoryOrganizations" } ] }, "superiorOrganization": { "data": { "id": "SO00000000", "type": "supervisoryOrganizations" } }, "allSubordinateOrganizations": { "data": [ { "id": "SO00002345", "type": "supervisoryOrganizations" } ] } } }}
This response shows that Jane Doe belongs to the "Badger Department," which is a child organization under the "UW System Administration" (root organization).
By following this workflow, you can efficiently navigate and understand the structure of supervisory organizations within your institution.
