Skip to content

yasserotiefy/workiva-python-client-sdk

Repository files navigation

openapi-client

Use the Workiva Platform API to programmatically manage items in the Workiva platform, such as files, folders, tasks, comments, documents, spreadsheets, and presentations.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.workiva.com

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.app.wdesk.com/platform/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.app.wdesk.com/platform/v1"
)

# 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.

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DocumentsApi(api_client)
    document_id = 'document_id_example' # str | The unique identifier of the document
    section_id = 'section_id_example' # str | The unique identifier of the section
    section_copy = openapi_client.SectionCopy() # SectionCopy | A SectionCopy object

    try:
        # Copy section
        api_instance.copy_section(document_id, section_id, section_copy)
    except ApiException as e:
        print("Exception when calling DocumentsApi->copy_section: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.app.wdesk.com/platform/v1

Class Method HTTP request Description
DocumentsApi copy_section POST /documents/{documentId}/sections/{sectionId}/copy Copy section
DocumentsApi create_section POST /documents/{documentId}/sections Create a new section in a document
DocumentsApi delete_section_by_id DELETE /documents/{documentId}/sections/{sectionId} Delete a single section
DocumentsApi document_export POST /documents/{documentId}/export Initiate a document export
DocumentsApi get_document_by_id GET /documents/{documentId} Retrieve a single document
DocumentsApi get_documents GET /documents Retrieve a list of documents
DocumentsApi get_section_by_id GET /documents/{documentId}/sections/{sectionId} Retrieve a single section
DocumentsApi get_sections GET /documents/{documentId}/sections Retrieve a list of sections
DocumentsApi partially_update_section_by_id PATCH /documents/{documentId}/sections/{sectionId} Partially update a single section
DocumentsApi update_section_by_id PUT /documents/{documentId}/sections/{sectionId} Update a single section
FilesApi create_file POST /files Create a new file
FilesApi get_file_by_id GET /files/{fileId} Retrieve a single file
FilesApi get_files GET /files Retrieve a list of files
FilesApi import_file POST /files/import Initiate a file import
FilesApi partially_update_file_by_id PATCH /files/{fileId} Partially update a single file
FilesApi update_file_by_id PUT /files/{fileId} Update a single file
GraphApi create_edits POST /graph/edits Create new record edits
GraphApi get_record_by_id GET /graph/records/{recordId} Retrieve a single record
GraphApi get_records GET /graph/records Retrieve a list of records
GraphApi get_report_as_csv GET /graph/reports/{reportId}/csv Retrieve the CSV of a saved report
GraphApi get_type_by_id GET /graph/types/{typeId} Retrieve a single type
GraphApi get_types GET /graph/types Retrieve a list of types
GraphApi graph_report_export POST /graph/reports/{reportId}/export Initiate a graph report export
OperationsApi get_operation_by_id GET /operations/{operationId} Retrieve a single operation
PresentationsApi presentation_export POST /presentations/{presentationId}/export Initiate a presentation export
SpreadsheetsApi copy_sheet POST /spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy Copy sheet
SpreadsheetsApi create_sheet POST /spreadsheets/{spreadsheetId}/sheets Create a new sheet in a spreadsheet
SpreadsheetsApi delete_dataset_by_sheet_id DELETE /spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset Delete a single dataset
SpreadsheetsApi delete_sheet_by_id DELETE /spreadsheets/{spreadsheetId}/sheets/{sheetId} Delete a single sheet
SpreadsheetsApi get_datasets GET /spreadsheets/{spreadsheetId}/datasets Retrieve a list of datasets
SpreadsheetsApi get_sheet_by_id GET /spreadsheets/{spreadsheetId}/sheets/{sheetId} Retrieve a single sheet
SpreadsheetsApi get_sheet_data GET /spreadsheets/{spreadsheetId}/sheets/{sheetId}/sheetdata Retrieve data from a sheet
SpreadsheetsApi get_sheets GET /spreadsheets/{spreadsheetId}/sheets Retrieve a list of sheets
SpreadsheetsApi get_spreadsheet_by_id GET /spreadsheets/{spreadsheetId} Retrieve a single spreadsheet
SpreadsheetsApi get_spreadsheets GET /spreadsheets Retrieve a list of spreadsheets
SpreadsheetsApi get_values_by_range GET /spreadsheets/{spreadsheetId}/sheets/{sheetId}/values/{range} Retrieve a list of range values
SpreadsheetsApi partially_update_sheet_by_id PATCH /spreadsheets/{spreadsheetId}/sheets/{sheetId} Partially update a single sheet
SpreadsheetsApi spreadsheet_export POST /spreadsheets/{spreadsheetId}/export Initiate a spreadsheet export
SpreadsheetsApi update_sheet POST /spreadsheets/{spreadsheetId}/sheets/{sheetId}/update Update sheet content
SpreadsheetsApi update_sheet_by_id PUT /spreadsheets/{spreadsheetId}/sheets/{sheetId} Update a single sheet
SpreadsheetsApi update_values_by_range PUT /spreadsheets/{spreadsheetId}/sheets/{sheetId}/values/{range} Update values in a range
SpreadsheetsApi upsert_datasets POST /spreadsheets/{spreadsheetId}/datasets/bulkUpsert Bulk upsert of datasets
TasksApi create_task POST /tasks Create a new task
TasksApi delete_task_by_id DELETE /tasks/{taskId} Delete a single task
TasksApi get_task_by_id GET /tasks/{taskId} Retrieve a single task
TasksApi get_tasks GET /tasks Retrieve a list of tasks
TasksApi partially_update_task_by_id PATCH /tasks/{taskId} Partially update a single task
TasksApi update_task_by_id PUT /tasks/{taskId} Update a single task
TestFormsApi create_matrix POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices Create a new matrix
TestFormsApi create_sample POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples Create a new sample
TestFormsApi get_matrices GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices Retrieve a list of matrices
TestFormsApi get_matrix_attachment_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId} Retrieve a single matrix attachment
TestFormsApi get_matrix_attachments GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments Retrieve a list of matrix attachments
TestFormsApi get_matrix_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId} Retrieve a single matrix
TestFormsApi get_sample_attachment_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}/attachments/{attachmentId} Retrieve a single sample attachment
TestFormsApi get_sample_attachments GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}/attachments Retrieve a list of sample attachments
TestFormsApi get_sample_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId} Retrieve a single sample
TestFormsApi get_samples GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples Retrieve a list of samples
TestFormsApi get_test_form_by_id GET /testForms/{testFormId} Retrieve a single test form
TestFormsApi get_test_forms GET /testForms Retrieve a list of test forms
TestFormsApi get_test_phase_attachment_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId}/attachments/{attachmentId} Retrieve a single test phase attachment
TestFormsApi get_test_phase_attachments GET /testForms/{testFormId}/testPhases/{testPhaseId}/attachments Retrieve a list of test phase attachments
TestFormsApi get_test_phase_by_id GET /testForms/{testFormId}/testPhases/{testPhaseId} Retrive a single test phase
TestFormsApi get_test_phases GET /testForms/{testFormId}/testPhases Retrieve a list of test phases
TestFormsApi matrix_attachment_download_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download Initiate a matrix attachment download
TestFormsApi matrix_attachment_export_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/export Initiate an export of a matrix attachment
TestFormsApi matrix_attachment_upload POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload Initiate a matrix attachment upload
TestFormsApi partially_update_sample_by_id PATCH /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId} Partially update a single sample
TestFormsApi sample_attachment_download_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}/attachments/{attachmentId}/download Initiate a download of a sample attachment
TestFormsApi sample_attachment_export_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}/attachments/{attachmentId}/export Initiate an export of a sample attachment
TestFormsApi sample_attachment_upload POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}/attachmentUpload Initiate an upload of a sample attachment
TestFormsApi sample_insertion POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/insertion Insert samples
TestFormsApi sample_update POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/update Update samples
TestFormsApi test_form_export POST /testForms/{testFormId}/export Initiate a test form export
TestFormsApi test_phase_attachment_download_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/attachments/{attachmentId}/download Initiate a test phase attachment download
TestFormsApi test_phase_attachment_export_by_id POST /testForms/{testFormId}/testPhases/{testPhaseId}/attachments/{attachmentId}/export Initiate a test phase attachment export
TestFormsApi test_phase_attachment_upload POST /testForms/{testFormId}/testPhases/{testPhaseId}/attachmentUpload Initiate a test phase attachment upload
TestFormsApi update_sample_by_id PUT /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId} Update a single sample
UsersApi get_users GET /users Retrieve a list of users

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • file:read: Read files.
  • file:write: Write files.
  • task:read: Read tasks.
  • task:write: Write tasks.
  • graph:read: Read Graph data.
  • graph:write: Write Graph data.

Author

platformsupport@workiva.com

About

This project is to help the community of workiva to easly access Workiva API with python

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published