Skip to content

Bright-Research/veeva-sdk-r-client

Repository files navigation

R API client for Veeva Vault

The latest GA version of the Vault REST API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

  • API version: 25.1
  • Package version: 1.0.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/GIT_USER_ID/GIT_REPO_ID
cd GIT_REPO_ID
R CMD build .
R CMD check openapi_1.0.0.tar.gz --no-manual
R CMD INSTALL --preclean openapi_1.0.0.tar.gz

Install the package

install.packages("openapi")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")

To install the package from a local file:

install.packages("openapi_1.0.0.tar.gz", repos = NULL, type = "source")

Usage

library(openapi)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

All URIs are relative to http://}/api/v25.1

Class Method HTTP request Description
DefaultApi ApiGet GET /api/ Retrieve API Versions
DefaultApi ApiMdlComponentsComponentTypeAndRecordNameFilesGet GET /api/mdl/components/{component_type_and_record_name}/files Retrieve Content File
DefaultApi ApiMdlComponentsComponentTypeAndRecordNameGet GET /api/mdl/components/{component_type_and_record_name} Retrieve Component Record (MDL)
DefaultApi ApiMdlExecuteAsyncJobIdResultsGet GET /api/mdl/execute_async/{job_id}/results Retrieve Asynchronous MDL Script Results
DefaultApi ApiMdlExecuteAsyncPost POST /api/mdl/execute_async Execute MDL Script Asynchronously
DefaultApi ApiMdlExecutePost POST /api/mdl/execute Execute MDL Script
DefaultApi ApiMdlFilesPost POST /api/mdl/files Upload Content File
DefaultApi AudittrailAuditTrailTypeGet GET /audittrail/{audit_trail_type} Retrieve Audit Details
DefaultApi AuthDiscoveryPost POST /auth/discovery Authentication Type Discovery
DefaultApi AuthOauthSessionOathOidcProfileIdPost POST /auth/oauth/session/{oath_oidc_profile_id} OAuth 2.0 / OpenID Connect
DefaultApi AuthPost POST /auth User Name and Password
DefaultApi CodeClassNameDelete DELETE /code/{class_name} Delete Single Source Code File
DefaultApi CodeClassNameDisablePut PUT /code/{class_name}/disable Disable Vault Extension
DefaultApi CodeClassNameEnablePut PUT /code/{class_name}/enable Enable Vault Extension
DefaultApi CodeClassNameGet GET /code/{class_name} Retrieve Single Source Code File
DefaultApi CodeProfilerGet GET /code/profiler Retrieve All Profiling Sessions
DefaultApi CodeProfilerPost POST /code/profiler Create Profiling Session
DefaultApi CodeProfilerSessionNameActionsEndPost POST /code/profiler/{session_name}/actions/end End Profiling Session
DefaultApi CodeProfilerSessionNameDelete DELETE /code/profiler/{session_name} Delete Profiling Session
DefaultApi CodeProfilerSessionNameGet GET /code/profiler/{session_name} Retrieve Profiling Session
DefaultApi CodeProfilerSessionNameResultsGet GET /code/profiler/{session_name}/results Download Profiling Session Results
DefaultApi CodePut PUT /code Add or Replace Single Source Code File
DefaultApi CompositesTreesEdlHierarchyOrTemplateActionsListnodesPost POST /composites/trees/{edl_hierarchy_or_template}/actions/listnodes Retrieve Specific Root Nodes
DefaultApi CompositesTreesEdlHierarchyOrTemplateGet GET /composites/trees/{edl_hierarchy_or_template} Retrieve All Root Nodes
DefaultApi CompositesTreesEdlHierarchyVParentNodeIdChildrenGet GET /composites/trees/edl_hierarchy__v/{parent_node_id}/children Retrieve a Node's Children
DefaultApi CompositesTreesEdlHierarchyVParentNodeIdChildrenPut PUT /composites/trees/edl_hierarchy__v/{parent_node_id}/children Update Node Order
DefaultApi ConfigurationComponentTypeAndRecordNameGet GET /configuration/{component_type_and_record_name} Retrieve Component Record (XML/JSON)
DefaultApi ConfigurationComponentTypeGet GET /configuration/{component_type} Retrieve Component Record Collection
DefaultApi ConfigurationObjectNameAndObjectTypeGet GET /configuration/{object_name_and_object_type} Retrieve Details from a Specific Object
DefaultApi ConfigurationObjecttypeGet GET /configuration/Objecttype Retrieve Details from All Object Types
DefaultApi ConfigurationRoleAssignmentRuleDelete DELETE /configuration/role_assignment_rule Delete Lifecycle Role Assignment Override Rules
DefaultApi ConfigurationRoleAssignmentRuleGet GET /configuration/role_assignment_rule Retrieve Lifecycle Role Assignment Rules (Default & Override)
DefaultApi ConfigurationRoleAssignmentRulePost POST /configuration/role_assignment_rule Create Lifecycle Role Assignment Override Rules
DefaultApi ConfigurationRoleAssignmentRulePut PUT /configuration/role_assignment_rule Update Lifecycle Role Assignment Rules (Default & Override)
DefaultApi DelegationLoginPost POST /delegation/login Initiate Delegated Session
DefaultApi DelegationVaultsGet GET /delegation/vaults Retrieve Delegations
DefaultApi KeepAlivePost POST /keep-alive Session Keep Alive
DefaultApi LimitsGet GET /limits Retrieve Limits on Objects
DefaultApi LogsApiUsageGet GET /logs/api_usage Download Daily API Usage
DefaultApi LogsCodeDebugGet GET /logs/code/debug Retrieve All Debug Logs
DefaultApi LogsCodeDebugIdActionsResetDelete DELETE /logs/code/debug/{id}/actions/reset Delete Debug Log
DefaultApi LogsCodeDebugIdActionsResetPost POST /logs/code/debug/{id}/actions/reset Reset Debug Log
DefaultApi LogsCodeDebugIdFilesGet GET /logs/code/debug/{id}/files Download Debug Log Files
DefaultApi LogsCodeDebugIdGet GET /logs/code/debug/{id} Retrieve Single Debug Log
DefaultApi LogsCodeDebugPost POST /logs/code/debug Create Debug Log
DefaultApi LogsCodeRuntimeGet GET /logs/code/runtime Download SDK Runtime Log
DefaultApi MessagesMessageTypeActionsImportPost POST /messages/{message_type}/actions/import Import Bulk Translation File
DefaultApi MessagesMessageTypeLanguageLangActionsExportPost POST /messages/{message_type}/language/{lang}/actions/export Export Bulk Translation File
DefaultApi MetadataAudittrailAuditTrailTypeGet GET /metadata/audittrail/{audit_trail_type} Retrieve Audit Metadata
DefaultApi MetadataAudittrailGet GET /metadata/audittrail Retrieve Audit Types
DefaultApi MetadataComponentsComponentTypeGet GET /metadata/components/{component_type} Retrieve Component Type Metadata
DefaultApi MetadataComponentsGet GET /metadata/components Retrieve All Component Metadata
DefaultApi MetadataObjectsBindersTemplatesBindernodesGet GET /metadata/objects/binders/templates/bindernodes Retrieve Binder Template Node Metadata
DefaultApi MetadataObjectsBindersTemplatesGet GET /metadata/objects/binders/templates Retrieve Binder Template Metadata
DefaultApi MetadataObjectsDocumentsAnnotationsPlacemarksTypesPlacemarkTypeGet GET /metadata/objects/documents/annotations/placemarks/types/{placemark_type} Retrieve Annotation Placemark Type Metadata
DefaultApi MetadataObjectsDocumentsAnnotationsReferencesTypesReferenceTypeGet GET /metadata/objects/documents/annotations/references/types/{reference_type} Retrieve Annotation Reference Type Metadata
DefaultApi MetadataObjectsDocumentsAnnotationsTypesAnnotationTypeGet GET /metadata/objects/documents/annotations/types/{annotation_type} Retrieve Annotation Type Metadata
DefaultApi MetadataObjectsDocumentsEventsEventTypeTypesEventSubtypeGet GET /metadata/objects/documents/events/{event_type}/types/{event_subtype} Retrieve Document Event SubType Metadata
DefaultApi MetadataObjectsDocumentsEventsGet GET /metadata/objects/documents/events Retrieve Document Event Types and Subtypes
DefaultApi MetadataObjectsDocumentsLockGet GET /metadata/objects/documents/lock Retrieve Document Lock Metadata
DefaultApi MetadataObjectsDocumentsPropertiesFindCommonPost POST /metadata/objects/documents/properties/find_common Retrieve Common Document Fields
DefaultApi MetadataObjectsDocumentsPropertiesGet GET /metadata/objects/documents/properties Retrieve All Document Fields
DefaultApi MetadataObjectsDocumentsTemplatesGet GET /metadata/objects/documents/templates Retrieve Document Template Metadata
DefaultApi MetadataObjectsDocumentsTypesGet GET /metadata/objects/documents/types Retrieve All Document Types
DefaultApi MetadataObjectsDocumentsTypesTypeGet GET /metadata/objects/documents/types/{type} Retrieve Document Type
DefaultApi MetadataObjectsDocumentsTypesTypeRelationshipsGet GET /metadata/objects/documents/types/{type}/relationships Retrieve Document Type Relationships
DefaultApi MetadataObjectsDocumentsTypesTypeSubtypesSubtypeClassificationsClassificationGet GET /metadata/objects/documents/types/{type}/subtypes/{subtype}/classifications/{classification} Retrieve Document Classification
DefaultApi MetadataObjectsDocumentsTypesTypeSubtypesSubtypeGet GET /metadata/objects/documents/types/{type}/subtypes/{subtype} Retrieve Document Subtype
DefaultApi MetadataObjectsGroupsGet GET /metadata/objects/groups Retrieve Group Metadata
DefaultApi MetadataObjectsSecuritypoliciesGet GET /metadata/objects/securitypolicies Retrieve Security Policy Metadata
DefaultApi MetadataObjectsUsersGet GET /metadata/objects/users Retrieve User Metadata
DefaultApi MetadataQueryArchivedDocumentsRelationshipsDocumentSignatureSysrGet GET /metadata/query/archived_documents/relationships/document_signature__sysr Retrieve Archived Document Signature Metadata
DefaultApi MetadataQueryDocumentsRelationshipsDocumentSignatureSysrGet GET /metadata/query/documents/relationships/document_signature__sysr Retrieve Document Signature Metadata
DefaultApi MetadataVobjectsGet GET /metadata/vobjects Retrieve Object Collection
DefaultApi MetadataVobjectsObjectNameActionsCanceldeploymentPost POST /metadata/vobjects/{object_name}/actions/canceldeployment Cancel Raw Object Deployment
DefaultApi MetadataVobjectsObjectNameFieldsObjectFieldNameGet GET /metadata/vobjects/{object_name}/fields/{object_field_name} Retrieve Object Field Metadata
DefaultApi MetadataVobjectsObjectNameGet GET /metadata/vobjects/{object_name} Retrieve Object Metadata
DefaultApi MetadataVobjectsObjectNamePageLayoutsGet GET /metadata/vobjects/{object_name}/page_layouts Retrieve Page Layouts
DefaultApi MetadataVobjectsObjectNamePageLayoutsLayoutNameGet GET /metadata/vobjects/{object_name}/page_layouts/{layout_name} Retrieve Page Layout Metadata
DefaultApi NotificationsHistoriesGet GET /notifications/histories Retrieve Email Notification Histories
DefaultApi ObjectWorkflowActionsActionGet GET /object/workflow/actions/{action} Retrieve Bulk Workflow Action Details
DefaultApi ObjectWorkflowActionsActionPost POST /object/workflow/actions/{action} Initiate Workflow Actions on Multiple Workflows
DefaultApi ObjectWorkflowActionsCanceltasksPost POST /object/workflow/actions/canceltasks Cancel Workflow Tasks
DefaultApi ObjectWorkflowActionsCancelworkflowsPost POST /object/workflow/actions/cancelworkflows Cancel Workflows
DefaultApi ObjectWorkflowActionsGet GET /object/workflow/actions Retrieve Bulk Workflow Actions
DefaultApi ObjectWorkflowActionsReassigntasksPost POST /object/workflow/actions/reassigntasks Reassign Workflow Tasks
DefaultApi ObjectWorkflowActionsReplaceworkflowownerPost POST /object/workflow/actions/replaceworkflowowner Replace Workflow Owner
DefaultApi ObjectsBindersActionsExportJobIdResultsGet GET /objects/binders/actions/export/{job_id}/results Retrieve Binder Export Results
DefaultApi ObjectsBindersBinderIdActionsExportPost POST /objects/binders/{binder_id}/actions/export Export Binder (Latest Version)
DefaultApi ObjectsBindersBinderIdActionsPost POST /objects/binders/{binder_id}/actions Refresh Binder Auto-Filing
DefaultApi ObjectsBindersBinderIdBindingRulePut PUT /objects/binders/{binder_id}/binding_rule Update Binding Rule
DefaultApi ObjectsBindersBinderIdDelete DELETE /objects/binders/{binder_id} Delete Binder
DefaultApi ObjectsBindersBinderIdDocumentsNodeIdBindingRulePut PUT /objects/binders/{binder_id}/documents/{node_id}/binding_rule Update Binder Document Binding Rule
DefaultApi ObjectsBindersBinderIdDocumentsPost POST /objects/binders/{binder_id}/documents Add Document to Binder
DefaultApi ObjectsBindersBinderIdDocumentsSectionIdDelete DELETE /objects/binders/{binder_id}/documents/{section_id} Remove Document from Binder
DefaultApi ObjectsBindersBinderIdDocumentsSectionIdPut PUT /objects/binders/{binder_id}/documents/{section_id} Move Document in Binder
DefaultApi ObjectsBindersBinderIdGet GET /objects/binders/{binder_id} Retrieve Binder
DefaultApi ObjectsBindersBinderIdPost POST /objects/binders/{binder_id} Create Binder Version
DefaultApi ObjectsBindersBinderIdPut PUT /objects/binders/{binder_id} Update Binder
DefaultApi ObjectsBindersBinderIdRolesRoleNameAndUserOrGroupIdDelete DELETE /objects/binders/{binder_id}/roles/{role_name_and_user_or_group}/{id} Remove Users & Groups from Roles on a Single Binder
DefaultApi ObjectsBindersBinderIdSectionsNodeIdBindingRulePut PUT /objects/binders/{binder_id}/sections/{node_id}/binding_rule Update Binder Section Binding Rule
DefaultApi ObjectsBindersBinderIdSectionsNodeIdPut PUT /objects/binders/{binder_id}/sections/{node_id} Update Binder Section
DefaultApi ObjectsBindersBinderIdSectionsPost POST /objects/binders/{binder_id}/sections Create Binder Section
DefaultApi ObjectsBindersBinderIdSectionsSectionIdDelete DELETE /objects/binders/{binder_id}/sections/{section_id} Delete Binder Section
DefaultApi ObjectsBindersBinderIdSectionsSectionIdGet GET /objects/binders/{binder_id}/sections/{section_id} Retrieve Binder Sections
DefaultApi ObjectsBindersBinderIdVersionsGet GET /objects/binders/{binder_id}/versions Retrieve All Binder Versions
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionActionsExportPost POST /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/actions/export Export Binder (Specific Version)
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionDelete DELETE /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Delete Binder Version
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionGet GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Retrieve Binder Version
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionPut PUT /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Update Binder Version
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionRelationshipsPost POST /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships Create Binder Relationship
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionRelationshipsRelationshipIdDelete DELETE /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Delete Binder Relationship
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionRelationshipsRelationshipIdGet GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Retrieve Binder Relationship
DefaultApi ObjectsBindersBinderIdVersionsMajorVersionMinorVersionSectionsSectionIdGet GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/sections/{section_id} Retrieve Binder Version Section
DefaultApi ObjectsBindersIdRolesGet GET /objects/binders/{id}/roles Retrieve All Binder Roles
DefaultApi ObjectsBindersIdRolesPost POST /objects/binders/{id}/roles Assign Users & Groups to Roles on a Single Binder
DefaultApi ObjectsBindersIdRolesRoleNameGet GET /objects/binders/{id}/roles/{role_name} Retrieve Document Role
DefaultApi ObjectsBindersIdVersionsMajorVersionMinorVersionLifecycleActionsGet GET /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions Retrieve Binder User Actions
DefaultApi ObjectsBindersIdVersionsMajorVersionMinorVersionLifecycleActionsNameVEntryRequirementsGet GET /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements Retrieve Binder Entry Criteria
DefaultApi ObjectsBindersIdVersionsMajorVersionMinorVersionLifecycleActionsNameVPut PUT /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v} Initiate Binder User Action
DefaultApi ObjectsBindersLifecycleActionsPost POST /objects/binders/lifecycle_actions Retrieve User Actions on Multiple Binders
DefaultApi ObjectsBindersLifecycleActionsUserActionNamePut PUT /objects/binders/lifecycle_actions/{user_action_name} Initiate Bulk Binder User Actions
DefaultApi ObjectsBindersPost POST /objects/binders Create Binder
DefaultApi ObjectsBindersTemplatesGet GET /objects/binders/templates Retrieve Binder Template Collection
DefaultApi ObjectsBindersTemplatesPost POST /objects/binders/templates Create Binder Template
DefaultApi ObjectsBindersTemplatesPut PUT /objects/binders/templates Update Binder Template
DefaultApi ObjectsBindersTemplatesTemplateNameBindernodesGet GET /objects/binders/templates/{template_name}/bindernodes Retrieve Binder Template Node Attributes
DefaultApi ObjectsBindersTemplatesTemplateNameBindernodesPost POST /objects/binders/templates/{template_name}/bindernodes Create Binder Template Node
DefaultApi ObjectsBindersTemplatesTemplateNameBindernodesPut PUT /objects/binders/templates/{template_name}/bindernodes Replace Binder Template Nodes
DefaultApi ObjectsBindersTemplatesTemplateNameDelete DELETE /objects/binders/templates/{template_name} Delete Binder Template
DefaultApi ObjectsBindersTemplatesTemplateNameGet GET /objects/binders/templates/{template_name} Retrieve Binder Template Attributes
DefaultApi ObjectsDeletionsDocumentsGet GET /objects/deletions/documents Retrieve Deleted Document IDs
DefaultApi ObjectsDeletionsVobjectsObjectNameGet GET /objects/deletions/vobjects/{object_name} Retrieve Deleted Object Record ID
DefaultApi ObjectsDocumentsActionsGet GET /objects/documents/actions Retrieve All Document Workflows
DefaultApi ObjectsDocumentsActionsLifecycleAndStateAndActionJobIdResultsGet GET /objects/documents/actions/{lifecycle_and_state_and_action}/{job_id}/results Download Controlled Copy Job Results
DefaultApi ObjectsDocumentsActionsWorkflowNameGet GET /objects/documents/actions/{workflow_name} Retrieve Document Workflow Details
DefaultApi ObjectsDocumentsActionsWorkflowNamePost POST /objects/documents/actions/{workflow_name} Initiate Document Workflow
DefaultApi ObjectsDocumentsAnnotationsBatchDelete DELETE /objects/documents/annotations/batch Delete Annotations
DefaultApi ObjectsDocumentsAnnotationsBatchPost POST /objects/documents/annotations/batch Create Multiple Annotations
DefaultApi ObjectsDocumentsAnnotationsBatchPut PUT /objects/documents/annotations/batch Update Annotations
DefaultApi ObjectsDocumentsAnnotationsRepliesBatchPost POST /objects/documents/annotations/replies/batch Add Annotation Replies
DefaultApi ObjectsDocumentsAttachmentsBatchDelete DELETE /objects/documents/attachments/batch Delete Multiple Document Attachments
DefaultApi ObjectsDocumentsAttachmentsBatchPost POST /objects/documents/attachments/batch Create Multiple Document Attachments
DefaultApi ObjectsDocumentsAttachmentsBatchPut PUT /objects/documents/attachments/batch Update Multiple Document Attachment Descriptions
DefaultApi ObjectsDocumentsBatchActionsFileextractJobIdResultsGet GET /objects/documents/batch/actions/fileextract/{job_id}/results Retrieve Document Export Results
DefaultApi ObjectsDocumentsBatchActionsFileextractPost POST /objects/documents/batch/actions/fileextract Export Documents
DefaultApi ObjectsDocumentsBatchActionsReclassifyPut PUT /objects/documents/batch/actions/reclassify Reclassify Multiple Documents
DefaultApi ObjectsDocumentsBatchActionsRerenderPost POST /objects/documents/batch/actions/rerender Update Multiple Document Renditions
DefaultApi ObjectsDocumentsBatchDelete DELETE /objects/documents/batch Delete Multiple Documents
DefaultApi ObjectsDocumentsBatchLockDelete DELETE /objects/documents/batch/lock Undo Collaborative Authoring Checkout
DefaultApi ObjectsDocumentsBatchPost POST /objects/documents/batch Create Multiple Documents
DefaultApi ObjectsDocumentsBatchPut PUT /objects/documents/batch Update Multiple Documents
DefaultApi ObjectsDocumentsDocIdAnchorsGet GET /objects/documents/{doc_id}/anchors Retrieve Anchor IDs
DefaultApi ObjectsDocumentsDocIdAnnotationsFileGet GET /objects/documents/{doc_id}/annotations/file Export Document Annotations to PDF
DefaultApi ObjectsDocumentsDocIdAnnotationsFilePost POST /objects/documents/{doc_id}/annotations/file Import Document Annotations from PDF
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdDelete DELETE /objects/documents/{doc_id}/attachments/{attachment_id} Delete Single Document Attachment
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdFileGet GET /objects/documents/{doc_id}/attachments/{attachment_id}/file Download Document Attachment
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdGet GET /objects/documents/{doc_id}/attachments/{attachment_id} Retrieve Document Attachment Metadata
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdPut PUT /objects/documents/{doc_id}/attachments/{attachment_id} Update Document Attachment Description
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdVersionsAttachmentVersionDelete DELETE /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Delete Single Document Attachment Version
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdVersionsAttachmentVersionFileGet GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}/file Download Document Attachment Version
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdVersionsAttachmentVersionGet GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Document Attachment Version Metadata
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdVersionsAttachmentVersionPost POST /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Restore Document Attachment Version
DefaultApi ObjectsDocumentsDocIdAttachmentsAttachmentIdVersionsGet GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions Retrieve Document Attachment Versions
DefaultApi ObjectsDocumentsDocIdAttachmentsFileGet GET /objects/documents/{doc_id}/attachments/file Download All Document Attachments
DefaultApi ObjectsDocumentsDocIdAttachmentsGet GET /objects/documents/{doc_id}/attachments Retrieve Document Attachments
DefaultApi ObjectsDocumentsDocIdAttachmentsPost POST /objects/documents/{doc_id}/attachments Create Document Attachment
DefaultApi ObjectsDocumentsDocIdAudittrailGet GET /objects/documents/{doc_id}/audittrail Retrieve Complete Audit History for a Single Document
DefaultApi ObjectsDocumentsDocIdDelete DELETE /objects/documents/{doc_id} Delete Single Document
DefaultApi ObjectsDocumentsDocIdEventsGet GET /objects/documents/{doc_id}/events Retrieve Document Events
DefaultApi ObjectsDocumentsDocIdFileGet GET /objects/documents/{doc_id}/file Download Document File
DefaultApi ObjectsDocumentsDocIdGet GET /objects/documents/{doc_id} Retrieve Document
DefaultApi ObjectsDocumentsDocIdLockDelete DELETE /objects/documents/{doc_id}/lock Delete Document Lock
DefaultApi ObjectsDocumentsDocIdLockGet GET /objects/documents/{doc_id}/lock Retrieve Document Lock
DefaultApi ObjectsDocumentsDocIdLockPost POST /objects/documents/{doc_id}/lock Create Document Lock
DefaultApi ObjectsDocumentsDocIdMajorVersionMinorVersionAttachmentsFileGet GET /objects/documents/{doc_id}/{major_version}/{minor_version}/attachments/file Download All Document Version Attachments
DefaultApi ObjectsDocumentsDocIdPost POST /objects/documents/{doc_id} Create Single Document Version
DefaultApi ObjectsDocumentsDocIdPut PUT /objects/documents/{doc_id} Update Single Document
DefaultApi ObjectsDocumentsDocIdRenditionsGet GET /objects/documents/{doc_id}/renditions Retrieve Document Renditions
DefaultApi ObjectsDocumentsDocIdRenditionsRenditionTypeDelete DELETE /objects/documents/{doc_id}/renditions/{rendition_type} Delete Single Document Rendition
DefaultApi ObjectsDocumentsDocIdRenditionsRenditionTypeGet GET /objects/documents/{doc_id}/renditions/{rendition_type} Download Document Rendition File
DefaultApi ObjectsDocumentsDocIdRenditionsRenditionTypePost POST /objects/documents/{doc_id}/renditions/{rendition_type} Add Single Document Rendition
DefaultApi ObjectsDocumentsDocIdRenditionsRenditionTypePut PUT /objects/documents/{doc_id}/renditions/{rendition_type} Replace Document Rendition
DefaultApi ObjectsDocumentsDocIdRolesRoleNameAndUserOrGroupIdDelete DELETE /objects/documents/{doc_id}/roles/{role_name_and_user_or_group}/{id} Remove Users & Groups from Roles on a Single Document
DefaultApi ObjectsDocumentsDocIdVersionMajorVersionMinorVersionAttachmentsGet GET /objects/documents/{doc_id}/version/{major_version}/{minor_version}/attachments Retrieve Document Version Attachments
DefaultApi ObjectsDocumentsDocIdVersionsGet GET /objects/documents/{doc_id}/versions Retrieve Document Versions
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAnnotationsAnnotationIdGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/{annotation_id} Read Annotations by ID
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAnnotationsAnnotationIdRepliesGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/{annotation_id}/replies Read Replies of Parent Annotation
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAnnotationsFileGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/file Export Document Version Annotations to PDF
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAnnotationsFilePost POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/file Import Document Version Annotations from PDF
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAnnotationsGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations Read Annotations by Document Version and Type
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAttachmentsAttachmentIdVersionsAttachmentVersionFileGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}/file Download Document Version Attachment Version
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionAttachmentsAttachmentIdVersionsAttachmentVersionGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Document Version Attachment Versions
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionDelete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Delete Single Document Version
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionDocExportAnnotationsToCsvGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/doc-export-annotations-to-csv Retrieve Document Version Notes as CSV
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionEventsPost POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/events Create Document Event
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionExportVideoAnnotationsGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/export-video-annotations Retrieve Video Annotations
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionFileGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/file Download Document Version File
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Retrieve Document Version
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionPut PUT /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Update Document Version
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRelationshipsGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships Retrieve Document Relationships
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRelationshipsPost POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships Create Single Document Relationship
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRelationshipsRelationshipIdDelete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Delete Single Document Relationship
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRelationshipsRelationshipIdGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Retrieve Document Relationship
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRenditionsGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions Retrieve Document Version Renditions
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRenditionsRenditionTypeDelete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Delete Document Version Rendition
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRenditionsRenditionTypeGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Download Document Version Rendition File
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRenditionsRenditionTypePost POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Upload Document Version Rendition
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionRenditionsRenditionTypePut PUT /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Replace Document Version Rendition
DefaultApi ObjectsDocumentsDocIdVersionsMajorVersionMinorVersionThumbnailGet GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/thumbnail Download Document Version Thumbnail File
DefaultApi ObjectsDocumentsGet GET /objects/documents Retrieve All Documents
DefaultApi ObjectsDocumentsIdRolesGet GET /objects/documents/{id}/roles Retrieve All Document Roles
DefaultApi ObjectsDocumentsIdRolesPost POST /objects/documents/{id}/roles Assign Users & Groups to Roles on a Single Document
DefaultApi ObjectsDocumentsIdRolesRoleNameGet GET /objects/documents/{id}/roles/{role_name} Retrieve Document Role
DefaultApi ObjectsDocumentsIdVersionsMajorVersionMinorVersionLifecycleActionsGet GET /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions Retrieve Document User Actions
DefaultApi ObjectsDocumentsIdVersionsMajorVersionMinorVersionLifecycleActionsNameVEntryRequirementsGet GET /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements Retrieve Document Entry Criteria
DefaultApi ObjectsDocumentsIdVersionsMajorVersionMinorVersionLifecycleActionsNameVPut PUT /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v} Initiate Document User Action
DefaultApi ObjectsDocumentsLifecycleActionsPost POST /objects/documents/lifecycle_actions Retrieve User Actions on Multiple Documents
DefaultApi ObjectsDocumentsLifecycleActionsUserActionNamePut PUT /objects/documents/lifecycle_actions/{user_action_name} Initiate Bulk Document User Actions
DefaultApi ObjectsDocumentsPost POST /objects/documents Create Single Document
DefaultApi ObjectsDocumentsRelationshipsBatchDelete DELETE /objects/documents/relationships/batch Delete Multiple Document Relationships
DefaultApi ObjectsDocumentsRelationshipsBatchPost POST /objects/documents/relationships/batch Create Multiple Document Relationships
DefaultApi ObjectsDocumentsRenditionsBatchDelete DELETE /objects/documents/renditions/batch Delete Multiple Document Renditions
DefaultApi ObjectsDocumentsRenditionsBatchPost POST /objects/documents/renditions/batch Add Multiple Document Renditions
DefaultApi ObjectsDocumentsRolesBatchDelete DELETE /objects/documents/roles/batch Remove Users and Groups from Roles on Multiple Documents & Binders
DefaultApi ObjectsDocumentsRolesBatchPost POST /objects/documents/roles/batch Assign Users & Groups to Roles on Multiple Documents & Binders
DefaultApi ObjectsDocumentsTemplatesGet GET /objects/documents/templates Retrieve Document Template Collection
DefaultApi ObjectsDocumentsTemplatesPost POST /objects/documents/templates Create Single Document Template
DefaultApi ObjectsDocumentsTemplatesPut PUT /objects/documents/templates Update Multiple Document Templates
DefaultApi ObjectsDocumentsTemplatesTemplateNameDelete DELETE /objects/documents/templates/{template_name} Delete Basic Document Template
DefaultApi ObjectsDocumentsTemplatesTemplateNameFileGet GET /objects/documents/templates/{template_name}/file Download Document Template File
DefaultApi ObjectsDocumentsTemplatesTemplateNameGet GET /objects/documents/templates/{template_name} Retrieve Document Template Attributes
DefaultApi ObjectsDocumentsTemplatesTemplateNamePut PUT /objects/documents/templates/{template_name} Update Single Document Template
DefaultApi ObjectsDocumentsTokensPost POST /objects/documents/tokens Document Tokens
DefaultApi ObjectsDocumentsVersionsBatchActionsFileextractPost POST /objects/documents/versions/batch/actions/fileextract Export Document Versions
DefaultApi ObjectsDocumentsVersionsBatchDelete DELETE /objects/documents/versions/batch Delete Multiple Document Versions
DefaultApi ObjectsDocumentsVersionsBatchPost POST /objects/documents/versions/batch Create Multiple Document Versions
DefaultApi ObjectsDomainGet GET /objects/domain Retrieve Domain Information
DefaultApi ObjectsDomainsGet GET /objects/domains Retrieve Domains
DefaultApi ObjectsEdlMatchedDocumentsBatchActionsAddPost POST /objects/edl_matched_documents/batch/actions/add Add EDL Matched Documents
DefaultApi ObjectsEdlMatchedDocumentsBatchActionsRemovePost POST /objects/edl_matched_documents/batch/actions/remove Remove EDL Matched Documents
DefaultApi ObjectsGroupsAutoGet GET /objects/groups/auto Retrieve Auto Managed Groups
DefaultApi ObjectsGroupsGet GET /objects/groups Retrieve All Groups
DefaultApi ObjectsGroupsGroupIdDelete DELETE /objects/groups/{group_id} Delete Group
DefaultApi ObjectsGroupsGroupIdGet GET /objects/groups/{group_id} Retrieve Group
DefaultApi ObjectsGroupsGroupIdPut PUT /objects/groups/{group_id} Update Group
DefaultApi ObjectsGroupsPost POST /objects/groups Create Group
DefaultApi ObjectsLicensesGet GET /objects/licenses Retrieve Application License Usage
DefaultApi ObjectsObjectworkflowsActionsGet GET /objects/objectworkflows/actions Retrieve All Multi-Record Workflows
DefaultApi ObjectsObjectworkflowsActionsWorkflowNameGet GET /objects/objectworkflows/actions/{workflow_name} Retrieve Multi-Record Workflow Details
DefaultApi ObjectsObjectworkflowsActionsWorkflowNamePost POST /objects/objectworkflows/actions/{workflow_name} Initiate Multi-Record Workflow
DefaultApi ObjectsObjectworkflowsGet GET /objects/objectworkflows Retrieve Workflows
DefaultApi ObjectsObjectworkflowsTasksGet GET /objects/objectworkflows/tasks Retrieve Workflow Tasks
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsAcceptPost POST /objects/objectworkflows/tasks/{task_id}/actions/accept Accept Single Record Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsCancelPost POST /objects/objectworkflows/tasks/{task_id}/actions/cancel Cancel Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsCompletePost POST /objects/objectworkflows/tasks/{task_id}/actions/complete Complete Single Record Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsGet GET /objects/objectworkflows/tasks/{task_id}/actions Retrieve Workflow Task Actions
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsMdwacceptPost POST /objects/objectworkflows/tasks/{task_id}/actions/mdwaccept Accept Multi-item Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsMdwcompletePost POST /objects/objectworkflows/tasks/{task_id}/actions/mdwcomplete Complete Multi-item Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsMdwmanagecontentPost POST /objects/objectworkflows/tasks/{task_id}/actions/mdwmanagecontent Manage Multi-Item Workflow Content
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsMdwreassignPost POST /objects/objectworkflows/tasks/{task_id}/actions/mdwreassign Reassign Multi-item Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsReassignPost POST /objects/objectworkflows/tasks/{task_id}/actions/reassign Reassign Single Record Workflow Task
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsTaskActionGet GET /objects/objectworkflows/tasks/{task_id}/actions/{task_action} Retrieve Workflow Task Action Details
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsUndoacceptPost POST /objects/objectworkflows/tasks/{task_id}/actions/undoaccept Undo Workflow Task Acceptance
DefaultApi ObjectsObjectworkflowsTasksTaskIdActionsUpdateduedatePost POST /objects/objectworkflows/tasks/{task_id}/actions/updateduedate Update Workflow Task Due Date
DefaultApi ObjectsObjectworkflowsTasksTaskIdGet GET /objects/objectworkflows/tasks/{task_id} Retrieve Workflow Task Details
DefaultApi ObjectsObjectworkflowsWorkflowIdActionsGet GET /objects/objectworkflows/{workflow_id}/actions Retrieve Workflow Actions
DefaultApi ObjectsObjectworkflowsWorkflowIdActionsWorkflowActionGet GET /objects/objectworkflows/{workflow_id}/actions/{workflow_action} Retrieve Workflow Action Details
DefaultApi ObjectsObjectworkflowsWorkflowIdActionsWorkflowActionPost POST /objects/objectworkflows/{workflow_id}/actions/{workflow_action} Initiate Workflow Action
DefaultApi ObjectsObjectworkflowsWorkflowIdGet GET /objects/objectworkflows/{workflow_id} Retrieve Workflow Details
DefaultApi ObjectsPicklistsGet GET /objects/picklists Retrieve All Picklists
DefaultApi ObjectsPicklistsPicklistNameGet GET /objects/picklists/{picklist_name} Retrieve Picklist Values
DefaultApi ObjectsPicklistsPicklistNamePicklistValueNameDelete DELETE /objects/picklists/{picklist_name}/{picklist_value_name} Inactivate Picklist Value
DefaultApi ObjectsPicklistsPicklistNamePicklistValueNamePut PUT /objects/picklists/{picklist_name}/{picklist_value_name} Update Picklist Value
DefaultApi ObjectsPicklistsPicklistNamePost POST /objects/picklists/{picklist_name} Create Picklist Values
DefaultApi ObjectsPicklistsPicklistNamePut PUT /objects/picklists/{picklist_name} Update Picklist Value Label
DefaultApi ObjectsSandboxActionsBuildproductionPost POST /objects/sandbox/actions/buildproduction Build Production Vault
DefaultApi ObjectsSandboxActionsPromoteproductionPost POST /objects/sandbox/actions/promoteproduction Promote to Production
DefaultApi ObjectsSandboxActionsRecheckusagePost POST /objects/sandbox/actions/recheckusage Recheck Sandbox Usage Limit
DefaultApi ObjectsSandboxBatchChangesizePost POST /objects/sandbox/batch/changesize Change Sandbox Size
DefaultApi ObjectsSandboxEntitlementsSetPost POST /objects/sandbox/entitlements/set Set Sandbox Entitlements
DefaultApi ObjectsSandboxGet GET /objects/sandbox Retrieve Sandboxes
DefaultApi ObjectsSandboxNameDelete DELETE /objects/sandbox/{name} Delete Sandbox
DefaultApi ObjectsSandboxPost POST /objects/sandbox Create or Refresh Sandbox
DefaultApi ObjectsSandboxSnapshotApiNameActionsUpdatePost POST /objects/sandbox/snapshot/{api_name}/actions/update Update Sandbox Snapshot
DefaultApi ObjectsSandboxSnapshotApiNameActionsUpgradePost POST /objects/sandbox/snapshot/{api_name}/actions/upgrade Upgrade Sandbox Snapshot
DefaultApi ObjectsSandboxSnapshotApiNameDelete DELETE /objects/sandbox/snapshot/{api_name} Delete Sandbox Snapshot
DefaultApi ObjectsSandboxSnapshotGet GET /objects/sandbox/snapshot Retrieve Sandbox Snapshots
DefaultApi ObjectsSandboxSnapshotPost POST /objects/sandbox/snapshot Create Sandbox Snapshot
DefaultApi ObjectsSandboxVaultIdActionsRefreshPost POST /objects/sandbox/{vault_id}/actions/refresh Refresh Sandbox from Snapshot
DefaultApi ObjectsSandboxVaultIdGet GET /objects/sandbox/{vault_id} Retrieve Sandbox Details by ID
DefaultApi ObjectsSecuritypoliciesGet GET /objects/securitypolicies Retrieve All Security Policies
DefaultApi ObjectsSecuritypoliciesSecurityPolicyNameGet GET /objects/securitypolicies/{security_policy_name} Retrieve Security Policy
DefaultApi ObjectsUsersGet GET /objects/users/ Retrieve All Users
DefaultApi ObjectsUsersIdGet GET /objects/users/{id} Retrieve User
DefaultApi ObjectsUsersIdPermissionsGet GET /objects/users/{id}/permissions Retrieve User Permissions
DefaultApi ObjectsUsersIdPut PUT /objects/users/{id} Update Single User
DefaultApi ObjectsUsersMeGet GET /objects/users/me Validate Session User
DefaultApi ObjectsUsersMePasswordPost POST /objects/users/me/password Change My Password
DefaultApi ObjectsUsersMePermissionsGet GET /objects/users/me/permissions Retrieve My User Permissions
DefaultApi ObjectsUsersMePut PUT /objects/users/me Update My User
DefaultApi ObjectsUsersPost POST /objects/users Create Single User
DefaultApi ObjectsUsersPut PUT /objects/users Update Multiple Users
DefaultApi ObjectsUsersUserIdDelete DELETE /objects/users/{user_id} Disable User
DefaultApi ObjectsUsersUserIdVaultMembershipVaultIdPut PUT /objects/users/{user_id}/vault_membership/{vault_id} Update Vault Membership
DefaultApi ObjectsVaultActionsComparePost POST /objects/vault/actions/compare Vault Compare
DefaultApi ObjectsVaultActionsConfigreportPost POST /objects/vault/actions/configreport Vault Configuration Report
DefaultApi QueryComponentsPost POST /query/components Component Definition Query
DefaultApi QueryNextPagePost POST /query/{next_page} Next Page URL
DefaultApi QueryPost POST /query Submitting a Query
DefaultApi QueryPreviousPagePost POST /query/{previous_page} Previous Page URL
DefaultApi ScimV2MeGet GET /scim/v2/Me Retrieve Current User with SCIM
DefaultApi ScimV2MePut PUT /scim/v2/Me Update Current User with SCIM
DefaultApi ScimV2ResourceTypesGet GET /scim/v2/ResourceTypes Retrieve All SCIM Resource Types
DefaultApi ScimV2ResourceTypesTypeGet GET /scim/v2/ResourceTypes/{type} Retrieve Single SCIM Resource Type
DefaultApi ScimV2SchemasGet GET /scim/v2/Schemas Retrieve All SCIM Schema Information
DefaultApi ScimV2SchemasIdGet GET /scim/v2/Schemas/{id} Retrieve Single SCIM Schema Information
DefaultApi ScimV2ServiceProviderConfigGet GET /scim/v2/ServiceProviderConfig Retrieve SCIM Provider
DefaultApi ScimV2TypeGet GET /scim/v2/{type} Retrieve SCIM Resources
DefaultApi ScimV2TypeIdGet GET /scim/v2/{type}/{id} Retrieve Single SCIM Resource
DefaultApi ScimV2UsersGet GET /scim/v2/Users Retrieve All Users with SCIM
DefaultApi ScimV2UsersIdGet GET /scim/v2/Users/{id} Retrieve Single User with SCIM
DefaultApi ScimV2UsersIdPut PUT /scim/v2/Users/{id} Update User with SCIM
DefaultApi ScimV2UsersPost POST /scim/v2/Users Create User with SCIM
DefaultApi ServicesCertificateCertIdGet GET /services/certificate/{cert_id} Retrieve Signing Certificate
DefaultApi ServicesConfigurationModeActionsDisablePost POST /services/configuration_mode/actions/disable Disable Configuration Mode
DefaultApi ServicesConfigurationModeActionsEnablePost POST /services/configuration_mode/actions/enable Enable Configuration Mode
DefaultApi ServicesDirectdataFilesGet GET /services/directdata/files Retrieve Available Direct Data Files
DefaultApi ServicesDirectdataFilesNameGet GET /services/directdata/files/{name} Download Direct Data File
DefaultApi ServicesFileStagingItemsContentItemGet GET /services/file_staging/items/content/{item} Download Item Content
DefaultApi ServicesFileStagingItemsItemDelete DELETE /services/file_staging/items/{item} Delete File or Folder
DefaultApi ServicesFileStagingItemsItemGet GET /services/file_staging/items/{item} List Items at a Path
DefaultApi ServicesFileStagingItemsItemPut PUT /services/file_staging/items/{item} Update Folder or File
DefaultApi ServicesFileStagingItemsPost POST /services/file_staging/items Create Folder or File
DefaultApi ServicesFileStagingUploadGet GET /services/file_staging/upload/ List Upload Sessions
DefaultApi ServicesFileStagingUploadPost POST /services/file_staging/upload Create Resumable Upload Session
DefaultApi ServicesFileStagingUploadUploadSessionIdDelete DELETE /services/file_staging/upload/{upload_session_id} Abort Upload Session
DefaultApi ServicesFileStagingUploadUploadSessionIdGet GET /services/file_staging/upload/{upload_session_id} Get Upload Session Details
DefaultApi ServicesFileStagingUploadUploadSessionIdPartsGet GET /services/file_staging/upload/{upload_session_id}/parts List File Parts Uploaded to Session
DefaultApi ServicesFileStagingUploadUploadSessionIdPost POST /services/file_staging/upload/{upload_session_id} Commit Upload Session
DefaultApi ServicesFileStagingUploadUploadSessionIdPut PUT /services/file_staging/upload/{upload_session_id} Upload to a Session
DefaultApi ServicesJobsHistoriesGet GET /services/jobs/histories Retrieve Job Histories
DefaultApi ServicesJobsJobIdErrorsGet GET /services/jobs/{job_id}/errors Retrieve Import Bulk Translation File Job Errors
DefaultApi ServicesJobsJobIdGet GET /services/jobs/{job_id} Retrieve Job Status
DefaultApi ServicesJobsJobIdSummaryGet GET /services/jobs/{job_id}/summary Retrieve Import Bulk Translation File Job Summary
DefaultApi ServicesJobsJobIdTasksGet GET /services/jobs/{job_id}/tasks Retrieve SDK Job Tasks
DefaultApi ServicesJobsMonitorsGet GET /services/jobs/monitors Retrieve Job Monitors
DefaultApi ServicesJobsStartNowJobIdPost POST /services/jobs/start_now/{job_id} Start Job
DefaultApi ServicesLoaderExtractPost POST /services/loader/extract Extract Data Files
DefaultApi ServicesLoaderJobIdTasksTaskIdFailurelogGet GET /services/loader/{job_id}/tasks/{task_id}/failurelog Retrieve Load Failure Log Results
DefaultApi ServicesLoaderJobIdTasksTaskIdResultsGet GET /services/loader/{job_id}/tasks/{task_id}/results Retrieve Loader Extract Results
DefaultApi ServicesLoaderJobIdTasksTaskIdResultsRenditionsGet GET /services/loader/{job_id}/tasks/{task_id}/results/renditions Retrieve Loader Extract Renditions Results
DefaultApi ServicesLoaderJobIdTasksTaskIdSuccesslogGet GET /services/loader/{job_id}/tasks/{task_id}/successlog Retrieve Load Success Log Results
DefaultApi ServicesLoaderLoadPost POST /services/loader/load Load Data Objects
DefaultApi ServicesPackageActionsValidatePost POST /services/package/actions/validate Validate Package
DefaultApi ServicesPackagePost POST /services/package Export Package
DefaultApi ServicesPackagePut PUT /services/package Import Package
DefaultApi ServicesQueuesGet GET /services/queues Retrieve All Queues
DefaultApi ServicesQueuesQueueNameActionsDisableDeliveryPut PUT /services/queues/{queue_name}/actions/disable_delivery Disable Delivery
DefaultApi ServicesQueuesQueueNameActionsEnableDeliveryPut PUT /services/queues/{queue_name}/actions/enable_delivery Enable Delivery
DefaultApi ServicesQueuesQueueNameActionsResetPut PUT /services/queues/{queue_name}/actions/reset Reset Queue
DefaultApi ServicesQueuesQueueNameGet GET /services/queues/{queue_name} Retrieve Queue Status
DefaultApi ServicesVobjectVaultPackageVPackageIdActionsValidatePost POST /services/vobject/vault_package__v/{package_id}/actions/validate Validate Imported Package
DefaultApi SessionDelete DELETE /session End Session
DefaultApi UicodeDistributionsDistributionNameCodeGet GET /uicode/distributions/{distribution_name}/code Download Single Client Code Distribution
DefaultApi UicodeDistributionsDistributionNameDelete DELETE /uicode/distributions/{distribution_name} Delete Single Client Code Distribution
DefaultApi UicodeDistributionsDistributionNameGet GET /uicode/distributions/{distribution_name} Retrieve Single Client Code Distribution Metadata
DefaultApi UicodeDistributionsGet GET /uicode/distributions Retrieve All Client Code Distribution Metadata
DefaultApi UicodeDistributionsPost POST /uicode/distributions Add or Replace Single Client Code Distribution
DefaultApi VobjectVaultPackageVPackageIdActionsDeployPost POST /vobject/vault_package__v/{package_id}/actions/deploy Deploy Package
DefaultApi VobjectVaultPackageVPackageIdActionsDeployResultsGet GET /vobject/vault_package__v/{package_id}/actions/deploy/results Retrieve Package Deploy Results
DefaultApi VobjectsCascadedeleteResultsObjectNameJobStatusJobIdGet GET /vobjects/cascadedelete/results/{object_name}/{job_status}/{job_id} Retrieve Results of Cascade Delete Job
DefaultApi VobjectsDeepcopyResultsObjectNameJobStatusJobIdGet GET /vobjects/deepcopy/results/{object_name}/{job_status}/{job_id} Retrieve Results of Deep Copy Job
DefaultApi VobjectsEdlItemVActionsCreateplaceholderPost POST /vobjects/edl_item__v/actions/createplaceholder Create a Placeholder from an EDL Item
DefaultApi VobjectsMergesJobIdLogGet GET /vobjects/merges/{job_id}/log Download Merge Records Job Log
DefaultApi VobjectsMergesJobIdResultsGet GET /vobjects/merges/{job_id}/results Retrieve Record Merge Results
DefaultApi VobjectsMergesJobIdStatusGet GET /vobjects/merges/{job_id}/status Retrieve Record Merge Status
DefaultApi VobjectsObjectNameActionsActionNamePost POST /vobjects/{object_name}/actions/{action_name} Initiate Object Action on Multiple Records
DefaultApi VobjectsObjectNameActionsChangetypePost POST /vobjects/{object_name}/actions/changetype Change Object Type
DefaultApi VobjectsObjectNameActionsMergePost POST /vobjects/{object_name}/actions/merge Initiate Record Merge
DefaultApi VobjectsObjectNameActionsRecalculaterollupsGet GET /vobjects/{object_name}/actions/recalculaterollups Retrieve Roll-up Field Recalculation Status
DefaultApi VobjectsObjectNameActionsRecalculaterollupsPost POST /vobjects/{object_name}/actions/recalculaterollups Recalculate Roll-up Fields
DefaultApi VobjectsObjectNameActionsUpdatecorporatecurrencyPut PUT /vobjects/{object_name}/actions/updatecorporatecurrency Update Corporate Currency Fields
DefaultApi VobjectsObjectNameAttachmentsBatchDelete DELETE /vobjects/{object_name}/attachments/batch Delete Multiple Object Record Attachments
DefaultApi VobjectsObjectNameAttachmentsBatchPost POST /vobjects/{object_name}/attachments/batch Create Multiple Object Record Attachments
DefaultApi VobjectsObjectNameAttachmentsBatchPut PUT /vobjects/{object_name}/attachments/batch Update Multiple Object Record Attachment Descriptions
DefaultApi VobjectsObjectNameDelete DELETE /vobjects/{object_name} Delete Object Records
DefaultApi VobjectsObjectNameIdRolesRoleNameGet GET /vobjects/{object_name}/{id}/roles/{role_name} Retrieve Object Record Roles
DefaultApi VobjectsObjectNameObjectRecordIdActionsActionNameGet GET /vobjects/{object_name}/{object_record_id}/actions/{action_name} Retrieve Object User Actions Details
DefaultApi VobjectsObjectNameObjectRecordIdActionsActionNamePost POST /vobjects/{object_name}/{object_record_id}/actions/{action_name} Initiate Object Action on a Single Record
DefaultApi VobjectsObjectNameObjectRecordIdActionsCascadedeletePost POST /vobjects/{object_name}/{object_record_id}/actions/cascadedelete Cascade Delete Object Record
DefaultApi VobjectsObjectNameObjectRecordIdActionsDeepcopyPost POST /vobjects/{object_name}/{object_record_id}/actions/deepcopy Deep Copy Object Record
DefaultApi VobjectsObjectNameObjectRecordIdActionsGet GET /vobjects/{object_name}/{object_record_id}/actions Retrieve Object Record User Actions
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentFieldsAttachmentFieldNameFileGet GET /vobjects/{object_name}/{object_record_id}/attachment_fields/{attachment_field_name}/file Download Attachment Field File
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentFieldsAttachmentFieldNameFilePost POST /vobjects/{object_name}/{object_record_id}/attachment_fields/{attachment_field_name}/file Update Attachment Field File
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentFieldsFileGet GET /vobjects/{object_name}/{object_record_id}/attachment_fields/file Download All Attachment Field Files
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdDelete DELETE /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Delete Object Record Attachment
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdGet GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Retrieve Object Record Attachment Metadata
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdPut PUT /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Update Object Record Attachment Description
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdVersionsAttachmentVersionDelete DELETE /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Delete Object Record Attachment Version
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdVersionsAttachmentVersionFileGet GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}/file Download Object Record Attachment File
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdVersionsAttachmentVersionGet GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Object Record Attachment Version Metadata
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdVersionsAttachmentVersionPost POST /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Restore Object Record Attachment Version
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsAttachmentIdVersionsGet GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions Retrieve Object Record Attachment Versions
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsFileGet GET /vobjects/{object_name}/{object_record_id}/attachments/file Download All Object Record Attachment Files
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsGet GET /vobjects/{object_name}/{object_record_id}/attachments Retrieve Object Record Attachments
DefaultApi VobjectsObjectNameObjectRecordIdAttachmentsPost POST /vobjects/{object_name}/{object_record_id}/attachments Create Object Record Attachment
DefaultApi VobjectsObjectNameObjectRecordIdAudittrailGet GET /vobjects/{object_name}/{object_record_id}/audittrail Retrieve Complete Audit History for a Single Object Record
DefaultApi VobjectsObjectNameObjectRecordIdGet GET /vobjects/{object_name}/{object_record_id} Retrieve Object Record
DefaultApi VobjectsObjectNamePost POST /vobjects/{object_name} Create & Upsert Object Records
DefaultApi VobjectsObjectNamePut PUT /vobjects/{object_name} Update Object Records
DefaultApi VobjectsObjectNameRolesDelete DELETE /vobjects/{object_name}/roles Remove Users & Groups from Roles on Object Records
DefaultApi VobjectsObjectNameRolesPost POST /vobjects/{object_name}/roles Assign Users & Groups to Roles on Object Records
DefaultApi VobjectsOutboundPackageVPackageIdDependenciesGet GET /vobjects/outbound_package__v/{package_id}/dependencies Retrieve Outbound Package Dependencies

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

About

Veeva Vault R Client.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors