Skip to main content
Eptura Knowledge Center

Endpoint - OrgUnits

  1. Last updated
  2. Save as PDF

Early Access

The Public API has been released to your UAT environment.

The API has the following endpoints:

Get - Lists the Org Units

Parameters

  • businessKey - Business Key for Org Units
  • parentBusinessKey - Provide all children, grandchildren, and so on.
  • active - By default it is true.
  • page - Page of data to fetch.
  • perPage - Page of data to fetch.

Schema

data    array<object>
    Items     object
        OrgName    string
        OrgShortName    string
        OrgCostCentre    string
        OrgBusinessKey    string
        ReportsToBusinessKey    string
        Status    string
meta    object
    page    integer
    perPage    integer
    nextPage    string | null

Responses

  • 200 - Org units found
  • 403 - Not authorized

Post - Create Org Units

Parameters

  • None

Schema

orgUnits    array<object>
    Items object
        OrgName    string
        OrgShortName    string
        OrgCostCentre    string
        OrgBusinessKey    string
        ReportsToBusinessKey    string

Responses

  • 201 - Org units created
  • 206 - Org units created, partial success
  • 403 - Not authorized
  • 422 - Org unit creation failed

Delete - Delete Org Units

Parameters

  • None

Schema

costCentres    array<string>
    Items    string

Responses

  • 200 - Org units deleted
  • 206 - Org units deleted, partial success
  • 403 - Not authorized
  • 422 - Org unit deletion failed

Put - Update Org Units

Parameters

  • None

Schema

orgUnits    array<object>
    Items    object
        OrgName    string
        OrgShortName    string
        OrgCostCentre    string
        OrgBusinessKey    string
        ReportsToBusinessKey    string

Responses

  • 200 - Org units updated
  • 206 - Update Org units, partial success
  • 403 - Not authorized
  • 422 - Updated Org unit failed