REST APIs

The AgrEGG REST APIs provide service endpoints for getting and managing resources.

Dashboards

  1. Add Dashboard, Creates a new dashboard
    POST apis/dashboards
    Request Body
    Name: The name of the new dashboard
    Responses
    200 OK
  2. Modify Dashboard, modify an existing dashboard
    POST apis/dashboards/{dashboardId}
    Request Body
    Name: The name of the new dashboard
    Responses
    200 OK
  3. Delete Dashboard, Deletes the specified dashboard
    DELETE apis/dashboards/{dashboardId}
    dashboardId: The dashboard ID
    Responses:
    200 OK
  4. Get Dashboard, Returns the specified dashboard
    GET apis/dashboards/{dashboardId}
    dashboardId: The dashboard ID
    Responses
    200 OK

KPIs

  1. Add KPI, Creates a new KPI
    POST apis/kpis
    Request Body
    Code: The name of the new KPI
    Description: The description of the new KPI
  2. Modify KPI, Modify an existing KPI
    POST apis/kpis/{kpiId}
    kpiId: The KPI ID
    Responses
    200 OK
  3. Delete KPI, Deletes the specified KPI
    DELETE apis/kpis/{kpiId}
    kpiId: The KPI ID
    Responses:
    200 OK
  4. Get KPI, Returns the specified KPI
    GET apis/kpis/{kpiId}
    kpiId: The KPI ID
    Responses
    200 OK

Data Filters

  1. Add Filter, Creates a new Filter
    POST apis/filters
    Request Body
    Code: The name of the new Filter
    Description: The description of the new Filter
  2. Modify Filter, Modify an existing Filter
    POST apis/filters/{filterId}
    filterId: The Filter ID
    Responses
    200 OK
  3. Delete Filter, Deletes the specified Filter
    DELETE apis/filters/{filterId}
    filterId: The Filter ID
    Responses:
    200 OK
  4. Get Filter, Returns the specified Filter
    GET apis/filters/{filterId}
    filterId: The Filter ID
    Responses
    200 OK
  5. Add Filter Item, Creates a new Filter Item
    POST apis/filters_items
    Request Body
    Code: The name of the new Filter Item
    Description: The description of the new Filter
  6. Modify Filter item, Modify an existing Filter item
    POST apis/filters_items /{filteritemId}
    filteritemId: The Filter items ID
    Responses
    200 OK
  7. Delete Filter item, Deletes the specified Filter item
    DELETE apis/filters_items/{filteritemId}
    filteritemId: The Filter item ID
    Responses:
    200 OK
  8. Get Filter item, Returns the specified Filter item
    GET apis/filters_items /{filteritemId}
    filteritemId: The Filter item ID
    Responses
    200 OK

Permission Groups

  1. Add Group User, Grants the specified user the specified permissions to the specified group.
    POST apis/groups/{groupId}/users
    GroupId: The group ID
  2. Create Group, Creates a new permission group.
    POST apis/groups
    GroupName: The new group name
  3. Delete Group, Deletes the specified permission group.
    POST apis/groups/{groupId}/delete
    GroupId: The group ID
  4. Delete User in Group, Deletes the specified user permissions from the specified group.
    POST apis/groups/{groupId}/{userId}/delete
    GroupId: The group ID
    userId: The user ID
  5. Get Group, Returns a list of groups the user has access to.
    GET apis/groups/{groupId}
    GroupId: The group ID
  6. Get Group Users, Returns a list of users that have access to the specified group.
    GET apis/groups/{groupId}
    GroupId: The group ID
  7. Update Group User, Updates the specified user permissions to the specified group
    PUT apis/groups/{groupId}/users
    GroupId: The group ID

Data Imports

  1. Get Import Type, Returns the specified import type
    GET apis/imports/type/{importId}
    importId: The import type ID
  2. New Import Type, create a new import type
    PUT apis/imports/type/
  3. Modify Import Type, modifies the specified import type
    POST apis/imports/type/{importId}
    importId: The import type ID
  4. Get Import file, Returns the specified import file
    GET apis/imports/file/{importId}
    importId: The import file ID
  5. Modify Import file, modifies the specified import file
    POST apis/imports/file/{importId}
    importId: The import file ID
  6. Confirm Import file, confirms the specified import file
    POST apis/imports/file/{importId}/confirm
    importId: The import file ID
  7. Insert Import row, create a new row for the specified import file
    POST apis/imports/file/{importId}/rows
    importId: The import file ID
  8. New Import file, create a new import file
    PUT apis/imports/file/

Reports

  1. Clone Report, Clones the specified report
    POST apis/reports/{reportId}/Clone
    reportId: The report ID
  2. Delete Report, Deletes the specified report
    DELETE apis/reports/{reportId}
    reportId: The report ID
    Responses
    200: OK
  3. Get Report, Returns the specified report
    GET apis/reports/{reportId}
    reportId: The report ID
    Responses
    200: OK

Users

  1. Add User, Grants the specified user the specified permissions to the specified group.
    POST apis/users/
    userId: The user ID
  2. Delete User, Deletes the specified permission group.
    POST apis/users/{userId}/delete
    userId: The user ID