Workiva API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mebbert from gravatar.com mebbert

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

openapi-client

2026-01-01 Version of the Workiva API

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

  • API version: 1.2734.0
  • Package version: 1.0.0
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.app.wdesk.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.

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.ActivitiesApi(api_client)
    activity_action_id = 'com.workiva.activity.retention_policy.update' # str | The unique identifier of the activity action

    try:
        # Retrieve a single activity action
        api_response = api_instance.get_activity_action_by_id(activity_action_id)
        print("The response of ActivitiesApi->get_activity_action_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActivitiesApi->get_activity_action_by_id: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivitiesApi get_activity_action_by_id GET /activityActions/{activityActionId} Retrieve a single activity action
ActivitiesApi get_activity_actions GET /activityActions Retrieve a list of activity actions
ActivitiesApi get_activity_by_id GET /activities/{activityId} Retrieve a single activity
ActivitiesApi get_organization_activities GET /organizations/{organizationId}/activities Retrieve a list of activities for an organization
ActivitiesApi get_organization_workspace_activities GET /organizations/{organizationId}/workspaces/{workspaceId}/activities Retrieve a list of activities for a workspace
AdminApi assign_organization_user_roles POST /organizations/{organizationId}/users/{userId}/roles/assignment Assign roles for an Organization User
AdminApi assign_user_to_organization POST /organizations/{organizationId}/users/assignment Assign existing user to organization
AdminApi assign_workspace_membership_roles POST /organizations/{organizationId}/workspaces/{workspaceId}/memberships/{workspaceMembershipId}/roles/assignment Assign roles for a Workspace Membership
AdminApi create_organization_user POST /organizations/{organizationId}/users Create a new organization User
AdminApi create_workspace POST /organizations/{organizationId}/workspaces Create a new workspace
AdminApi create_workspace_group POST /organizations/{organizationId}/workspaces/{workspaceId}/groups Create a new group in a workspace
AdminApi create_workspace_membership POST /organizations/{organizationId}/workspaces/{workspaceId}/memberships Create a new workspace membership
AdminApi delete_organization_user_by_id DELETE /organizations/{organizationId}/users/{userId} Delete an organization user
AdminApi delete_workspace_group_by_id DELETE /organizations/{organizationId}/workspaces/{workspaceId}/groups/{groupId} Delete a single group
AdminApi delete_workspace_membership_by_id DELETE /organizations/{organizationId}/workspaces/{workspaceId}/memberships/{workspaceMembershipId} Delete a workspace membership
AdminApi get_organization_by_id GET /organizations/{organizationId} Retrieve a single organization
AdminApi get_organization_roles GET /organizations/{organizationId}/roles Retrieve available roles within an organization
AdminApi get_organization_solutions GET /organizations/{organizationId}/solutions Retrieve available solutions within an organization
AdminApi get_organization_user_by_id GET /organizations/{organizationId}/users/{userId} Retrieve a single user in an organization
AdminApi get_organization_user_role_list GET /organizations/{organizationId}/users/{userId}/roles List Roles assigned to an Organization User
AdminApi get_organization_users GET /organizations/{organizationId}/users Retrieve list of an organizations users
AdminApi get_organization_workspace_membership_roles GET /organizations/{organizationId}/workspaces/{workspaceId}/memberships/{workspaceMembershipId}/roles Retrieve available roles for a workspace membership
AdminApi get_organization_workspace_roles GET /organizations/{organizationId}/workspaces/{workspaceId}/roles Retrieve available roles within a workspace
AdminApi get_organizations GET /organizations Retrieve a list of organizations
AdminApi get_workspace_by_id GET /organizations/{organizationId}/workspaces/{workspaceId} Retrieve a single workspace
AdminApi get_workspace_group_by_id GET /organizations/{organizationId}/workspaces/{workspaceId}/groups/{groupId} Retrieve a single group
AdminApi get_workspace_group_members GET /organizations/{organizationId}/workspaces/{workspaceId}/groups/{groupId}/members Retrieve list of group members
AdminApi get_workspace_groups GET /organizations/{organizationId}/workspaces/{workspaceId}/groups Retrieve list of groups
AdminApi get_workspace_membership_by_id GET /organizations/{organizationId}/workspaces/{workspaceId}/memberships/{workspaceMembershipId} Retrieve a single workspace membership
AdminApi get_workspace_memberships GET /organizations/{organizationId}/workspaces/{workspaceId}/memberships Retrieve list of workspace memberships
AdminApi get_workspace_solutions GET /organizations/{organizationId}/workspaces/{workspaceId}/solutions Retrieve available solutions within a workspace
AdminApi get_workspace_solutions_by_id GET /organizations/{organizationId}/workspaces/{workspaceId}/solutions/{solutionId} Retrieve a solution by id
AdminApi get_workspaces GET /organizations/{organizationId}/workspaces Retrieve list of workspaces
AdminApi modify_workspace_group_members POST /organizations/{organizationId}/workspaces/{workspaceId}/groups/{groupId}/members/modification Modify members in a group
AdminApi partially_update_organization_by_id PATCH /organizations/{organizationId} Update a single organization
AdminApi partially_update_organization_user_by_id PATCH /organizations/{organizationId}/users/{userId} Partially update a single user in an organization
AdminApi partially_update_workspace_by_id PATCH /organizations/{organizationId}/workspaces/{workspaceId} Update a single workspace
AdminApi partially_update_workspace_group_by_id PATCH /organizations/{organizationId}/workspaces/{workspaceId}/groups/{groupId} Update a single group
AdminApi revoke_organization_user_roles POST /organizations/{organizationId}/users/{userId}/roles/revocation Revoke roles for an Organization User
AdminApi revoke_workspace_membership_roles POST /organizations/{organizationId}/workspaces/{workspaceId}/memberships/{workspaceMembershipId}/roles/revocation Revoke roles for a Workspace Membership
AdminApi workspace_membership_creation_with_options POST /organizations/{organizationId}/workspaces/{workspaceId}/memberships/membershipCreation Create a new workspace membership with options
ContentApi destination_link_source_conversion POST /content/destinationLinks/{destinationLinkId}/sourceConversion Initiate a destination link conversion
ContentApi get_anchor_by_id GET /content/anchors/{anchorId} Retrieve an anchor by ID
ContentApi get_column_properties GET /content/tables/{tableId}/properties/columns Retrieve table column properties
ContentApi get_destination_link_by_id GET /content/destinationLinks/{destinationLinkId} Retrieve a destination link by id
ContentApi get_drawing_anchor_by_id GET /content/drawings/{drawingId}/anchors/{anchorId} Retrieve a drawing anchor by ID
ContentApi get_drawing_anchor_extensions GET /content/drawings/{drawingId}/anchors/{anchorId}/extensions Retrieve a list of drawing anchor extensions
ContentApi get_drawing_anchors GET /content/drawings/{drawingId}/anchors Retrieve a list of drawing anchors
ContentApi get_drawing_elements_by_id GET /content/drawings/{drawingId}/elements Retrieve drawing elements by id
ContentApi get_image_by_id GET /content/images/{imageId} Retrieve an image by id
ContentApi get_range_link_by_id GET /content/tables/{tableId}/rangeLinks/{rangeLinkId} Retrieve a range link by id
ContentApi get_range_link_destinations GET /content/tables/{tableId}/rangeLinks/{rangeLinkId}/destinations Retrieve range link destinations for a source
ContentApi get_range_links GET /content/tables/{tableId}/rangeLinks Retrieve a list of range links
ContentApi get_rich_text_anchor_by_id GET /content/richText/{richTextId}/anchors/{anchorId} Retrieve a rich text anchor by id
ContentApi get_rich_text_anchor_extensions GET /content/richText/{richTextId}/anchors/{anchorId}/extensions Retrieve a list of rich text anchor extensions
ContentApi get_rich_text_anchors GET /content/richText/{richTextId}/anchors Retrieve a list of rich text anchors
ContentApi get_rich_text_paragraphs GET /content/richText/{richTextId}/paragraphs Retrieve rich text paragraphs
ContentApi get_row_properties GET /content/tables/{tableId}/properties/rows Retrieve table row properties
ContentApi get_style_guide_by_id GET /content/styleGuides/{styleGuideId} Retrieve a style guide by id
ContentApi get_table_anchor_by_id GET /content/tables/{tableId}/anchors/{anchorId} Retrieve a table anchor by ID
ContentApi get_table_anchor_extensions GET /content/tables/{tableId}/anchors/{anchorId}/extensions Retrieve a list of table anchor extensions
ContentApi get_table_anchors GET /content/tables/{tableId}/anchors Retrieve a list of table anchors
ContentApi get_table_cells GET /content/tables/{tableId}/cells Retrieve table cell content
ContentApi get_table_properties GET /content/tables/{tableId}/properties Retrieve a table's properties by id
ContentApi image_upload POST /content/images/upload Initiate upload of an image
ContentApi partially_update_table_properties PATCH /content/tables/{tableId}/properties Partially update a table's properties
ContentApi rich_text_anchor_creation POST /content/richText/{richTextId}/anchors/creation Initiate creation of a new rich text anchor
ContentApi rich_text_batch_edit POST /content/richText/{richTextId}/edit Initiate edits to rich text
ContentApi rich_text_duplication_edit POST /content/richText/{richTextId}/duplication/edit Initiate duplication edits to rich text
ContentApi rich_text_links_batch_edit POST /content/richText/{richTextId}/links/edit Initiate edits to rich text links
ContentApi style_guide_export POST /content/styleGuides/{styleGuideId}/export Initiate a style guide export
ContentApi style_guide_import POST /content/styleGuides/{styleGuideId}/import Initiate import of a style guide
ContentApi table_anchor_creation POST /content/tables/{tableId}/anchors/creation Initiate creation of a new table anchor
ContentApi table_cells_batch_edit POST /content/tables/{tableId}/cells/edit Initiate edits to table cells
ContentApi table_edit POST /content/tables/{tableId}/edit Initiate edit to a table
ContentApi table_filters_reapplication POST /content/tables/{tableId}/filters/reapplication Reapply filters to the table
ContentApi table_links_batch_edit POST /content/tables/{tableId}/links/edit Initiate edit to table links
ContentApi table_range_links_edit POST /content/tables/{tableId}/rangeLinks/edit Initiate range links edits on a table
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 document_filters_reapplication POST /documents/{documentId}/filters/reapplication Reapply filters to the document
DocumentsApi document_links_publication POST /documents/{documentId}/links/publication Initiate publication of links in a document
DocumentsApi document_permissions_modification POST /documents/{documentId}/permissions/modification Modify permissions on a document
DocumentsApi edit_sections POST /documents/{documentId}/sections/edit Initiate sections edits
DocumentsApi get_document_by_id GET /documents/{documentId} Retrieve a single document
DocumentsApi get_document_milestones GET /documents/{documentId}/milestones Retrieve a list of milestones for a document
DocumentsApi get_document_permissions GET /documents/{documentId}/permissions Retrieve permissions for a 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_section_permissions GET /documents/{documentId}/sections/{sectionId}/permissions Retrieve permissions for a section in a document
DocumentsApi get_sections GET /documents/{documentId}/sections Retrieve a list of sections
DocumentsApi partially_update_document_by_id PATCH /documents/{documentId} Partially update a single document
DocumentsApi partially_update_section_by_id PATCH /documents/{documentId}/sections/{sectionId} Partially update a single section
DocumentsApi section_permissions_modification POST /documents/{documentId}/sections/{sectionId}/permissions/modification Modify permissions on a given section of a document
FilesApi copy_file POST /files/{fileId}/copy Initiate a file copy
FilesApi create_file POST /files Create a new file
FilesApi export_file_by_id POST /files/{fileId}/export Initiate a file export by ID
FilesApi file_permissions_modification POST /files/{fileId}/permissions/modification Modify permissions on a file
FilesApi get_file_by_id GET /files/{fileId} Retrieve a single file
FilesApi get_file_permissions GET /files/{fileId}/permissions Retrieve permissions for a file
FilesApi get_files GET /files Retrieve a list of files
FilesApi get_trashed_files GET /files/trash Retrieve a list of trashed 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 restore_file_by_id POST /files/{fileId}/restore Initiate restoration of a single file
FilesApi trash_file_by_id POST /files/{fileId}/trash Initiate trash of 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_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
IAMApi token_request POST /oauth2/token Retrieve a token
MilestonesApi delete_milestone_by_id DELETE /milestones/{milestoneId} Deletes a milestone
MilestonesApi get_milestone_by_id GET /milestones/{milestoneId} Retrieve a milestone by id
MilestonesApi milestone_creation POST /milestones/creation Initiates a request to create a new milestone
MilestonesApi partially_update_milestone_by_id PATCH /milestones/{milestoneId} Partially updates a milestone
OperationsApi get_batch_upsertion_metric_values_results GET /operations/{operationId}/metricValuesBatchUpsertionResults Retrieve the results of a metric values batch upsertion operation
OperationsApi get_copy_file_results GET /operations/{operationId}/copyFileResults Retrieve copy file results for a single operation
OperationsApi get_destination_link_source_conversion_results GET /operations/{operationId}/destinationLinkSourceConversionResults Retrieves the results from a destination link source conversion.
OperationsApi get_image_upload_creation_results GET /operations/{operationId}/imageUploadResults Retrieve results for a image upload
OperationsApi get_import_file_results GET /operations/{operationId}/importFileResults Retrieve import file results for a single operation
OperationsApi get_milestone_creation_results GET /operations/{operationId}/milestoneCreationResults Retrieve results for a milestone creation
OperationsApi get_operation_by_id GET /operations/{operationId} Retrieve a single operation
OperationsApi get_patch_document_results GET /operations/{operationId}/patchDocumentResults Retrieve results for a patch document
OperationsApi get_patch_presentation_results GET /operations/{operationId}/patchPresentationResults Retrieve results for a patch presentation
OperationsApi get_patch_section_results GET /operations/{operationId}/patchSectionResults Retrieve results for a patch Section
OperationsApi get_patch_sheet_results GET /operations/{operationId}/patchSheetResults Retrieve results for a patch sheet
OperationsApi get_patch_slide_layout_results GET /operations/{operationId}/patchSlideLayoutResults Retrieve results for a patch slide layout
OperationsApi get_patch_slide_results GET /operations/{operationId}/patchSlideResults Retrieve results for a patch slide
OperationsApi get_patch_spreadsheet_results GET /operations/{operationId}/patchSpreadsheetResults Retrieve results for a patch spreadsheet
OperationsApi get_patch_table_properties_results GET /operations/{operationId}/patchTablePropertiesResults Retrieve results for a patch table properties
OperationsApi get_range_link_edit_results GET /operations/{operationId}/rangeLinkEditResults Retrieve results for a range link edit
OperationsApi get_rich_text_anchor_creation_results GET /operations/{operationId}/richTextAnchorCreationResults Retrieve results for a rich text anchor creation
OperationsApi get_rich_text_batch_edit_results GET /operations/{operationId}/richTextBatchEditResults Retrieve results for a rich text batch edit
OperationsApi get_rich_text_duplication_edit_results GET /operations/{operationId}/richTextDuplicationEditResults Retrieve results for a rich text duplication edit
OperationsApi get_rich_text_links_batch_edit_results GET /operations/{operationId}/richTextLinksBatchEditResults Retrieve results for a rich text links batch edit
OperationsApi get_table_anchor_creation_results GET /operations/{operationId}/tableAnchorCreationResults Retrieve results for a table anchor creation
OperationsApi get_table_cell_edit_results GET /operations/{operationId}/tableCellEditResults Retrieve results for a table cell edit
OperationsApi get_table_edit_results GET /operations/{operationId}/tableEditResults Retrieve results for a table edit
OperationsApi get_table_links_edit_results GET /operations/{operationId}/tableLinksEditResults Retrieve results for a table links edit
OperationsApi get_table_reapply_filter_results GET /operations/{operationId}/tableReapplyFilterResults Retrieve results for a table reapply filter
PermissionsApi get_permission_by_id GET /permissions/{permissionId} Retrieve a single permission
PermissionsApi get_permissions GET /permissions Retrieve a list of all available permissions
PresentationsApi get_presentation_by_id GET /presentations/{presentationId} Retrieve a single presentation
PresentationsApi get_presentation_milestones GET /presentations/{presentationId}/milestones Retrieve a list of milestones for a presentation
PresentationsApi get_slide_by_id GET /presentations/{presentationId}/slides/{slideId} Retrieve a single slide
PresentationsApi get_slide_layout_by_id GET /presentations/{presentationId}/slideLayouts/{slideLayoutId} Retrieve a single slide layout
PresentationsApi get_slide_layouts GET /presentations/{presentationId}/slideLayouts Retrieve a list of slide layouts
PresentationsApi get_slides GET /presentations/{presentationId}/slides Retrieve a list of slides
PresentationsApi partially_update_presentation_by_id PATCH /presentations/{presentationId} Partially updates a single presentation
PresentationsApi partially_update_slide_by_id PATCH /presentations/{presentationId}/slides/{slideId} Partially update a single slide
PresentationsApi partially_update_slide_layout_by_id PATCH /presentations/{presentationId}/slideLayouts/{slideLayoutId} Partially update a single slide layout
PresentationsApi presentation_export POST /presentations/{presentationId}/export Initiate a presentation export
PresentationsApi presentation_filters_reapplication POST /presentations/{presentationId}/filters/reapplication Reapply filters to the presentation
PresentationsApi presentation_links_publication POST /presentations/{presentationId}/links/publication Initiate publication of links in a presentation
ReportsApi get_org_report_users GET /organizations/{organizationId}/orgReportUsers List organization users
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_sheet_permissions GET /spreadsheets/{spreadsheetId}/sheets/{sheetId}/permissions Retrieve permissions for a sheet in a spreadsheet
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_spreadsheet_milestones GET /spreadsheets/{spreadsheetId}/milestones Retrieve a list of milestones for a spreadsheet
SpreadsheetsApi get_spreadsheet_permissions GET /spreadsheets/{spreadsheetId}/permissions Retrieve permissions for a 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 partially_update_spreadsheet_by_id PATCH /spreadsheets/{spreadsheetId} Partially update a single spreadsheet
SpreadsheetsApi sheet_permissions_modification POST /spreadsheets/{spreadsheetId}/sheets/{sheetId}/permissions/modification Modify permissions on a given sheet of a spreadsheet
SpreadsheetsApi spreadsheet_export POST /spreadsheets/{spreadsheetId}/export Initiate a spreadsheet export
SpreadsheetsApi spreadsheet_filters_reapplication POST /spreadsheets/{spreadsheetId}/filters/reapplication Reapply filters to the spreadsheet
SpreadsheetsApi spreadsheet_links_publication POST /spreadsheets/{spreadsheetId}/links/publication Initiate publication of links in a spreadsheet
SpreadsheetsApi spreadsheet_permissions_modification POST /spreadsheets/{spreadsheetId}/permissions/modification Modify permissions on a spreadsheet
SpreadsheetsApi update_sheet POST /spreadsheets/{spreadsheetId}/sheets/{sheetId}/update Update sheet content
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
SustainabilityApi batch_deletion_metric_values POST /programs/{programId}/metrics/{metricId}/values/batchDeletion Initiate a batch deletion of metric values
SustainabilityApi batch_upsertion_metric_values POST /programs/{programId}/metrics/{metricId}/values/batchUpsertion Initiate a batch upsertion of metric values
SustainabilityApi create_dimension POST /programs/{programId}/dimensions Create a new dimension
SustainabilityApi create_metric POST /programs/{programId}/metrics Create a new metric
SustainabilityApi create_program POST /programs Create a new program
SustainabilityApi create_topic POST /programs/{programId}/topics Create a new topic
SustainabilityApi create_value POST /programs/{programId}/metrics/{metricId}/values Create a new metric value
SustainabilityApi delete_metric_by_id DELETE /programs/{programId}/metrics/{metricId} Delete a single metric
SustainabilityApi delete_metric_value_by_id DELETE /programs/{programId}/metrics/{metricId}/values/{metricValueId} Delete a single metric value
SustainabilityApi delete_topic_by_id DELETE /programs/{programId}/topics/{topicId} Delete a single topic
SustainabilityApi get_dimension_by_id GET /programs/{programId}/dimensions/{dimensionId} Retrieve a single dimension
SustainabilityApi get_dimensions GET /programs/{programId}/dimensions Retrieve a list of dimensions
SustainabilityApi get_metric_by_id GET /programs/{programId}/metrics/{metricId} Retrieve a single metric
SustainabilityApi get_metric_value_by_id GET /programs/{programId}/metrics/{metricId}/values/{metricValueId} Retrieve a single metric value
SustainabilityApi get_metrics GET /programs/{programId}/metrics Retrieve a list of metrics
SustainabilityApi get_program_by_id GET /programs/{programId} Retrieve a single program
SustainabilityApi get_program_permissions GET /programs/{programId}/permissions Retrieve permissions for a program
SustainabilityApi get_programs GET /programs Retrieve a list of programs
SustainabilityApi get_topic_by_id GET /programs/{programId}/topics/{topicId} Retrieve a single topic
SustainabilityApi get_topics GET /programs/{programId}/topics Retrieve a list of topics
SustainabilityApi get_values GET /programs/{programId}/metrics/{metricId}/values Retrieve a list of metric values
SustainabilityApi partially_update_dimension_by_id PATCH /programs/{programId}/dimensions/{dimensionId} Partially update a single dimension
SustainabilityApi partially_update_metric_by_id PATCH /programs/{programId}/metrics/{metricId} Partially update a single metric
SustainabilityApi partially_update_metric_value_by_id PATCH /programs/{programId}/metrics/{metricId}/values/{metricValueId} Partially update a single metric value
SustainabilityApi partially_update_program_by_id PATCH /programs/{programId} Partially update a single program
SustainabilityApi partially_update_topic_by_id PATCH /programs/{programId}/topics/{topicId} Partially update a single topic
SustainabilityApi program_permissions_modification POST /programs/{programId}/permissions/modification Modify permissions on a program
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 submit_task_action POST /tasks/{taskId}/actionSubmission Initiate a task action submission
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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • activity:read: Read Activity data.
  • file:read: Read files.
  • file:write: Write files.
  • graph:read: Read Graph data.
  • graph:write: Write Graph data.
  • organization:read: Read Organization data.
  • organization:write: Write Organization data.

contextless-oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • file:read: Read files.
  • file:write: Write files.
  • organization:read: Read Organization data.
  • organization:write: Write Organization data.

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mebbert from gravatar.com mebbert

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

This version

1.0.3

1.0.2

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

workiva_openapi_client-1.0.3.tar.gz (422.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

workiva_openapi_client-1.0.3-py3-none-any.whl (916.8 kB view details)

Uploaded Python 3

File details

Details for the file workiva_openapi_client-1.0.3.tar.gz.

File metadata

  • Download URL: workiva_openapi_client-1.0.3.tar.gz
  • Upload date:
  • Size: 422.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for workiva_openapi_client-1.0.3.tar.gz
Algorithm Hash digest
SHA256 27074ad3555bded7790d4badc8c93ec005cfdb365aef45871d5c3372bb00d530
MD5 519024c780049f5406b0c8d45a218a61
BLAKE2b-256 78b453e6ef634a06ae44be7d5c75ad16c334c3f2c0077e488571f83556504b70

See more details on using hashes here.

File details

Details for the file workiva_openapi_client-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for workiva_openapi_client-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 eb94e60c927c15245c1bba013b3a575680d16d366e8a8912ace74dcb9865b158
MD5 69eb9d99e1cb73f96799a881a199fb4f
BLAKE2b-256 faf6d77c159db0a4aa7dcce8716ab20b42b0688eaaac8038079b87b0511c2efd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page