University of Wisconsin-Madison Jobs API

openapi: 3.2.0
info:
  title: University Of Wisconsin Madison Jobs API
  version: 1.0.0
  contact:
    name: DoIT Enterprise Integration API Team
    email: api@doit.wisc.edu
    url: https://go.wisc.edu/k701y6
  description: 'Operations tagged jobs across 3 of this provider''s published API definitions: university-of-wisconsin-madison-mock-person-api-certificates-openapi.yml, university-of-wisconsin-madison-mock-person-api-openapi.yml, university-of-wisconsin-madison-person-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://mock.api.wisc.edu
- url: https://api.wisc.edu
security:
- OAuth2ClientCredentials: []
tags:
- name: jobs
paths:
  /people/{id}/jobs:
    get:
      description: "<main>\n    <section>\n        <p>\n            Get jobs for a person. During the transition from HRS to Workday, a Person will have two versions of a\n            given job, one from HRS and one from Workday as indicated by the \"source\" attribute.  The different versions\n            of jobs have some unique attributes mentioned below.  All other attributes will be populated for both HRS\n            and Workday jobs, but their values might differ slightly. Workday jobs are refreshed infrequently and might\n            contain older data than HRS jobs.\n        </p>\n        <p>\n            HRS jobs will contain data for the following attributes:\n        </p>\n        <ul>\n            <li><code>division</code></li>\n            <li><code>divisionCode</code></li>\n            <li><code>departmentUnit</code></li>\n        </ul>\n        <p>\n            Workday jobs will contain data for the following attributes:\n        </p>\n        <ul>\n            <li><code>supervisoryOrganizationId</code></li>\n            <li><code>supervisoryOrganizationName</code></li>\n            <li><code>supervisoryOrganizationCode</code></li>\n            <li><code>relatedSupervisoryOrganizationIds</code></li>\n            <li><code>managedSupervisoryOrganizationIds</code></li>\n            <li><code>costCenterId</code></li>\n            <li><code>costCenterName</code></li>\n            <li><code>locationId</code></li>\n            <li><code>workspaceId</code></li>\n            <li><code>action</code></li>\n            <li><code>actionReason</code></li>\n        </ul>\n    </section>\n</main>"
      summary: Get jobs.
      operationId: get_person_jobs
      tags:
      - jobs
      parameters:
      - name: id
        description: 'ID of a person. This parameter should not be manually built/concatenated, but instead be used by following the fully-formed links returned in an API response. To get a person by an ID, use query parameters to search by a specific identifier. Example: /people?filter[identifiers.name]=netId&filter[identifiers.value]=bbadger'
        in: path
        example: '700'
        required: true
        schema:
          type: string
          description: An ephemeral identifier used only in the Person API to adhere to the [JSON:API specification](https://jsonapi.org/format/#document-resource-object-identification). This ID may change if a person is split into two people or two people are merged into one person. This ID is used for paginating results or following other links returned in the API response. This ID should not be stored in a consuming system. Concatenating parts of the URL to form a link is discouraged. Instead, use the fully-formed links returned in an API response.
          example: '12345'
      - name: fields
        in: query
        description: Specify the list of fields you would like to return for each resource type.  For example, `fields[people]=firstName,lastName` will just return the names for people.  If you are including related resources with 'includes' you can also specify fields on those resources as well.  For example, `includes=jobs&fields[people]=jobs&fields[jobs]=title` will just return titles for jobs.  See [Sparse Fieldsets](https://jsonapi.org/format/#fetching-sparse-fieldsets) for more details.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: false
          properties:
            type:
              type: string
              example: people
      - name: filter
        in: query
        description: Filter results of query using the [filter query parameter family](https://jsonapi.org/recommendations/#filtering). Refer to the [Person API Documentation](/person-api/filter-query-parameter) for more information about the `filter` query param.
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: false
          properties:
            attribute:
              type: string
              example: firstName
      - name: include
        in: query
        description: '[include related resources](https://jsonapi.org/format/#fetching-includes). The resources to include need to be direct relationships. Nested relationships are not supported. For example, `include=jobs,identifiers` is supported but `include=person.jobs` is not supported.'
        schema:
          type: string
      responses:
        '200':
          description: A collection of jobs
          content:
            application/vnd.api+json:
              schema:
                type: object
                required:
                - data
                - links
                properties:
                  data:
                    description: A collection of jobs
                    type: array
                    items:
                      description: Details about a job associated with a person.
                      type: object
                      required:
                      - type
                      - id
                      - attributes
                      - relationships
                      properties:
                        type:
                          type: string
                          example: jobs
                        id:
                          type: string
                          example: '12345'
                          description: Ephemeral ID used to adhere to the JSON:API specification. This ID should not be stored.
                        attributes:
                          type: object
                          required:
                          - title
                          - division
                          - divisionCode
                          - departmentUnit
                          - beginDate
                          - endDate
                          - effectiveDate
                          - fullTimeEquivalent
                          - payBasis
                          - employeeCategoryCode
                          - employeeCategory
                          - jobCode
                          - businessTitle
                          - position
                          - current
                          - primary
                          - supervisoryOrganizationId
                          - costCenterId
                          - source
                          - institution
                          - locationId
                          - workspaceId
                          - action
                          - actionReason
                          properties:
                            title:
                              type: string
                              example: Software Eng/Developer I
                              description: Title of the person's position at this job.
                            division:
                              type:
                              - string
                              - 'null'
                              example: INFORMATION TECHNOLOGY
                              description: High level organizational unit where the job is located.
                            divisionCode:
                              type:
                              - string
                              - 'null'
                              example: A067040
                              description: Code for the location of the job.
                            departmentUnit:
                              type:
                              - string
                              - 'null'
                              example: L&S/COMPUTER SCI/COMP SCI
                              description: Organization path where the job is located.
                            beginDate:
                              type: string
                              format: date
                              example: '2018-01-01'
                              description: The date the job began.
                            endDate:
                              type:
                              - string
                              - 'null'
                              format: date
                              example: '2025-01-01'
                              description: The date the job ended.
                            effectiveDate:
                              type: string
                              format: date
                              example: '2018-01-01'
                              description: The date the newest action on this job is effective.
                            fullTimeEquivalent:
                              type: string
                              example: '0.5'
                              description: The full time equivalency of the job. Represented as a decimal for HRS jobs and as a percentage for Workday jobs.
                            payBasis:
                              type: string
                              enum:
                              - Academic
                              - Annual
                              - Hourly
                              - Lump
                              - No Pay Basis
                              - Summer Service
                              - Summer Session
                              - Unknown
                              - Salary
                              - No_Pay
                              - Period_Activity_Pay
                              - One_Time_Payment
                              example: Annual
                              description: The pay basis for this position.  HRS jobs have a value of Academic, Annual, Hourly, Lump, No Pay Basis, Summer Service, Summer Session, or Unknown.  Workday jobs have a value of Hourly, Salary, No_Pay, Period_Activity_Pay, or One_Time_Payment.
                            employeeCategoryCode:
                              type: string
                              example: AS
                              description: Unique identifier for an employee category.
                            employeeCategory:
                              type: string
                              example: Academic Staff
                              description: 'See this document for information on this field: https://kb.wisc.edu/ohr/policies/page.php?id=53496'
                            jobCode:
                              type: string
                              example: IT002
                              description: Unique identifier for the job title.
                            businessTitle:
                              type: string
                              example: Software Engineer/Developer
                              description: Business title of the person's position at this job.
                            position:
                              type: string
                              example: 00123456-1
                              description: An identifier to be used to uniquely identify a job for a person. This is a concatenation of the position and job record from Peoplesoft HRS, separated by a hyphen '-' (without quotes). It is not recommended to parse this value, but instead use it as an opaque identifier.
                            current:
                              type: boolean
                              example: true
                              description: Property that indicates if this job is current.
                            primary:
                              type: boolean
                              example: true
                              description: Property that indicates if this is the primary job.
                            supervisoryOrganizationId:
                              type:
                              - string
                              - 'null'
                              example: SO00001234
                              description: The ID of the supervisory organization for this job.
                            costCenterId:
                              type:
                              - string
                              - 'null'
                              example: CC001234
                              description: The ID of the cost center for this job.
                            costCenterName:
                              type:
                              - string
                              - 'null'
                              example: UWMSN | DOIT | Application Infrastructure Services
                              description: The name of the cost center for this job. Only available for jobs with source Workday.
                            source:
                              type: string
                              example: HRS
                              enum:
                              - HRS
                              - Workday
                              description: The source of this job.
                            institution:
                              description: The institution associated with the resource.
                              type: string
                              example: UW-Madison
                              enum:
                              - Shared
                              - UW-Eau Claire
                              - UW-Green Bay
                              - UW-La Crosse
                              - UW-Madison
                              - UW-Milwaukee
                              - UW Oshkosh
                              - UW-Parkside
                              - UW-Platteville
                              - UW-River Falls
                              - UW-Stevens Point
                              - UW-Stout
                              - UW-Superior
                              - UW-Whitewater
                              - UW-Extension
                              - UW System
                            supervisoryOrganizationName:
                              type:
                              - string
                              - 'null'
                              example: Application Infrastructure Services
                              description: The name of the supervisory organization for this job. Only available for jobs with source Workday.
                            supervisoryOrganizationCode:
                              type:
                              - string
                              - 'null'
                              example: UWMSN | DOIT |
                              description: The code of the supervisory organization for this job. Only available for jobs with source Workday.
                            relatedSupervisoryOrganizationIds:
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                              example:
                              - SO00000000
                              - SO00001234
                              - SO00002345
                              description: The IDs of the supervisory organizations related to this job. This list contains IDs of all parent supervisory organizations and IDs of supervisory organizations that this position manages.
                            managedSupervisoryOrganizationIds:
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                              example:
                              - SO00002345
                              description: The IDs of the supervisory organizations that this job manages.
                            locationId:
                              type:
                              - string
                              - 'null'
                              example: LCMSN_0048
                              description: The ID of the location for this job.  Only available for jobs with source Workday.
                            workspaceId:
                              type:
                              - string
                              - 'null'
                              example: LCMSN_0048_03_0323
                              description: The ID of the workspace for this job.  Only available for jobs with source Workday.
                            action:
                              type:
                              - string
                              - 'null'
                              example: Change Job
                              description: Workday business process.
                            actionReason:
                              type:
                              - string
                              - 'null'
                              example: CJ9
                              description: Reason for the action. Not all actions have a reason.
                        relationships:
                          type: object
                          required:
                          - person
                          - supervisor
                          properties:
                            person:
                              description: A generic relationship object
                              type: object
                              properties:
                                links:
                                  type: object
                                  properties:
                                    related:
                                      type: string
                                      example: https://api.wisc.edu/link/to/related/object
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: sampleType
                                    id:
                                      type: string
                                      example: sampleId
                            supervisor:
                              description: The supervisor for the job. If the job reports to a position that has 0 or greater than 2 people occupying it, this relationship is empty. If the job reports to a position occupied by 2 people, this relationship points to the person with the most recently entered job.
                              type: object
                              properties:
                                links:
                                  type: object
                                  properties:
                                    related:
                                      type: string
                                      example: https://api.wisc.edu/people/123
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: people
                                    id:
                                      type: string
                                      example: '123'
                  links:
                    description: The link to access a resource itself
                    type: object
                    properties:
                      self:
                        type: string
                        example: https://api.wisc.edu/link/to/self
                  included:
                    description: Included related resources
                    type: array
                    items:
                      description: A generic resource object
                      type: object
                      properties:
                        type:
                          type: string
                          example: sampleType
                        id:
                          type: string
                          example: sampleId
                        attributes:
                          type: object
                          properties:
                            attribute1:
                              type: string
                              example: sampleStringAttribute
                            attribute2:
                              type: number
                              example: 123
                        relationships:
                          type: object
                          properties:
                            relatedResource:
                              description: A generic relationship object
                              type: object
                              properties:
                                links:
                                  type: object
                                  properties:
                                    related:
                                      type: string
                                      example: https://api.wisc.edu/link/to/related/object
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: sampleType
                                    id:
                                      type: string
                                      example: sampleId
                        links:
                          description: The link to access a resource itself
                          type: object
                          properties:
                            self:
                              type: string
                              example: https://api.wisc.edu/link/to/self
              examples:
                example-jobs:
                  value:
                    data:
                    - attributes:
                        departmentUnit: DOIT/AIS/ENTERPRISE INTEGRAT
                        division: INFORMATION TECHNOLOGY
                        divisionCode: A067040
                        title: Product Manager
                        beginDate: '2020-01-01'
                        endDate: '2080-01-01'
                        effectiveDate: '2020-01-01'
                        fullTimeEquivalent: '1'
                        payBasis: Annual
                        primary: true
                        employeeCategory: Academic Staff
                        employeeCategoryCode: AS
                        jobCode: IT002
                        businessTitle: Department Product Manager
                        position: 00123456-1
                        current: true
                        supervisoryOrganizationId: null
                        supervisoryOrganizationName: null
                        supervisoryOrganizationCode: null
                        costCenterId: null
                        costCenterName: null
                        source: HRS
                        institution: UW-Madison
                        relatedSupervisoryOrganizationIds: []
                        managedSupervisoryOrganizationIds: []
                        locationId: null
                        workspaceId: null
                        action: null
                        actionReason: null
                      id: '100'
                      relationships:
                        person:
                          data:
                            id: '100'
                            type: people
                          links:
                            related: https://api.wisc.edu/people/100
                        supervisor:
                          data:
                            id: '200'
                            type: people
                          links:
                            related: https://api.wisc.edu/people/200
                      type: jobs
                    - attributes:
                        departmentUnit: null
                        division: null
                        divisionCode: null
                        title: Product Manager
                        beginDate: '2020-01-01'
                        endDate: '2080-01-01'
                        effectiveDate: '2020-01-01'
                        fullTimeEquivalent: '1'
                        payBasis: Annual
                        primary: true
                        employeeCategory: Academic Staff
                        employeeCategoryCode: AS
                        jobCode: IT002
                        businessTitle: Department Product Manager
                        position: 00123456-1
                        current: true
                        supervisoryOrganizationId: SO00001234
                        supervisoryOrganizationName: Application Infrastructure Services
                        supervisoryOrganizationCode: UWMSN | DOIT |
                        costCenterId: CC001234
                        costCenterName: UWMSN | DOIT | Application Infrastructure Services
                        source: Workday
                        institution: UW-Madison
                        relatedSupervisoryOrganizationIds:
                        - SO00000000
                        - SO00001234
                        - SO00002345
                        managedSupervisoryOrganizationIds:
                        - SO00002345
                        locationId: LCMSN_0048
                        workspaceId: LCMSN_0048_03_0323
                        action: Change Job
                        actionReason: CJ9
                      id: '100'
                      relationships:
                        person:
                          data:
                            id: '100'
                            type: people
                          links:
                            related: https://api.wisc.edu/people/100
                        supervisor:
                          data:
                            id: '200'
                            type: people
                          links:
                            related: https://api.wisc.edu/people/200
                      type: jobs
                    links:
                      self: https://api.wisc.edu/people/100/jobs
        '400':
          description: A bad request.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      description: An error
                      type: object
                      properties:
                        status:
                          type: integer
                          example: 400
                        title:
                          type: string
                          example: Error title
                        detail:
                          type: string
                          example: Additional details about the error
                        links:
                          type: object
                        meta:
                          type: object
                        source:
                          type: object
              examples:
                application/vnd.api+json:
                  value:
                    errors:
                    - id: null
                      links: {}
                      meta: {}
                      source: {}
                      status: 400
                      title: Bad Request
                      detail: Invalid properties in query parameters - resource type 'people' has no attribute 'invalid'.
        '401':
          description: Incorrect or expired OAuth token.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      description: An error
                      type: object
                      properties:
                        status:
                          type: integer
                          example: 400
                        title:
                          type: string
                          example: Error title
                        detail:
                          type: string
                          example: Additional details about the error
                        links:
                          type: object
                        meta:
                          type: object
                        source:
                          type: object
              examples:
                unauthorized-response:
                  value:
                    errors:
                    - status: 401
                      title: Unauthorized
                      detail: Invalid OAuth authentication - InvalidAccessToken
        '403':
          description: The API call is authenticated but the client isn't allowed to perform the requested operation. This can occur when trying to update a resource when granted read-only access.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      description: An error
                      type: object
                      properties:
                        status:
                          type: integer
                          example: 400
                        title:
                          type: string
                          example: Error title
                        detail:
                          type: string
                          example: Additional details about the error
                        links:
                          type: object
                        meta:
                          type: object
                        source:
                          type: object
              examples:
                name-update-example:
                  value:
                    errors:
                    - status: 403
                      title: Forbidden
                      detail: Client is not allowed to create, update, or delete a person's name.
                no-access-example:
                  value:
                    errors:
                    - status: 403
                      title: Forbidden
                      detail: Requested method is forbidden for endpoint - GET - /people
        '404':
          description: Unable to find the specified record
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      description: An error
                      type: object
                      properties:
                        status:
                          type: integer
                          example: 400
                        title:
                          type: string
                          example: Error title
                        detail:
                          type: string
                          example: Additional details about the error
                        links:
                          type: object
                        meta:
                          type: object
                        source:
                          type: object
              examples:
                not-found-example:
                  value:
                    errors:
                    - status: 404
                      title: Not Found
     

# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-wisconsin-madison/refs/heads/main/openapi/university-of-wisconsin-madison-jobs-api-openapi.yml