bamboohr_sdk.EmployeeFilesApi

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

Method	HTTP request	Description
add_employee_file_category	POST /api/v1/employees/files/categories	Create Employee File Category
delete_employee_file	DELETE /api/v1/employees/{id}/files/{fileId}	Delete Employee File
get_employee_file	GET /api/v1/employees/{id}/files/{fileId}	Get Employee File
list_employee_files	GET /api/v1/employees/{id}/files/view	List Employee Files
update_employee_file	POST /api/v1/employees/{id}/files/{fileId}	Update Employee File
upload_employee_file	POST /api/v1/employees/{id}/files	Upload Employee File

add_employee_file_category

add_employee_file_category(request_body)

Create Employee File Category

Creates one or more employee file categories. Accepts a JSON array of category name strings or an equivalent XML document. An empty payload returns 200 without creating anything. Returns 400 if a name is empty or already exists, and 403 if the caller lacks permission.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
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.EmployeeFilesApi(api_client)
    request_body = ['request_body_example'] # List[str] | 

    try:
        # Create Employee File Category
        api_instance.add_employee_file_category(request_body)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->add_employee_file_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	List[str]

Return type

void (empty response body)

Authorization

basic, oauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	The request was processed but no categories were created (empty payload).	-
201	All specified categories were created successfully.	-
400	The request body contains malformed JSON or XML, an empty category name, or a category name that already exists.	-
403	The API user does not have permission to create employee file categories.	-
500	An internal server error occurred.	-

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

delete_employee_file

delete_employee_file(id, file_id)

Delete Employee File

Deletes the specified employee file. The special employee ID of zero (0) resolves to the employee associated with the API key. Successful deletions are idempotent: if the file was already deleted for that employee, the endpoint may still return 200. Returns 404 when the file is not associated with the specified employee, 403 if the caller lacks permission or the file is managed by BambooPayroll, and 500 on an internal error.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
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.EmployeeFilesApi(api_client)
    id = 0 # int | The ID of the employee whose file is being deleted. Pass 0 to use the employee associated with the API key. (default to 0)
    file_id = 56 # int | The ID of the employee file to delete.

    try:
        # Delete Employee File
        api_instance.delete_employee_file(id, file_id)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->delete_employee_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The ID of the employee whose file is being deleted. Pass 0 to use the employee associated with the API key.	[default to 0]
file_id	int	The ID of the employee file to delete.

Return type

void (empty response body)

Authorization

basic, oauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	The employee file was deleted successfully, or had already been deleted for this employee.	-
403	The API user does not have permission to delete the requested employee's file, or the file is managed by BambooPayroll.	-
404	The requested file was not found for the specified employee.	-
500	An internal server error occurred.	-

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

get_employee_file

bytearray get_employee_file(id, file_id)

Get Employee File

Downloads the binary content of an employee file. The special employee ID of zero (0) resolves to the employee associated with the API key. The response is sent as an attachment and the Content-Type header reflects the stored file's MIME type. Returns 403 if the caller cannot access the employee or the file's section, and 404 if the file does not exist or is archived.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
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.EmployeeFilesApi(api_client)
    id = 0 # int | The ID of the employee whose file is being retrieved. Pass 0 to use the employee associated with the API key. (default to 0)
    file_id = 56 # int | The ID of the employee file to download.

    try:
        # Get Employee File
        api_response = api_instance.get_employee_file(id, file_id)
        print("The response of EmployeeFilesApi->get_employee_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->get_employee_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The ID of the employee whose file is being retrieved. Pass 0 to use the employee associated with the API key.	[default to 0]
file_id	int	The ID of the employee file to download.

Return type

bytearray

Authorization

basic, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	The employee file content streamed as a binary download. The response Content-Type matches the file's stored MIME type.	-
403	The API user does not have permission to access the requested employee or the employee's file section.	-
404	The requested employee file was not found.	-

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

list_employee_files

JsonEmployeeFiles list_employee_files(id, accept=accept)

List Employee Files

Lists the file categories and files visible to the caller for the specified employee. The response format is controlled by the Accept header: send 'application/json' for JSON or omit/send anything else for XML. Only categories and files the caller is permitted to see are included; employees viewing their own profile also see files shared with them.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
from bamboohr_sdk.models.json_employee_files import JsonEmployeeFiles
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.EmployeeFilesApi(api_client)
    id = 56 # int | The ID of the employee whose files are being listed.
    accept = 'application/xml' # str | Set to 'application/json' to receive a JSON response. Any other value (or omitted) returns XML. (optional) (default to 'application/xml')

    try:
        # List Employee Files
        api_response = api_instance.list_employee_files(id, accept=accept)
        print("The response of EmployeeFilesApi->list_employee_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->list_employee_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The ID of the employee whose files are being listed.
accept	str	Set to 'application/json' to receive a JSON response. Any other value (or omitted) returns XML.	[optional] [default to 'application/xml']

Return type

JsonEmployeeFiles

Authorization

basic, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

HTTP response details

Status code	Description	Response headers
200	The employee's file categories and files.	-
403	The API user does not have permission to access the requested employee's files.	-
404	The requested employee was not found, or the employee has no accessible file categories.	-

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

update_employee_file

update_employee_file(id, file_id, employee_file_update)

Update Employee File

Updates metadata for an existing employee file. Supports renaming the file, moving it to a different category, and toggling employee visibility. Accepts JSON or XML; only fields present in the request body are updated. An empty XML document no-ops successfully, while an empty JSON body is treated as malformed JSON.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
from bamboohr_sdk.models.employee_file_update import EmployeeFileUpdate
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.EmployeeFilesApi(api_client)
    id = 56 # int | The ID of the employee whose file is being updated.
    file_id = 56 # int | The ID of the employee file to update.
    employee_file_update = bamboohr_sdk.EmployeeFileUpdate() # EmployeeFileUpdate | 

    try:
        # Update Employee File
        api_instance.update_employee_file(id, file_id, employee_file_update)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->update_employee_file: %s\n" % e)

Parameters

Name	Type	Description
id	int	The ID of the employee whose file is being updated.
file_id	int	The ID of the employee file to update.
employee_file_update	EmployeeFileUpdate

Return type

void (empty response body)

Authorization

basic, oauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	The employee file was updated successfully.	-
400	The request body contains malformed JSON or XML.	-
403	The API user does not have permission to modify the requested employee's file or its category.	-
404	The requested employee file or target category was not found.	-
500	An internal server error occurred.	-

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

upload_employee_file

upload_employee_file(id, file_name, category, file, share=share)

Upload Employee File

Uploads a file to an employee's file section. The request must be a multipart/form-data POST. On success, a Location header is returned with the URL of the newly created file resource. The file must be under 20MB and use a supported extension. Pass 0 as the employee ID to use the employee associated with the API key. Employees may upload to their own folder if the company has employee document uploads enabled.

Example

Basic Authentication (basic):
OAuth Authentication (oauth):

import bamboohr_sdk
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.EmployeeFilesApi(api_client)
    id = '0' # str | {id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any). (default to '0')
    file_name = 'file_name_example' # str | The display name for the uploaded file.
    category = 56 # int | The ID of the employee file section to upload the file into.
    file = None # bytearray | The file to upload.
    share = 'share_example' # str | Whether to share the file with the employee. Accepted values: `yes` or `no`. Defaults to `no`. (optional)

    try:
        # Upload Employee File
        api_instance.upload_employee_file(id, file_name, category, file, share=share)
    except Exception as e:
        print("Exception when calling EmployeeFilesApi->upload_employee_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	{id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any).	[default to '0']
file_name	str	The display name for the uploaded file.
category	int	The ID of the employee file section to upload the file into.
file	bytearray	The file to upload.
share	str	Whether to share the file with the employee. Accepted values: `yes` or `no`. Defaults to `no`.	[optional]

Return type

void (empty response body)

Authorization

basic, oauth

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201	The file was uploaded successfully. The `Location` header contains the URL of the new file resource.	-
400	The request is invalid: missing file name, missing file, zero-byte file, or unsupported file extension.	-
403	The API user does not have permission to access the requested employee or their file section.	-
404	The employee or the specified file category was not found.	-
413	The file exceeds the 20MB limit or the company's storage limit.	-
503	The file storage API is temporarily unavailable.	-

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

FilesExpand file tree

EmployeeFilesApi.md

Latest commit

History

EmployeeFilesApi.md

File metadata and controls

bamboohr_sdk.EmployeeFilesApi

add_employee_file_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_employee_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_employee_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_employee_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_employee_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

upload_employee_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details