Skip to content

CustomReportsApi.md

Latest commit

 

History

History
186 lines (130 loc) · 6.85 KB

CustomReportsApi.md

File metadata and controls

186 lines (130 loc) · 6.85 KB

bamboohr_sdk.CustomReportsApi

All URIs are relative to https://companySubDomain.bamboohr.com

Method HTTP request Description
get_by_report_id GET /api/v1/custom-reports/{reportId} Get Report by ID
list_reports GET /api/v1/custom-reports List Reports

get_by_report_id

EmployeeResponse get_by_report_id(report_id, page=page, page_size=page_size)

Get Report by ID

Retrieve data for a specific saved custom report by its ID. Returns the same paginated data structure as the ad-hoc dataset query endpoint, using the report's saved field list and filter configuration. Use GET /api/v1/custom-reports to list available report IDs. Results default to 500 records per page; use the page and page_size query parameters to paginate.

Example

  • Basic Authentication (basic):
  • OAuth Authentication (oauth):
import bamboohr_sdk
from bamboohr_sdk.models.employee_response import EmployeeResponse
from bamboohr_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://companySubDomain.bamboohr.com
# See configuration.py for a list of all supported configuration parameters.
configuration = bamboohr_sdk.Configuration(
    host = "https://companySubDomain.bamboohr.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = bamboohr_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with bamboohr_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bamboohr_sdk.CustomReportsApi(api_client)
    report_id = 56 # int | The ID of the saved custom report to retrieve data for.
    page = 1 # int | The page number to retrieve. Defaults to 1. (optional) (default to 1)
    page_size = 500 # int | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. (optional) (default to 500)

    try:
        # Get Report by ID
        api_response = api_instance.get_by_report_id(report_id, page=page, page_size=page_size)
        print("The response of CustomReportsApi->get_by_report_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomReportsApi->get_by_report_id: %s\n" % e)

Parameters

Name Type Description Notes
report_id int The ID of the saved custom report to retrieve data for.
page int The page number to retrieve. Defaults to 1. [optional] [default to 1]
page_size int The number of records to retrieve per page. Defaults to 500. Maximum is 1000. [optional] [default to 500]

Return type

EmployeeResponse

Authorization

basic, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Report details -
400 Invalid or missing argument(s) -
403 Access denied -
404 Report not found -
500 An unexpected error occurred while getting a report -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_reports

ReportsResponse list_reports(page=page, page_size=page_size)

List Reports

Retrieve a paginated list of saved custom reports available in the account. Returns each report's ID and name. Use the report ID with GET /api/v1/custom-reports/{reportId} to fetch the report's data. Results default to 500 records per page.

Example

  • Basic Authentication (basic):
  • OAuth Authentication (oauth):
import bamboohr_sdk
from bamboohr_sdk.models.reports_response import ReportsResponse
from bamboohr_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://companySubDomain.bamboohr.com
# See configuration.py for a list of all supported configuration parameters.
configuration = bamboohr_sdk.Configuration(
    host = "https://companySubDomain.bamboohr.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = bamboohr_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with bamboohr_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bamboohr_sdk.CustomReportsApi(api_client)
    page = 1 # int | The page number to retrieve. Defaults to 1. (optional) (default to 1)
    page_size = 500 # int | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. (optional) (default to 500)

    try:
        # List Reports
        api_response = api_instance.list_reports(page=page, page_size=page_size)
        print("The response of CustomReportsApi->list_reports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomReportsApi->list_reports: %s\n" % e)

Parameters

Name Type Description Notes
page int The page number to retrieve. Defaults to 1. [optional] [default to 1]
page_size int The number of records to retrieve per page. Defaults to 500. Maximum is 1000. [optional] [default to 500]

Return type

ReportsResponse

Authorization

basic, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A list of reports -
403 Access denied -
500 An unexpected error occurred while getting the list of reports -

[Back to top] [Back to API list] [Back to Model list] [Back to README]