- Retrieves an activity given its ID.
- Retrieves a list of actions performed that may produce activities.
- Returns an action performed, given its ID Attention The Workiva Platform does not guarantee that actions taken in the platform will always result in the same Activity ID.
- Returns a paginated list of activities for a given organization.
- Returns a paginated list of activities for a given organization and workspace.
- Returns a paginated list of organizations.
- Retrieves an organization given its ID
- Updates the properties of an organization.
- Retrieves available roles within an organization given its ID
- Retrieves available solutions within an organization given its ID
- Retrieve users in an organization.
- Creates a new OrganizationUser resource
- Assign an existing organization user to an organization
- Retrieves an organization user given its ID
- Partially update the properties of a User within an Organization.
- Delete a user from an organization
- Retrieve a User's roles within an Organization
- Assign a User's roles within an Organization.
- Revoke a User's roles within an Organization.
- Retrieve a list of workspaces in an organization.
- Creates a new workspace resource
- Retrieves a workspace given its ID
- Updates the properties of a workspace.
- Retrieve a list of groups in a workspace
- Creates a new group resource
- Retrieves a group given its ID
- Updates the properties of a group.
- Deletes a group given its ID.
- Retrieve a list of members in a workspace group
- Add and/or remove members from a group.
- Retrieve all memberships of a workspace
- Creates a new `WorkspaceMembership` resource
- Creates a new `WorkspaceMembership` and allows control over notification options.
- Retrieves a workspace membership given its ID
- Revoke a user's membership to a `Workspace`.
- Retrieves available roles for a workspace membership
- Assign a member's roles within a Workspace.
- Revoke a member's roles within a Workspace.
- Retrieves available roles within a workspace given an organization and workspace ID
- Retrieves available solutions within a workspace given its ID
- Retrieve a solutions within a workspace given its ID
- Returns an `Anchor` given its id.
- Returns a `DestinationLink` given its id
- Converts a destination link into a source link.
- Returns a `DrawingElementListResult` given its id
- Returns an `AnchorsListResult` for a given drawingId.
- Returns an `Anchor` given its id.
- Returns a paginated list of `AnchorExtensions` for a given anchorId.
- Retrieves a URL that can be used to upload an image, and an operationId to track the image upload progress.
- Returns a `Image` given its id
- Returns an `AnchorsListResult` for a given richTextId.
- Create a new `Anchor` using a `RichTextAnchorCreation` request.
- Returns an `Anchor` given its id.
- Returns a paginated list of `AnchorExtensions` for a given anchorId.
- Sends a `RichTextDuplicationEdit` to perform on the rich text.
- Sends a `RichTextBatchEdit` to perform as a batch on the rich text.
- Sends a `RichTextLinksBatchEdit` to perform as a batch on the rich text.
- Returns a `ParagraphsListResult` for a rich text object, given its id.
- Returns the `StyleGuide` populated with the text styles, list styles, etc.
- Export the style guide with the given identifier.
- Imports a style guide to the given identifier.
- Returns an `AnchorsListResult` given tableId.
- Create a new `Anchor` using a `TableAnchorCreation` request.
- Returns an `Anchor` given its id.
- Returns a paginated list of `AnchorExtensions` for a given anchorId.
- Returns a `TableCellsResult` for a given tableId.
- Sends a `TableCellsBatchEdit` to perform on the cells in a table.
- Returns a `ColumnPropertiesListResult` for a table
- Sends a single `TableEdit` to perform on the table.
- Performs a `TableFiltersReapplication` on the specified table.
- Sends a `TableLinksBatchEdit` to perform on the links in a table.
- Returns a `RangeLinkListResult` for a given tableId.
- Returns a `RangeLink` given its id
- Returns a `RangeLinkListResult` of destinations for a given source range link.
- Sends a `RangeLinkEdit` to perform on the range links in a table.
- Returns a `TableProperties` for a table
- Partially updates a table's properties given its ID.
- Returns a `RowPropertiesListResult` for a table
- Retrieves the CustomSchema, which has the complete schema of custom fields and groups for the entire workspace, optionally filtering to a historical revision.
- Partially update the schema of custom fields and custom field groups for the entire workspace.
- Returns a paginated list of documents.
- Retrieves a document given its ID.
- Updates the properties of a document.
- Returns bookmarks within a document in document order.
- Sends a collection of bookmark edits to perform atomically on a document.
- Returns the bookmark with the given ID from the document.
- Asynchronously exports a document as .PDF or .DOCX., or .XHTML.
- Performs a `DocumentFiltersReapplication` on the specified document.
- Replaces existing link destinations with new destinations.
- Publishes the links in a document - either all (as document owner) or only one's own.
- Returns MilestoneListResult.
- Retrieves a paginated list of permissions for a given document
- Assign and/or revoke permissions on a document.
- Returns a list of sections.
- Creates a new section in a document, given its properties.
- Retrieves a section given its ID.
- Updates the properties of a section.
- Deletes a section given its ID.
- Asynchronously copies a section given details about the copy's destination within the same or another document.
- Updates the properties of a collection of sections in a document using SectionsEdits request.
- Retrieves a paginated list of permissions for the given section in a document
- Assign and/or revoke permissions on a section.
- Returns the collection of tables within a document.
- Returns a paginated list of files.
- Creates a new file.
- Import a file for conversion to a Workiva equivalent.
- Returns a paginated list of files that have been trashed.
- Retrieves a file given its ID
- Partially updates the properties of a file.
- Copy a file to a new location.
- Export a file by its unique ID.
- Restores a file given its ID.
- Trashes a file given its ID.
- Retrieves a paginated list of permissions for a given file
- Assign and/or revoke permissions on a file.
- Creates new record edits given their properties.
- Returns a list of records matching the provided filters.
- Retrieves a record given its ID.
- Asynchronously exports a graph report (only CSV available at this time).
- The Types endpoint is used to discover what types of records exist and their attributes.
- Returns a record type given its ID (name)
- Create a new `Milestone` using a `MilestoneCreation` request.
- Returns a `Milestone` given its id
- Partially updates a `Milestone` with a given id.
- Deletes the `Milestone` with a given id.
- Retrieves an operation given its ID.
- Returns a `CopyFileListResult` describing the results of a file copy operation.
- Returns the results for a destination link source conversion.
- Returns an `ImageUploadResultCollection` describing the results of an image upload.
- Returns a `ImportFileListResult` describing the results of a file import operation.
- Returns a `MetricValuesListResult` describing the results of a metric values batch upsertion operation.
- Returns a `MilestoneCreationListResult` describing the results of a milestone creation.
- Returns a `PatchDocumentListResult` describing the results of a patch document.
- Returns a `PatchPresentationListResult` describing the results of a patch presentation.
- Returns a `PatchSectionListResult` describing the results of a patch section.
- Returns a `PatchSheetListResult` describing the results of a patch sheet.
- Returns a `PatchSlideLayoutListResult` describing the results of a patch slide layout.
- Returns a `PatchSlideListResult` describing the results of a patch slide.
- Returns a `PatchSpreadsheetListResult` describing the results of a patch spreadsheet.
- Returns a `PatchTablePropertiesListResult` describing the results of a patch table properties.
- Returns a `RangeLinkEditResultCollection` describing the results of a range link edit.
- Returns a `RichTextEditListResult` describing the results of a rich text batch edit.
- Returns a `RichTextAnchorCreationResultCollection` describing the results of a rich text anchor creation.
- Returns a `RichTextDuplicationEditListResult` describing the results of a rich text duplication edit.
- Returns a `RichTextLinksEditListResult` describing the results of a rich text batch edit.
- Returns a `TableAnchorCreationResultCollection` describing the results of a table anchor creation.
- Returns a `TableCellEditListResult` describing the results of a table cell edit.
- Returns a `TableEditListResult` describing the results of a table edit.
- Returns a `TableLinksEditListResult` describing the results of a table links edit.
- Returns a `TableReapplyFilterListResult` describing the results of a table reapply filter.
- Returns a list of permissions.
- Retrieves a permission given its ID
- Retrieves a presentation given its ID.
- Updates the properties of a presentation.
- Asynchronously export a presentation as .PDF or .PPTX.
- Performs a `PresentationFiltersReapplication` on the specified presentation.
- Replaces existing link destinations with new destinations.
- Publishes the links in a presentation - either all (as document owner) or only one's own.
- Returns MilestoneListResult.
- Retrieves a paginated list of permissions for a given presentation
- Assign and/or revoke permissions on a presentation.
- Returns a list of slide layouts.
- Retrieves a slide layout given its ID.
- Updates one or more properties of a single slide layout.
- Returns a list of slides.
- Retrieves a slide given its ID.
- Updates one or more properties of a single slide.
- Retrieves a paginated list of permissions for the given slide in a presentation
- Assign and/or revoke permissions on a slide.
- Returns the collection of tables within a presentation.
- Retrieve a ProcessRun (running instance of a process) by its unique identifier.
- Retrieve a paginated list of processes the caller has access to, with each process's associated ProcessRun embedded (if started).
- Create a new process with the specified configuration and job hierarchy.
- Retrieve a process by its id.
- Updates the properties of a process via JSON Patch.
- Updates names for specified jobs and groups.
- Run an existing process by its id, creating a new ProcessRun.
- Run a validation check on a process and return any structural or configuration errors found.
- Similar to an organization admin's "People View" export, this returns a paged list of specific details about the organization's users, including their usernames, display names, email addresses, SAML IDs, last logins, workspace memberships, licenses and roles.
- Returns a paginated list of spreadsheets.
- Retrieves a spreadsheet given its ID.
- Updates the properties of a spreadsheet.
- Returns a list of datasets.
- Asynchronously upserts an array of datasets to a spreadsheet, given their properties.
- Asynchronously exports a spreadsheet as .XLSX, .PDF, or .CSV.
- Performs a `SpreadsheetFiltersReapplication` on the specified spreadsheet.
- Replaces existing link destinations with new destinations.
- Publishes the links in a spreadsheet - either all (as document owner) or only one's own.
- Returns MilestoneListResult.
- Retrieves a paginated list of permissions for a given spreadsheet
- Assign and/or revoke permissions on a spreadsheet.
- Returns a list of sheets.
- Creates a new sheet in a spreadsheet, given its properties.
- Retrieves a sheet given its ID.
- Updates the properties of a sheet.
- Deletes a sheet given its ID.
- Asynchronously copies a sheet given details about the copy's destination within the same or another spreadsheet.
- Deletes the dataset for the specified sheet.
- Retrieves a paginated list of permissions for the given sheet in a spreadsheet
- Assign and/or revoke permissions on a sheet.
- Retrieve data from a range in a sheet.
- Asynchronously submits a SheetUpdate to a sheet.
- Returns the paginated values for a specified range.
- Overwrites all values in a range with new values.
- Returns a paginated list of programs.
- Creates a new program.
- Retrieves a program given its ID
- Partially updates the properties of a program.
- Returns a paginated list of dimensions.
- Creates a new dimension.
- Retrieves a dimension given its ID
- Partially updates the properties of a dimension.
- Returns a paginated list of Metrics.
- Creates a new metric.
- Retrieves a `Metric` given its ID
- Partially updates the properties of a metric.
- Deletes a metric given its ID
- Returns a paginated list of metric Values
- Creates a new metric value
- Retrieves a metric value given its ID
- Partially updates the properties of a metric value.
- Deletes a metric value given its ID
- Batch delete the given metric values.
- Batch upsert values for the given metric.
- Retrieves a paginated list of permissions for a given Sustainability Program
- Assign and/or revoke permissions on a Sustainability Program.
- Returns a paginated list of topics.
- Creates a new topic.
- Retrieves a topic given its ID
- Partially updates the properties of a topic.
- Deletes a topic given its ID
- Returns a paginated list of tasks.
- Creates a new task given its properties.
- Retrieves a task given its ID
- Partially updates the properties of a task.
- Deletes a task given its ID
- This endpoint enables submitting actions on a task.
- Retrieves a list of test forms.
- Retrieves a test form given its ID.
- Asynchronously exports a test form.
- Returns a list of test phases.
- Retrieves a test phase given its ID.
- Starts the process to upload and attach a file to a test phase using a graph attachment upload object.
- Returns a list of attachments for a test phase.
- Retrieve a single attachment by its ID.
- Asynchronously downloads an attachment from a test phase.
- Asynchronously exports an attachment for a test phase to .PDF.
- Returns a list of matrices.
- Create a new empty matrix.
- Retrieves a matrix given its ID.
- Starts the process to upload and attach a file to a matrix using a graph attachment upload object.
- Returns a list of attachments for a matrix.
- Retrieve a single attachment by its ID.
- Asynchronously downloads an attachment from a matrix.
- Asynchronously exports an attachment for a matrix to .PDF.
- Returns a list of samples.
- Create a new sample in a matrix.
- Inserts multiple samples into a matrix, and appends new samples to the end of the matrix.
- Updates multiple samples, with the requestBody of each specifying columns to update by their IDs.
- Retrieves a sample given its ID.
- Partially updates the properties of a sample.
- Starts the process to upload and attach a file to a sample using a graph attachment upload object.
- Returns a list of attachments for a sample.
- Retrieve a single attachment by its ID.
- Asynchronously downloads an attachment from a sample.
- Asynchronously exports an attachment for a sample to .PDF.
No matching actions