Skip to content

Bright-Research/veeva-vault-python-pydanticV1-sdk

Repository files navigation

openapi-client

The latest GA version of the Vault REST API.

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

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

Requirements.

Python 3.7+

Installation & Usage

pip install

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

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

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

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

# Defining the host is optional and defaults to http://}/api/v25.1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://}/api/v25.1"
)



# 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.DefaultApi(api_client)
    authorization = '{{sessionId}}' # str |  (optional)
    accept = 'application/json' # str |  (optional)
    x_vault_api_client_id = '{{clientId}}' # str | Include a Client ID to identify this request. This ID appears in the API Usage Logs, which is avaiable to download from Admin > Logs > API Usage Logs or through the Vault REST API with the Download Daily API Usage request. If omitted, the value will appear as `unknown` in the API Usage Log. (optional)

    try:
        # Retrieve API Versions
        api_instance.api_get(authorization=authorization, accept=accept, x_vault_api_client_id=x_vault_api_client_id)
    except ApiException as e:
        print("Exception when calling DefaultApi->api_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
DefaultApi api_get GET /api/ Retrieve API Versions
DefaultApi api_mdl_components_component_type_and_record_name_files_get GET /api/mdl/components/{component_type_and_record_name}/files Retrieve Content File
DefaultApi api_mdl_components_component_type_and_record_name_get GET /api/mdl/components/{component_type_and_record_name} Retrieve Component Record (MDL)
DefaultApi api_mdl_execute_async_job_id_results_get GET /api/mdl/execute_async/{job_id}/results Retrieve Asynchronous MDL Script Results
DefaultApi api_mdl_execute_async_post POST /api/mdl/execute_async Execute MDL Script Asynchronously
DefaultApi api_mdl_execute_post POST /api/mdl/execute Execute MDL Script
DefaultApi api_mdl_files_post POST /api/mdl/files Upload Content File
DefaultApi audittrail_audit_trail_type_get GET /audittrail/{audit_trail_type} Retrieve Audit Details
DefaultApi auth_discovery_post POST /auth/discovery Authentication Type Discovery
DefaultApi auth_oauth_session_oath_oidc_profile_id_post POST /auth/oauth/session/{oath_oidc_profile_id} OAuth 2.0 / OpenID Connect
DefaultApi auth_post POST /auth User Name and Password
DefaultApi code_class_name_delete DELETE /code/{class_name} Delete Single Source Code File
DefaultApi code_class_name_disable_put PUT /code/{class_name}/disable Disable Vault Extension
DefaultApi code_class_name_enable_put PUT /code/{class_name}/enable Enable Vault Extension
DefaultApi code_class_name_get GET /code/{class_name} Retrieve Single Source Code File
DefaultApi code_profiler_get GET /code/profiler Retrieve All Profiling Sessions
DefaultApi code_profiler_post POST /code/profiler Create Profiling Session
DefaultApi code_profiler_session_name_actions_end_post POST /code/profiler/{session_name}/actions/end End Profiling Session
DefaultApi code_profiler_session_name_delete DELETE /code/profiler/{session_name} Delete Profiling Session
DefaultApi code_profiler_session_name_get GET /code/profiler/{session_name} Retrieve Profiling Session
DefaultApi code_profiler_session_name_results_get GET /code/profiler/{session_name}/results Download Profiling Session Results
DefaultApi code_put PUT /code Add or Replace Single Source Code File
DefaultApi composites_trees_edl_hierarchy_or_template_actions_listnodes_post POST /composites/trees/{edl_hierarchy_or_template}/actions/listnodes Retrieve Specific Root Nodes
DefaultApi composites_trees_edl_hierarchy_or_template_get GET /composites/trees/{edl_hierarchy_or_template} Retrieve All Root Nodes
DefaultApi composites_trees_edl_hierarchy_v_parent_node_id_children_get GET /composites/trees/edl_hierarchy__v/{parent_node_id}/children Retrieve a Node's Children
DefaultApi composites_trees_edl_hierarchy_v_parent_node_id_children_put PUT /composites/trees/edl_hierarchy__v/{parent_node_id}/children Update Node Order
DefaultApi configuration_component_type_and_record_name_get GET /configuration/{component_type_and_record_name} Retrieve Component Record (XML/JSON)
DefaultApi configuration_component_type_get GET /configuration/{component_type} Retrieve Component Record Collection
DefaultApi configuration_object_name_and_object_type_get GET /configuration/{object_name_and_object_type} Retrieve Details from a Specific Object
DefaultApi configuration_objecttype_get GET /configuration/Objecttype Retrieve Details from All Object Types
DefaultApi configuration_role_assignment_rule_delete DELETE /configuration/role_assignment_rule Delete Lifecycle Role Assignment Override Rules
DefaultApi configuration_role_assignment_rule_get GET /configuration/role_assignment_rule Retrieve Lifecycle Role Assignment Rules (Default & Override)
DefaultApi configuration_role_assignment_rule_post POST /configuration/role_assignment_rule Create Lifecycle Role Assignment Override Rules
DefaultApi configuration_role_assignment_rule_put PUT /configuration/role_assignment_rule Update Lifecycle Role Assignment Rules (Default & Override)
DefaultApi delegation_login_post POST /delegation/login Initiate Delegated Session
DefaultApi delegation_vaults_get GET /delegation/vaults Retrieve Delegations
DefaultApi keep_alive_post POST /keep-alive Session Keep Alive
DefaultApi limits_get GET /limits Retrieve Limits on Objects
DefaultApi logs_api_usage_get GET /logs/api_usage Download Daily API Usage
DefaultApi logs_code_debug_get GET /logs/code/debug Retrieve All Debug Logs
DefaultApi logs_code_debug_id_actions_reset_delete DELETE /logs/code/debug/{id}/actions/reset Delete Debug Log
DefaultApi logs_code_debug_id_actions_reset_post POST /logs/code/debug/{id}/actions/reset Reset Debug Log
DefaultApi logs_code_debug_id_files_get GET /logs/code/debug/{id}/files Download Debug Log Files
DefaultApi logs_code_debug_id_get GET /logs/code/debug/{id} Retrieve Single Debug Log
DefaultApi logs_code_debug_post POST /logs/code/debug Create Debug Log
DefaultApi logs_code_runtime_get GET /logs/code/runtime Download SDK Runtime Log
DefaultApi messages_message_type_actions_import_post POST /messages/{message_type}/actions/import Import Bulk Translation File
DefaultApi messages_message_type_language_lang_actions_export_post POST /messages/{message_type}/language/{lang}/actions/export Export Bulk Translation File
DefaultApi metadata_audittrail_audit_trail_type_get GET /metadata/audittrail/{audit_trail_type} Retrieve Audit Metadata
DefaultApi metadata_audittrail_get GET /metadata/audittrail Retrieve Audit Types
DefaultApi metadata_components_component_type_get GET /metadata/components/{component_type} Retrieve Component Type Metadata
DefaultApi metadata_components_get GET /metadata/components Retrieve All Component Metadata
DefaultApi metadata_objects_binders_templates_bindernodes_get GET /metadata/objects/binders/templates/bindernodes Retrieve Binder Template Node Metadata
DefaultApi metadata_objects_binders_templates_get GET /metadata/objects/binders/templates Retrieve Binder Template Metadata
DefaultApi metadata_objects_documents_annotations_placemarks_types_placemark_type_get GET /metadata/objects/documents/annotations/placemarks/types/{placemark_type} Retrieve Annotation Placemark Type Metadata
DefaultApi metadata_objects_documents_annotations_references_types_reference_type_get GET /metadata/objects/documents/annotations/references/types/{reference_type} Retrieve Annotation Reference Type Metadata
DefaultApi metadata_objects_documents_annotations_types_annotation_type_get GET /metadata/objects/documents/annotations/types/{annotation_type} Retrieve Annotation Type Metadata
DefaultApi metadata_objects_documents_events_event_type_types_event_subtype_get GET /metadata/objects/documents/events/{event_type}/types/{event_subtype} Retrieve Document Event SubType Metadata
DefaultApi metadata_objects_documents_events_get GET /metadata/objects/documents/events Retrieve Document Event Types and Subtypes
DefaultApi metadata_objects_documents_lock_get GET /metadata/objects/documents/lock Retrieve Document Lock Metadata
DefaultApi metadata_objects_documents_properties_find_common_post POST /metadata/objects/documents/properties/find_common Retrieve Common Document Fields
DefaultApi metadata_objects_documents_properties_get GET /metadata/objects/documents/properties Retrieve All Document Fields
DefaultApi metadata_objects_documents_templates_get GET /metadata/objects/documents/templates Retrieve Document Template Metadata
DefaultApi metadata_objects_documents_types_get GET /metadata/objects/documents/types Retrieve All Document Types
DefaultApi metadata_objects_documents_types_type_get GET /metadata/objects/documents/types/{type} Retrieve Document Type
DefaultApi metadata_objects_documents_types_type_relationships_get GET /metadata/objects/documents/types/{type}/relationships Retrieve Document Type Relationships
DefaultApi metadata_objects_documents_types_type_subtypes_subtype_classifications_classification_get GET /metadata/objects/documents/types/{type}/subtypes/{subtype}/classifications/{classification} Retrieve Document Classification
DefaultApi metadata_objects_documents_types_type_subtypes_subtype_get GET /metadata/objects/documents/types/{type}/subtypes/{subtype} Retrieve Document Subtype
DefaultApi metadata_objects_groups_get GET /metadata/objects/groups Retrieve Group Metadata
DefaultApi metadata_objects_securitypolicies_get GET /metadata/objects/securitypolicies Retrieve Security Policy Metadata
DefaultApi metadata_objects_users_get GET /metadata/objects/users Retrieve User Metadata
DefaultApi metadata_query_archived_documents_relationships_document_signature_sysr_get GET /metadata/query/archived_documents/relationships/document_signature__sysr Retrieve Archived Document Signature Metadata
DefaultApi metadata_query_documents_relationships_document_signature_sysr_get GET /metadata/query/documents/relationships/document_signature__sysr Retrieve Document Signature Metadata
DefaultApi metadata_vobjects_get GET /metadata/vobjects Retrieve Object Collection
DefaultApi metadata_vobjects_object_name_actions_canceldeployment_post POST /metadata/vobjects/{object_name}/actions/canceldeployment Cancel Raw Object Deployment
DefaultApi metadata_vobjects_object_name_fields_object_field_name_get GET /metadata/vobjects/{object_name}/fields/{object_field_name} Retrieve Object Field Metadata
DefaultApi metadata_vobjects_object_name_get GET /metadata/vobjects/{object_name} Retrieve Object Metadata
DefaultApi metadata_vobjects_object_name_page_layouts_get GET /metadata/vobjects/{object_name}/page_layouts Retrieve Page Layouts
DefaultApi metadata_vobjects_object_name_page_layouts_layout_name_get GET /metadata/vobjects/{object_name}/page_layouts/{layout_name} Retrieve Page Layout Metadata
DefaultApi notifications_histories_get GET /notifications/histories Retrieve Email Notification Histories
DefaultApi object_workflow_actions_action_get GET /object/workflow/actions/{action} Retrieve Bulk Workflow Action Details
DefaultApi object_workflow_actions_action_post POST /object/workflow/actions/{action} Initiate Workflow Actions on Multiple Workflows
DefaultApi object_workflow_actions_canceltasks_post POST /object/workflow/actions/canceltasks Cancel Workflow Tasks
DefaultApi object_workflow_actions_cancelworkflows_post POST /object/workflow/actions/cancelworkflows Cancel Workflows
DefaultApi object_workflow_actions_get GET /object/workflow/actions Retrieve Bulk Workflow Actions
DefaultApi object_workflow_actions_reassigntasks_post POST /object/workflow/actions/reassigntasks Reassign Workflow Tasks
DefaultApi object_workflow_actions_replaceworkflowowner_post POST /object/workflow/actions/replaceworkflowowner Replace Workflow Owner
DefaultApi objects_binders_actions_export_job_id_results_get GET /objects/binders/actions/export/{job_id}/results Retrieve Binder Export Results
DefaultApi objects_binders_binder_id_actions_export_post POST /objects/binders/{binder_id}/actions/export Export Binder (Latest Version)
DefaultApi objects_binders_binder_id_actions_post POST /objects/binders/{binder_id}/actions Refresh Binder Auto-Filing
DefaultApi objects_binders_binder_id_binding_rule_put PUT /objects/binders/{binder_id}/binding_rule Update Binding Rule
DefaultApi objects_binders_binder_id_delete DELETE /objects/binders/{binder_id} Delete Binder
DefaultApi objects_binders_binder_id_documents_node_id_binding_rule_put PUT /objects/binders/{binder_id}/documents/{node_id}/binding_rule Update Binder Document Binding Rule
DefaultApi objects_binders_binder_id_documents_post POST /objects/binders/{binder_id}/documents Add Document to Binder
DefaultApi objects_binders_binder_id_documents_section_id_delete DELETE /objects/binders/{binder_id}/documents/{section_id} Remove Document from Binder
DefaultApi objects_binders_binder_id_documents_section_id_put PUT /objects/binders/{binder_id}/documents/{section_id} Move Document in Binder
DefaultApi objects_binders_binder_id_get GET /objects/binders/{binder_id} Retrieve Binder
DefaultApi objects_binders_binder_id_post POST /objects/binders/{binder_id} Create Binder Version
DefaultApi objects_binders_binder_id_put PUT /objects/binders/{binder_id} Update Binder
DefaultApi objects_binders_binder_id_roles_role_name_and_user_or_group_id_delete DELETE /objects/binders/{binder_id}/roles/{role_name_and_user_or_group}/{id} Remove Users & Groups from Roles on a Single Binder
DefaultApi objects_binders_binder_id_sections_node_id_binding_rule_put PUT /objects/binders/{binder_id}/sections/{node_id}/binding_rule Update Binder Section Binding Rule
DefaultApi objects_binders_binder_id_sections_node_id_put PUT /objects/binders/{binder_id}/sections/{node_id} Update Binder Section
DefaultApi objects_binders_binder_id_sections_post POST /objects/binders/{binder_id}/sections Create Binder Section
DefaultApi objects_binders_binder_id_sections_section_id_delete DELETE /objects/binders/{binder_id}/sections/{section_id} Delete Binder Section
DefaultApi objects_binders_binder_id_sections_section_id_get GET /objects/binders/{binder_id}/sections/{section_id} Retrieve Binder Sections
DefaultApi objects_binders_binder_id_versions_get GET /objects/binders/{binder_id}/versions Retrieve All Binder Versions
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_actions_export_post POST /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/actions/export Export Binder (Specific Version)
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_delete DELETE /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Delete Binder Version
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_get GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Retrieve Binder Version
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_put PUT /objects/binders/{binder_id}/versions/{major_version}/{minor_version} Update Binder Version
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_relationships_post POST /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships Create Binder Relationship
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_relationships_relationship_id_delete DELETE /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Delete Binder Relationship
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_relationships_relationship_id_get GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Retrieve Binder Relationship
DefaultApi objects_binders_binder_id_versions_major_version_minor_version_sections_section_id_get GET /objects/binders/{binder_id}/versions/{major_version}/{minor_version}/sections/{section_id} Retrieve Binder Version Section
DefaultApi objects_binders_id_roles_get GET /objects/binders/{id}/roles Retrieve All Binder Roles
DefaultApi objects_binders_id_roles_post POST /objects/binders/{id}/roles Assign Users & Groups to Roles on a Single Binder
DefaultApi objects_binders_id_roles_role_name_get GET /objects/binders/{id}/roles/{role_name} Retrieve Document Role
DefaultApi objects_binders_id_versions_major_version_minor_version_lifecycle_actions_get GET /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions Retrieve Binder User Actions
DefaultApi objects_binders_id_versions_major_version_minor_version_lifecycle_actions_name_v_entry_requirements_get GET /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements Retrieve Binder Entry Criteria
DefaultApi objects_binders_id_versions_major_version_minor_version_lifecycle_actions_name_v_put PUT /objects/binders/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v} Initiate Binder User Action
DefaultApi objects_binders_lifecycle_actions_post POST /objects/binders/lifecycle_actions Retrieve User Actions on Multiple Binders
DefaultApi objects_binders_lifecycle_actions_user_action_name_put PUT /objects/binders/lifecycle_actions/{user_action_name} Initiate Bulk Binder User Actions
DefaultApi objects_binders_post POST /objects/binders Create Binder
DefaultApi objects_binders_templates_get GET /objects/binders/templates Retrieve Binder Template Collection
DefaultApi objects_binders_templates_post POST /objects/binders/templates Create Binder Template
DefaultApi objects_binders_templates_put PUT /objects/binders/templates Update Binder Template
DefaultApi objects_binders_templates_template_name_bindernodes_get GET /objects/binders/templates/{template_name}/bindernodes Retrieve Binder Template Node Attributes
DefaultApi objects_binders_templates_template_name_bindernodes_post POST /objects/binders/templates/{template_name}/bindernodes Create Binder Template Node
DefaultApi objects_binders_templates_template_name_bindernodes_put PUT /objects/binders/templates/{template_name}/bindernodes Replace Binder Template Nodes
DefaultApi objects_binders_templates_template_name_delete DELETE /objects/binders/templates/{template_name} Delete Binder Template
DefaultApi objects_binders_templates_template_name_get GET /objects/binders/templates/{template_name} Retrieve Binder Template Attributes
DefaultApi objects_deletions_documents_get GET /objects/deletions/documents Retrieve Deleted Document IDs
DefaultApi objects_deletions_vobjects_object_name_get GET /objects/deletions/vobjects/{object_name} Retrieve Deleted Object Record ID
DefaultApi objects_documents_actions_get GET /objects/documents/actions Retrieve All Document Workflows
DefaultApi objects_documents_actions_lifecycle_and_state_and_action_job_id_results_get GET /objects/documents/actions/{lifecycle_and_state_and_action}/{job_id}/results Download Controlled Copy Job Results
DefaultApi objects_documents_actions_workflow_name_get GET /objects/documents/actions/{workflow_name} Retrieve Document Workflow Details
DefaultApi objects_documents_actions_workflow_name_post POST /objects/documents/actions/{workflow_name} Initiate Document Workflow
DefaultApi objects_documents_annotations_batch_delete DELETE /objects/documents/annotations/batch Delete Annotations
DefaultApi objects_documents_annotations_batch_post POST /objects/documents/annotations/batch Create Multiple Annotations
DefaultApi objects_documents_annotations_batch_put PUT /objects/documents/annotations/batch Update Annotations
DefaultApi objects_documents_annotations_replies_batch_post POST /objects/documents/annotations/replies/batch Add Annotation Replies
DefaultApi objects_documents_attachments_batch_delete DELETE /objects/documents/attachments/batch Delete Multiple Document Attachments
DefaultApi objects_documents_attachments_batch_post POST /objects/documents/attachments/batch Create Multiple Document Attachments
DefaultApi objects_documents_attachments_batch_put PUT /objects/documents/attachments/batch Update Multiple Document Attachment Descriptions
DefaultApi objects_documents_batch_actions_fileextract_job_id_results_get GET /objects/documents/batch/actions/fileextract/{job_id}/results Retrieve Document Export Results
DefaultApi objects_documents_batch_actions_fileextract_post POST /objects/documents/batch/actions/fileextract Export Documents
DefaultApi objects_documents_batch_actions_reclassify_put PUT /objects/documents/batch/actions/reclassify Reclassify Multiple Documents
DefaultApi objects_documents_batch_actions_rerender_post POST /objects/documents/batch/actions/rerender Update Multiple Document Renditions
DefaultApi objects_documents_batch_delete DELETE /objects/documents/batch Delete Multiple Documents
DefaultApi objects_documents_batch_lock_delete DELETE /objects/documents/batch/lock Undo Collaborative Authoring Checkout
DefaultApi objects_documents_batch_post POST /objects/documents/batch Create Multiple Documents
DefaultApi objects_documents_batch_put PUT /objects/documents/batch Update Multiple Documents
DefaultApi objects_documents_doc_id_anchors_get GET /objects/documents/{doc_id}/anchors Retrieve Anchor IDs
DefaultApi objects_documents_doc_id_annotations_file_get GET /objects/documents/{doc_id}/annotations/file Export Document Annotations to PDF
DefaultApi objects_documents_doc_id_annotations_file_post POST /objects/documents/{doc_id}/annotations/file Import Document Annotations from PDF
DefaultApi objects_documents_doc_id_attachments_attachment_id_delete DELETE /objects/documents/{doc_id}/attachments/{attachment_id} Delete Single Document Attachment
DefaultApi objects_documents_doc_id_attachments_attachment_id_file_get GET /objects/documents/{doc_id}/attachments/{attachment_id}/file Download Document Attachment
DefaultApi objects_documents_doc_id_attachments_attachment_id_get GET /objects/documents/{doc_id}/attachments/{attachment_id} Retrieve Document Attachment Metadata
DefaultApi objects_documents_doc_id_attachments_attachment_id_put PUT /objects/documents/{doc_id}/attachments/{attachment_id} Update Document Attachment Description
DefaultApi objects_documents_doc_id_attachments_attachment_id_versions_attachment_version_delete DELETE /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Delete Single Document Attachment Version
DefaultApi objects_documents_doc_id_attachments_attachment_id_versions_attachment_version_file_get GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}/file Download Document Attachment Version
DefaultApi objects_documents_doc_id_attachments_attachment_id_versions_attachment_version_get GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Document Attachment Version Metadata
DefaultApi objects_documents_doc_id_attachments_attachment_id_versions_attachment_version_post POST /objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version} Restore Document Attachment Version
DefaultApi objects_documents_doc_id_attachments_attachment_id_versions_get GET /objects/documents/{doc_id}/attachments/{attachment_id}/versions Retrieve Document Attachment Versions
DefaultApi objects_documents_doc_id_attachments_file_get GET /objects/documents/{doc_id}/attachments/file Download All Document Attachments
DefaultApi objects_documents_doc_id_attachments_get GET /objects/documents/{doc_id}/attachments Retrieve Document Attachments
DefaultApi objects_documents_doc_id_attachments_post POST /objects/documents/{doc_id}/attachments Create Document Attachment
DefaultApi objects_documents_doc_id_audittrail_get GET /objects/documents/{doc_id}/audittrail Retrieve Complete Audit History for a Single Document
DefaultApi objects_documents_doc_id_delete DELETE /objects/documents/{doc_id} Delete Single Document
DefaultApi objects_documents_doc_id_events_get GET /objects/documents/{doc_id}/events Retrieve Document Events
DefaultApi objects_documents_doc_id_file_get GET /objects/documents/{doc_id}/file Download Document File
DefaultApi objects_documents_doc_id_get GET /objects/documents/{doc_id} Retrieve Document
DefaultApi objects_documents_doc_id_lock_delete DELETE /objects/documents/{doc_id}/lock Delete Document Lock
DefaultApi objects_documents_doc_id_lock_get GET /objects/documents/{doc_id}/lock Retrieve Document Lock
DefaultApi objects_documents_doc_id_lock_post POST /objects/documents/{doc_id}/lock Create Document Lock
DefaultApi objects_documents_doc_id_major_version_minor_version_attachments_file_get GET /objects/documents/{doc_id}/{major_version}/{minor_version}/attachments/file Download All Document Version Attachments
DefaultApi objects_documents_doc_id_post POST /objects/documents/{doc_id} Create Single Document Version
DefaultApi objects_documents_doc_id_put PUT /objects/documents/{doc_id} Update Single Document
DefaultApi objects_documents_doc_id_renditions_get GET /objects/documents/{doc_id}/renditions Retrieve Document Renditions
DefaultApi objects_documents_doc_id_renditions_rendition_type_delete DELETE /objects/documents/{doc_id}/renditions/{rendition_type} Delete Single Document Rendition
DefaultApi objects_documents_doc_id_renditions_rendition_type_get GET /objects/documents/{doc_id}/renditions/{rendition_type} Download Document Rendition File
DefaultApi objects_documents_doc_id_renditions_rendition_type_post POST /objects/documents/{doc_id}/renditions/{rendition_type} Add Single Document Rendition
DefaultApi objects_documents_doc_id_renditions_rendition_type_put PUT /objects/documents/{doc_id}/renditions/{rendition_type} Replace Document Rendition
DefaultApi objects_documents_doc_id_roles_role_name_and_user_or_group_id_delete DELETE /objects/documents/{doc_id}/roles/{role_name_and_user_or_group}/{id} Remove Users & Groups from Roles on a Single Document
DefaultApi objects_documents_doc_id_version_major_version_minor_version_attachments_get GET /objects/documents/{doc_id}/version/{major_version}/{minor_version}/attachments Retrieve Document Version Attachments
DefaultApi objects_documents_doc_id_versions_get GET /objects/documents/{doc_id}/versions Retrieve Document Versions
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_annotations_annotation_id_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/{annotation_id} Read Annotations by ID
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_annotations_annotation_id_replies_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/{annotation_id}/replies Read Replies of Parent Annotation
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_annotations_file_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/file Export Document Version Annotations to PDF
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_annotations_file_post POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations/file Import Document Version Annotations from PDF
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_annotations_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations Read Annotations by Document Version and Type
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_attachments_attachment_id_versions_attachment_version_file_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}/file Download Document Version Attachment Version
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_attachments_attachment_id_versions_attachment_version_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Document Version Attachment Versions
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_delete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Delete Single Document Version
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_doc_export_annotations_to_csv_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/doc-export-annotations-to-csv Retrieve Document Version Notes as CSV
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_events_post POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/events Create Document Event
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_export_video_annotations_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/export-video-annotations Retrieve Video Annotations
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_file_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/file Download Document Version File
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Retrieve Document Version
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_put PUT /objects/documents/{doc_id}/versions/{major_version}/{minor_version} Update Document Version
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_relationships_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships Retrieve Document Relationships
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_relationships_post POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships Create Single Document Relationship
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_relationships_relationship_id_delete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Delete Single Document Relationship
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_relationships_relationship_id_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id} Retrieve Document Relationship
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_renditions_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions Retrieve Document Version Renditions
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_renditions_rendition_type_delete DELETE /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Delete Document Version Rendition
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_renditions_rendition_type_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Download Document Version Rendition File
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_renditions_rendition_type_post POST /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Upload Document Version Rendition
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_renditions_rendition_type_put PUT /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type} Replace Document Version Rendition
DefaultApi objects_documents_doc_id_versions_major_version_minor_version_thumbnail_get GET /objects/documents/{doc_id}/versions/{major_version}/{minor_version}/thumbnail Download Document Version Thumbnail File
DefaultApi objects_documents_get GET /objects/documents Retrieve All Documents
DefaultApi objects_documents_id_roles_get GET /objects/documents/{id}/roles Retrieve All Document Roles
DefaultApi objects_documents_id_roles_post POST /objects/documents/{id}/roles Assign Users & Groups to Roles on a Single Document
DefaultApi objects_documents_id_roles_role_name_get GET /objects/documents/{id}/roles/{role_name} Retrieve Document Role
DefaultApi objects_documents_id_versions_major_version_minor_version_lifecycle_actions_get GET /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions Retrieve Document User Actions
DefaultApi objects_documents_id_versions_major_version_minor_version_lifecycle_actions_name_v_entry_requirements_get GET /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements Retrieve Document Entry Criteria
DefaultApi objects_documents_id_versions_major_version_minor_version_lifecycle_actions_name_v_put PUT /objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v} Initiate Document User Action
DefaultApi objects_documents_lifecycle_actions_post POST /objects/documents/lifecycle_actions Retrieve User Actions on Multiple Documents
DefaultApi objects_documents_lifecycle_actions_user_action_name_put PUT /objects/documents/lifecycle_actions/{user_action_name} Initiate Bulk Document User Actions
DefaultApi objects_documents_post POST /objects/documents Create Single Document
DefaultApi objects_documents_relationships_batch_delete DELETE /objects/documents/relationships/batch Delete Multiple Document Relationships
DefaultApi objects_documents_relationships_batch_post POST /objects/documents/relationships/batch Create Multiple Document Relationships
DefaultApi objects_documents_renditions_batch_delete DELETE /objects/documents/renditions/batch Delete Multiple Document Renditions
DefaultApi objects_documents_renditions_batch_post POST /objects/documents/renditions/batch Add Multiple Document Renditions
DefaultApi objects_documents_roles_batch_delete DELETE /objects/documents/roles/batch Remove Users and Groups from Roles on Multiple Documents & Binders
DefaultApi objects_documents_roles_batch_post POST /objects/documents/roles/batch Assign Users & Groups to Roles on Multiple Documents & Binders
DefaultApi objects_documents_templates_get GET /objects/documents/templates Retrieve Document Template Collection
DefaultApi objects_documents_templates_post POST /objects/documents/templates Create Single Document Template
DefaultApi objects_documents_templates_put PUT /objects/documents/templates Update Multiple Document Templates
DefaultApi objects_documents_templates_template_name_delete DELETE /objects/documents/templates/{template_name} Delete Basic Document Template
DefaultApi objects_documents_templates_template_name_file_get GET /objects/documents/templates/{template_name}/file Download Document Template File
DefaultApi objects_documents_templates_template_name_get GET /objects/documents/templates/{template_name} Retrieve Document Template Attributes
DefaultApi objects_documents_templates_template_name_put PUT /objects/documents/templates/{template_name} Update Single Document Template
DefaultApi objects_documents_tokens_post POST /objects/documents/tokens Document Tokens
DefaultApi objects_documents_versions_batch_actions_fileextract_post POST /objects/documents/versions/batch/actions/fileextract Export Document Versions
DefaultApi objects_documents_versions_batch_delete DELETE /objects/documents/versions/batch Delete Multiple Document Versions
DefaultApi objects_documents_versions_batch_post POST /objects/documents/versions/batch Create Multiple Document Versions
DefaultApi objects_domain_get GET /objects/domain Retrieve Domain Information
DefaultApi objects_domains_get GET /objects/domains Retrieve Domains
DefaultApi objects_edl_matched_documents_batch_actions_add_post POST /objects/edl_matched_documents/batch/actions/add Add EDL Matched Documents
DefaultApi objects_edl_matched_documents_batch_actions_remove_post POST /objects/edl_matched_documents/batch/actions/remove Remove EDL Matched Documents
DefaultApi objects_groups_auto_get GET /objects/groups/auto Retrieve Auto Managed Groups
DefaultApi objects_groups_get GET /objects/groups Retrieve All Groups
DefaultApi objects_groups_group_id_delete DELETE /objects/groups/{group_id} Delete Group
DefaultApi objects_groups_group_id_get GET /objects/groups/{group_id} Retrieve Group
DefaultApi objects_groups_group_id_put PUT /objects/groups/{group_id} Update Group
DefaultApi objects_groups_post POST /objects/groups Create Group
DefaultApi objects_licenses_get GET /objects/licenses Retrieve Application License Usage
DefaultApi objects_objectworkflows_actions_get GET /objects/objectworkflows/actions Retrieve All Multi-Record Workflows
DefaultApi objects_objectworkflows_actions_workflow_name_get GET /objects/objectworkflows/actions/{workflow_name} Retrieve Multi-Record Workflow Details
DefaultApi objects_objectworkflows_actions_workflow_name_post POST /objects/objectworkflows/actions/{workflow_name} Initiate Multi-Record Workflow
DefaultApi objects_objectworkflows_get GET /objects/objectworkflows Retrieve Workflows
DefaultApi objects_objectworkflows_tasks_get GET /objects/objectworkflows/tasks Retrieve Workflow Tasks
DefaultApi objects_objectworkflows_tasks_task_id_actions_accept_post POST /objects/objectworkflows/tasks/{task_id}/actions/accept Accept Single Record Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_cancel_post POST /objects/objectworkflows/tasks/{task_id}/actions/cancel Cancel Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_complete_post POST /objects/objectworkflows/tasks/{task_id}/actions/complete Complete Single Record Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_get GET /objects/objectworkflows/tasks/{task_id}/actions Retrieve Workflow Task Actions
DefaultApi objects_objectworkflows_tasks_task_id_actions_mdwaccept_post POST /objects/objectworkflows/tasks/{task_id}/actions/mdwaccept Accept Multi-item Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_mdwcomplete_post POST /objects/objectworkflows/tasks/{task_id}/actions/mdwcomplete Complete Multi-item Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_mdwmanagecontent_post POST /objects/objectworkflows/tasks/{task_id}/actions/mdwmanagecontent Manage Multi-Item Workflow Content
DefaultApi objects_objectworkflows_tasks_task_id_actions_mdwreassign_post POST /objects/objectworkflows/tasks/{task_id}/actions/mdwreassign Reassign Multi-item Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_reassign_post POST /objects/objectworkflows/tasks/{task_id}/actions/reassign Reassign Single Record Workflow Task
DefaultApi objects_objectworkflows_tasks_task_id_actions_task_action_get GET /objects/objectworkflows/tasks/{task_id}/actions/{task_action} Retrieve Workflow Task Action Details
DefaultApi objects_objectworkflows_tasks_task_id_actions_undoaccept_post POST /objects/objectworkflows/tasks/{task_id}/actions/undoaccept Undo Workflow Task Acceptance
DefaultApi objects_objectworkflows_tasks_task_id_actions_updateduedate_post POST /objects/objectworkflows/tasks/{task_id}/actions/updateduedate Update Workflow Task Due Date
DefaultApi objects_objectworkflows_tasks_task_id_get GET /objects/objectworkflows/tasks/{task_id} Retrieve Workflow Task Details
DefaultApi objects_objectworkflows_workflow_id_actions_get GET /objects/objectworkflows/{workflow_id}/actions Retrieve Workflow Actions
DefaultApi objects_objectworkflows_workflow_id_actions_workflow_action_get GET /objects/objectworkflows/{workflow_id}/actions/{workflow_action} Retrieve Workflow Action Details
DefaultApi objects_objectworkflows_workflow_id_actions_workflow_action_post POST /objects/objectworkflows/{workflow_id}/actions/{workflow_action} Initiate Workflow Action
DefaultApi objects_objectworkflows_workflow_id_get GET /objects/objectworkflows/{workflow_id} Retrieve Workflow Details
DefaultApi objects_picklists_get GET /objects/picklists Retrieve All Picklists
DefaultApi objects_picklists_picklist_name_get GET /objects/picklists/{picklist_name} Retrieve Picklist Values
DefaultApi objects_picklists_picklist_name_picklist_value_name_delete DELETE /objects/picklists/{picklist_name}/{picklist_value_name} Inactivate Picklist Value
DefaultApi objects_picklists_picklist_name_picklist_value_name_put PUT /objects/picklists/{picklist_name}/{picklist_value_name} Update Picklist Value
DefaultApi objects_picklists_picklist_name_post POST /objects/picklists/{picklist_name} Create Picklist Values
DefaultApi objects_picklists_picklist_name_put PUT /objects/picklists/{picklist_name} Update Picklist Value Label
DefaultApi objects_sandbox_actions_buildproduction_post POST /objects/sandbox/actions/buildproduction Build Production Vault
DefaultApi objects_sandbox_actions_promoteproduction_post POST /objects/sandbox/actions/promoteproduction Promote to Production
DefaultApi objects_sandbox_actions_recheckusage_post POST /objects/sandbox/actions/recheckusage Recheck Sandbox Usage Limit
DefaultApi objects_sandbox_batch_changesize_post POST /objects/sandbox/batch/changesize Change Sandbox Size
DefaultApi objects_sandbox_entitlements_set_post POST /objects/sandbox/entitlements/set Set Sandbox Entitlements
DefaultApi objects_sandbox_get GET /objects/sandbox Retrieve Sandboxes
DefaultApi objects_sandbox_name_delete DELETE /objects/sandbox/{name} Delete Sandbox
DefaultApi objects_sandbox_post POST /objects/sandbox Create or Refresh Sandbox
DefaultApi objects_sandbox_snapshot_api_name_actions_update_post POST /objects/sandbox/snapshot/{api_name}/actions/update Update Sandbox Snapshot
DefaultApi objects_sandbox_snapshot_api_name_actions_upgrade_post POST /objects/sandbox/snapshot/{api_name}/actions/upgrade Upgrade Sandbox Snapshot
DefaultApi objects_sandbox_snapshot_api_name_delete DELETE /objects/sandbox/snapshot/{api_name} Delete Sandbox Snapshot
DefaultApi objects_sandbox_snapshot_get GET /objects/sandbox/snapshot Retrieve Sandbox Snapshots
DefaultApi objects_sandbox_snapshot_post POST /objects/sandbox/snapshot Create Sandbox Snapshot
DefaultApi objects_sandbox_vault_id_actions_refresh_post POST /objects/sandbox/{vault_id}/actions/refresh Refresh Sandbox from Snapshot
DefaultApi objects_sandbox_vault_id_get GET /objects/sandbox/{vault_id} Retrieve Sandbox Details by ID
DefaultApi objects_securitypolicies_get GET /objects/securitypolicies Retrieve All Security Policies
DefaultApi objects_securitypolicies_security_policy_name_get GET /objects/securitypolicies/{security_policy_name} Retrieve Security Policy
DefaultApi objects_users_get GET /objects/users/ Retrieve All Users
DefaultApi objects_users_id_get GET /objects/users/{id} Retrieve User
DefaultApi objects_users_id_permissions_get GET /objects/users/{id}/permissions Retrieve User Permissions
DefaultApi objects_users_id_put PUT /objects/users/{id} Update Single User
DefaultApi objects_users_me_get GET /objects/users/me Validate Session User
DefaultApi objects_users_me_password_post POST /objects/users/me/password Change My Password
DefaultApi objects_users_me_permissions_get GET /objects/users/me/permissions Retrieve My User Permissions
DefaultApi objects_users_me_put PUT /objects/users/me Update My User
DefaultApi objects_users_post POST /objects/users Create Single User
DefaultApi objects_users_put PUT /objects/users Update Multiple Users
DefaultApi objects_users_user_id_delete DELETE /objects/users/{user_id} Disable User
DefaultApi objects_users_user_id_vault_membership_vault_id_put PUT /objects/users/{user_id}/vault_membership/{vault_id} Update Vault Membership
DefaultApi objects_vault_actions_compare_post POST /objects/vault/actions/compare Vault Compare
DefaultApi objects_vault_actions_configreport_post POST /objects/vault/actions/configreport Vault Configuration Report
DefaultApi query_components_post POST /query/components Component Definition Query
DefaultApi query_next_page_post POST /query/{next_page} Next Page URL
DefaultApi query_post POST /query Submitting a Query
DefaultApi query_previous_page_post POST /query/{previous_page} Previous Page URL
DefaultApi scim_v2_me_get GET /scim/v2/Me Retrieve Current User with SCIM
DefaultApi scim_v2_me_put PUT /scim/v2/Me Update Current User with SCIM
DefaultApi scim_v2_resource_types_get GET /scim/v2/ResourceTypes Retrieve All SCIM Resource Types
DefaultApi scim_v2_resource_types_type_get GET /scim/v2/ResourceTypes/{type} Retrieve Single SCIM Resource Type
DefaultApi scim_v2_schemas_get GET /scim/v2/Schemas Retrieve All SCIM Schema Information
DefaultApi scim_v2_schemas_id_get GET /scim/v2/Schemas/{id} Retrieve Single SCIM Schema Information
DefaultApi scim_v2_service_provider_config_get GET /scim/v2/ServiceProviderConfig Retrieve SCIM Provider
DefaultApi scim_v2_type_get GET /scim/v2/{type} Retrieve SCIM Resources
DefaultApi scim_v2_type_id_get GET /scim/v2/{type}/{id} Retrieve Single SCIM Resource
DefaultApi scim_v2_users_get GET /scim/v2/Users Retrieve All Users with SCIM
DefaultApi scim_v2_users_id_get GET /scim/v2/Users/{id} Retrieve Single User with SCIM
DefaultApi scim_v2_users_id_put PUT /scim/v2/Users/{id} Update User with SCIM
DefaultApi scim_v2_users_post POST /scim/v2/Users Create User with SCIM
DefaultApi services_certificate_cert_id_get GET /services/certificate/{cert_id} Retrieve Signing Certificate
DefaultApi services_configuration_mode_actions_disable_post POST /services/configuration_mode/actions/disable Disable Configuration Mode
DefaultApi services_configuration_mode_actions_enable_post POST /services/configuration_mode/actions/enable Enable Configuration Mode
DefaultApi services_directdata_files_get GET /services/directdata/files Retrieve Available Direct Data Files
DefaultApi services_directdata_files_name_get GET /services/directdata/files/{name} Download Direct Data File
DefaultApi services_file_staging_items_content_item_get GET /services/file_staging/items/content/{item} Download Item Content
DefaultApi services_file_staging_items_item_delete DELETE /services/file_staging/items/{item} Delete File or Folder
DefaultApi services_file_staging_items_item_get GET /services/file_staging/items/{item} List Items at a Path
DefaultApi services_file_staging_items_item_put PUT /services/file_staging/items/{item} Update Folder or File
DefaultApi services_file_staging_items_post POST /services/file_staging/items Create Folder or File
DefaultApi services_file_staging_upload_get GET /services/file_staging/upload/ List Upload Sessions
DefaultApi services_file_staging_upload_post POST /services/file_staging/upload Create Resumable Upload Session
DefaultApi services_file_staging_upload_upload_session_id_delete DELETE /services/file_staging/upload/{upload_session_id} Abort Upload Session
DefaultApi services_file_staging_upload_upload_session_id_get GET /services/file_staging/upload/{upload_session_id} Get Upload Session Details
DefaultApi services_file_staging_upload_upload_session_id_parts_get GET /services/file_staging/upload/{upload_session_id}/parts List File Parts Uploaded to Session
DefaultApi services_file_staging_upload_upload_session_id_post POST /services/file_staging/upload/{upload_session_id} Commit Upload Session
DefaultApi services_file_staging_upload_upload_session_id_put PUT /services/file_staging/upload/{upload_session_id} Upload to a Session
DefaultApi services_jobs_histories_get GET /services/jobs/histories Retrieve Job Histories
DefaultApi services_jobs_job_id_errors_get GET /services/jobs/{job_id}/errors Retrieve Import Bulk Translation File Job Errors
DefaultApi services_jobs_job_id_get GET /services/jobs/{job_id} Retrieve Job Status
DefaultApi services_jobs_job_id_summary_get GET /services/jobs/{job_id}/summary Retrieve Import Bulk Translation File Job Summary
DefaultApi services_jobs_job_id_tasks_get GET /services/jobs/{job_id}/tasks Retrieve SDK Job Tasks
DefaultApi services_jobs_monitors_get GET /services/jobs/monitors Retrieve Job Monitors
DefaultApi services_jobs_start_now_job_id_post POST /services/jobs/start_now/{job_id} Start Job
DefaultApi services_loader_extract_post POST /services/loader/extract Extract Data Files
DefaultApi services_loader_job_id_tasks_task_id_failurelog_get GET /services/loader/{job_id}/tasks/{task_id}/failurelog Retrieve Load Failure Log Results
DefaultApi services_loader_job_id_tasks_task_id_results_get GET /services/loader/{job_id}/tasks/{task_id}/results Retrieve Loader Extract Results
DefaultApi services_loader_job_id_tasks_task_id_results_renditions_get GET /services/loader/{job_id}/tasks/{task_id}/results/renditions Retrieve Loader Extract Renditions Results
DefaultApi services_loader_job_id_tasks_task_id_successlog_get GET /services/loader/{job_id}/tasks/{task_id}/successlog Retrieve Load Success Log Results
DefaultApi services_loader_load_post POST /services/loader/load Load Data Objects
DefaultApi services_package_actions_validate_post POST /services/package/actions/validate Validate Package
DefaultApi services_package_post POST /services/package Export Package
DefaultApi services_package_put PUT /services/package Import Package
DefaultApi services_queues_get GET /services/queues Retrieve All Queues
DefaultApi services_queues_queue_name_actions_disable_delivery_put PUT /services/queues/{queue_name}/actions/disable_delivery Disable Delivery
DefaultApi services_queues_queue_name_actions_enable_delivery_put PUT /services/queues/{queue_name}/actions/enable_delivery Enable Delivery
DefaultApi services_queues_queue_name_actions_reset_put PUT /services/queues/{queue_name}/actions/reset Reset Queue
DefaultApi services_queues_queue_name_get GET /services/queues/{queue_name} Retrieve Queue Status
DefaultApi services_vobject_vault_package_v_package_id_actions_validate_post POST /services/vobject/vault_package__v/{package_id}/actions/validate Validate Imported Package
DefaultApi session_delete DELETE /session End Session
DefaultApi uicode_distributions_distribution_name_code_get GET /uicode/distributions/{distribution_name}/code Download Single Client Code Distribution
DefaultApi uicode_distributions_distribution_name_delete DELETE /uicode/distributions/{distribution_name} Delete Single Client Code Distribution
DefaultApi uicode_distributions_distribution_name_get GET /uicode/distributions/{distribution_name} Retrieve Single Client Code Distribution Metadata
DefaultApi uicode_distributions_get GET /uicode/distributions Retrieve All Client Code Distribution Metadata
DefaultApi uicode_distributions_post POST /uicode/distributions Add or Replace Single Client Code Distribution
DefaultApi vobject_vault_package_v_package_id_actions_deploy_post POST /vobject/vault_package__v/{package_id}/actions/deploy Deploy Package
DefaultApi vobject_vault_package_v_package_id_actions_deploy_results_get GET /vobject/vault_package__v/{package_id}/actions/deploy/results Retrieve Package Deploy Results
DefaultApi vobjects_cascadedelete_results_object_name_job_status_job_id_get GET /vobjects/cascadedelete/results/{object_name}/{job_status}/{job_id} Retrieve Results of Cascade Delete Job
DefaultApi vobjects_deepcopy_results_object_name_job_status_job_id_get GET /vobjects/deepcopy/results/{object_name}/{job_status}/{job_id} Retrieve Results of Deep Copy Job
DefaultApi vobjects_edl_item_v_actions_createplaceholder_post POST /vobjects/edl_item__v/actions/createplaceholder Create a Placeholder from an EDL Item
DefaultApi vobjects_merges_job_id_log_get GET /vobjects/merges/{job_id}/log Download Merge Records Job Log
DefaultApi vobjects_merges_job_id_results_get GET /vobjects/merges/{job_id}/results Retrieve Record Merge Results
DefaultApi vobjects_merges_job_id_status_get GET /vobjects/merges/{job_id}/status Retrieve Record Merge Status
DefaultApi vobjects_object_name_actions_action_name_post POST /vobjects/{object_name}/actions/{action_name} Initiate Object Action on Multiple Records
DefaultApi vobjects_object_name_actions_changetype_post POST /vobjects/{object_name}/actions/changetype Change Object Type
DefaultApi vobjects_object_name_actions_merge_post POST /vobjects/{object_name}/actions/merge Initiate Record Merge
DefaultApi vobjects_object_name_actions_recalculaterollups_get GET /vobjects/{object_name}/actions/recalculaterollups Retrieve Roll-up Field Recalculation Status
DefaultApi vobjects_object_name_actions_recalculaterollups_post POST /vobjects/{object_name}/actions/recalculaterollups Recalculate Roll-up Fields
DefaultApi vobjects_object_name_actions_updatecorporatecurrency_put PUT /vobjects/{object_name}/actions/updatecorporatecurrency Update Corporate Currency Fields
DefaultApi vobjects_object_name_attachments_batch_delete DELETE /vobjects/{object_name}/attachments/batch Delete Multiple Object Record Attachments
DefaultApi vobjects_object_name_attachments_batch_post POST /vobjects/{object_name}/attachments/batch Create Multiple Object Record Attachments
DefaultApi vobjects_object_name_attachments_batch_put PUT /vobjects/{object_name}/attachments/batch Update Multiple Object Record Attachment Descriptions
DefaultApi vobjects_object_name_delete DELETE /vobjects/{object_name} Delete Object Records
DefaultApi vobjects_object_name_id_roles_role_name_get GET /vobjects/{object_name}/{id}/roles/{role_name} Retrieve Object Record Roles
DefaultApi vobjects_object_name_object_record_id_actions_action_name_get GET /vobjects/{object_name}/{object_record_id}/actions/{action_name} Retrieve Object User Actions Details
DefaultApi vobjects_object_name_object_record_id_actions_action_name_post POST /vobjects/{object_name}/{object_record_id}/actions/{action_name} Initiate Object Action on a Single Record
DefaultApi vobjects_object_name_object_record_id_actions_cascadedelete_post POST /vobjects/{object_name}/{object_record_id}/actions/cascadedelete Cascade Delete Object Record
DefaultApi vobjects_object_name_object_record_id_actions_deepcopy_post POST /vobjects/{object_name}/{object_record_id}/actions/deepcopy Deep Copy Object Record
DefaultApi vobjects_object_name_object_record_id_actions_get GET /vobjects/{object_name}/{object_record_id}/actions Retrieve Object Record User Actions
DefaultApi vobjects_object_name_object_record_id_attachment_fields_attachment_field_name_file_get GET /vobjects/{object_name}/{object_record_id}/attachment_fields/{attachment_field_name}/file Download Attachment Field File
DefaultApi vobjects_object_name_object_record_id_attachment_fields_attachment_field_name_file_post POST /vobjects/{object_name}/{object_record_id}/attachment_fields/{attachment_field_name}/file Update Attachment Field File
DefaultApi vobjects_object_name_object_record_id_attachment_fields_file_get GET /vobjects/{object_name}/{object_record_id}/attachment_fields/file Download All Attachment Field Files
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_delete DELETE /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Delete Object Record Attachment
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_get GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Retrieve Object Record Attachment Metadata
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_put PUT /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id} Update Object Record Attachment Description
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_versions_attachment_version_delete DELETE /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Delete Object Record Attachment Version
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_versions_attachment_version_file_get GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}/file Download Object Record Attachment File
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_versions_attachment_version_get GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Retrieve Object Record Attachment Version Metadata
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_versions_attachment_version_post POST /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version} Restore Object Record Attachment Version
DefaultApi vobjects_object_name_object_record_id_attachments_attachment_id_versions_get GET /vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions Retrieve Object Record Attachment Versions
DefaultApi vobjects_object_name_object_record_id_attachments_file_get GET /vobjects/{object_name}/{object_record_id}/attachments/file Download All Object Record Attachment Files
DefaultApi vobjects_object_name_object_record_id_attachments_get GET /vobjects/{object_name}/{object_record_id}/attachments Retrieve Object Record Attachments
DefaultApi vobjects_object_name_object_record_id_attachments_post POST /vobjects/{object_name}/{object_record_id}/attachments Create Object Record Attachment
DefaultApi vobjects_object_name_object_record_id_audittrail_get GET /vobjects/{object_name}/{object_record_id}/audittrail Retrieve Complete Audit History for a Single Object Record
DefaultApi vobjects_object_name_object_record_id_get GET /vobjects/{object_name}/{object_record_id} Retrieve Object Record
DefaultApi vobjects_object_name_post POST /vobjects/{object_name} Create & Upsert Object Records
DefaultApi vobjects_object_name_put PUT /vobjects/{object_name} Update Object Records
DefaultApi vobjects_object_name_roles_delete DELETE /vobjects/{object_name}/roles Remove Users & Groups from Roles on Object Records
DefaultApi vobjects_object_name_roles_post POST /vobjects/{object_name}/roles Assign Users & Groups to Roles on Object Records
DefaultApi vobjects_outbound_package_v_package_id_dependencies_get GET /vobjects/outbound_package__v/{package_id}/dependencies Retrieve Outbound Package Dependencies

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages