| ApiVersionResponse |
Model for the following API calls responses:
|
| ApiVersionResponse.ApiVersion |
|
| AuditDetailsResponse |
Model for the following API calls responses:
|
| AuditDetailsResponse.ResponseDetails |
|
| AuditDetailsResponse.ResponseDetails.DetailsObject |
|
| AuditMetadataResponse |
Model for the following API calls responses:
|
| AuditMetadataResponse.AuditMetadata |
|
| AuditMetadataResponse.AuditMetadata.Field |
|
| AuditTypesResponse |
Model for the following API calls responses:
|
| AuditTypesResponse.AuditTrail |
|
| AuthenticationResponse |
Model for the following API calls responses:
|
| AuthenticationResponse.Vault |
|
| BinderExportResponse |
Model for Retrieve Binder Export Results
GET /api/{version}/objects/binders/batch/actions/export/{jobid}/results
|
| BinderResponse |
Model for the binder response
|
| BinderResponse.Renditions |
|
| BinderResponse.Version |
|
| BinderSectionResponse |
Model for the binder section response, needed to handle:
1.
|
| BinderTemplateBulkResponse |
Model for the Template responses
|
| BinderTemplateBulkResponse.TemplateResult |
|
| BinderTemplateMetadataResponse |
Model for the following API calls responses:
|
| BinderTemplateNodeBulkResponse |
Model for the Template responses
|
| BinderTemplateNodeBulkResponse.TemplateNodeResult |
|
| BinderTemplateResponse |
Model for the Binder Template responses
|
| BulkWorkflowActionDetailsResponse |
Model for the following API calls responses:
|
| BulkWorkflowActionDetailsResponse.Control |
|
| BulkWorkflowActionDetailsResponse.Prompt |
|
| BulkWorkflowActionsResponse |
Model for the following API calls responses:
|
| BulkWorkflowActionsResponse.ActionItem |
|
| BulkWorkflowJobStartResponse |
|
| BulkWorkflowJobStartResponse.Job |
|
| ComponentContentResponse |
Response model for the Component Content Files
|
| ComponentContentResponse.ComponentContent |
|
| ComponentContentResponse.Link |
|
| DiscoveryResponse |
Model for the following API calls responses:
|
| DiscoveryResponse.DiscoveryData |
|
| DiscoveryResponse.DiscoveryData.AuthProfile |
|
| DiscoveryResponse.DiscoveryData.AuthProfile.AsMetadata |
|
| DocumentActionEntryCriteriaResponse |
Retrieve the entry criteria for a workflow.
|
| DocumentActionEntryCriteriaResponse.Property |
|
| DocumentActionEntryCriteriaResponse.Property.ObjectTypeReferenced |
|
| DocumentActionInitiateResponse |
Response model for the following API calls:
|
| DocumentActionResponse |
Response model for the following API calls:
|
| DocumentActionResponse.LifecycleAction |
|
| DocumentAnnotationResponse |
Model for the document annotation response
|
| DocumentAnnotationResponse.AnchorData |
|
| DocumentAttachmentBulkResponse |
Model for the document response
|
| DocumentAttachmentResponse |
Model for the document response
|
| DocumentAuditResponse |
Model for the following API calls responses:
|
| DocumentAuditResponse.DocumentAudit |
|
| DocumentBulkResponse |
Model for document create API response
|
| DocumentClassificationResponse |
Model for the document classification response
|
| DocumentClassificationResponse.AvailableLifecycle |
|
| DocumentClassificationResponse.RelationshipType |
|
| DocumentClassificationResponse.Template |
|
| DocumentDeletionResponse |
Model for document deletions API response
|
| DocumentDeletionResponse.DeleteDocument |
|
| DocumentDeletionResponse.ResponseDetails |
|
| DocumentEventResponse |
Model for the following API calls responses:
|
| DocumentEventSubtypeResponse |
Model for the following API calls responses:
|
| DocumentEventSubtypeResponse.DocumentEventSubtype |
|
| DocumentEventSubtypeResponse.DocumentEventSubtype.Value |
|
| DocumentEventTypeResponse |
Model for the following API calls responses:
|
| DocumentEventTypeResponse.Event |
|
| DocumentEventTypeResponse.Event.SubType |
|
| DocumentExportResponse |
Model for document export API response
|
| DocumentExportResponse.ExportedDocument |
|
| DocumentFieldResponse |
Model for the document field response
|
| DocumentLifecycleDeleteOverrideRulesResponse |
Model for lifecycle Role Assignment Rules Response API
|
| DocumentLifecycleDeleteOverrideRulesResponse.DeleteOverrideRule |
|
| DocumentLifecycleRoleAssignmentResponse |
Model for the Document Lifecycle Role Assignment response
|
| DocumentLifecycleRoleAssignmentResponse.RoleAssignment |
|
| DocumentLifecycleRoleAssignmentRulesResponse |
Model for lifecycle Role Assignment Rules Response API
|
| DocumentLockResponse |
Response model for the following API calls:
|
| DocumentLockResponse.Lock |
|
| DocumentRelationshipBulkResponse |
Model for the Document Relationship Bulk responses
|
| DocumentRelationshipMetadataResponse |
Model for the following API calls responses:
|
| DocumentRelationshipMetadataResponse.Relationship |
|
| DocumentRelationshipMetadataResponse.Relationship.RelationshipObject |
|
| DocumentRelationshipMetadataResponse.RelationshipProperty |
|
| DocumentRelationshipMetadataResponse.RelationshipType |
|
| DocumentRelationshipMetadataResponse.RelationshipType.TargetDocumentType |
|
| DocumentRelationshipResponse |
Model for the Document/Binder relationship response endpoints:
POST
/api/{version}/objects/documents/{document_id}/versions/{major_version_number_v}/{minor_version_number_v}/relationships
DELETE
/api/{version}/objects/documents/{document_id}/versions/{major_version_number__v}/{minor_version_number__v}/relationships/{relationship_id}
|
| DocumentRelationshipRetrieveResponse |
Model for the Document/Binder relationship response endpoints:
GET
/api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships
GET
/api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
GET
/api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships
GET
/api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
|
| DocumentRelationshipRetrieveResponse.Relationship |
|
| DocumentRenditionResponse |
Model for the following API calls responses:
|
| DocumentRenditionResponse.Renditions |
|
| DocumentResponse |
Model for the document response
|
| DocumentResponse.Renditions |
|
| DocumentResponse.Version |
|
| DocumentRoleChangeBulkResponse |
Model for responses to bulk Document Role Requests
|
| DocumentRoleChangeBulkResponse.DocumentRoleChange |
|
| DocumentRoleChangeResponse |
Model for responses to single Document Role Update and Delete requests
|
| DocumentRoleCheckForDCCResponse |
Model for Document Role Check for Document Change Control response
|
| DocumentRoleRetrieveResponse |
Model for responses to Document Role GET requests
|
| DocumentRoleRetrieveResponse.DocumentRole |
|
| DocumentsResponse |
Model for all documents API Response
|
| DocumentSubtypeResponse |
Model for the document subtype response
|
| DocumentSubtypeResponse.DocumentClassification |
|
| DocumentTemplateBulkResponse |
Model for the Template responses
|
| DocumentTemplateBulkResponse.TemplateResult |
|
| DocumentTemplateMetadataResponse |
Model for the following API calls responses:
|
| DocumentTemplateResponse |
Model for the document template response
|
| DocumentTemplatesResponse |
Model for the document templates response
|
| DocumentTokenResponse |
Response model for the following API calls:
|
| DocumentTokenResponse.Token |
|
| DocumentTypeResponse |
Model for the document type response
|
| DocumentTypeResponse.DocumentSubtype |
|
| DocumentTypesResponse |
Model for the all document types response
|
| DocumentTypesResponse.DocumentType |
|
| DocumentVersionResponse |
Response model for the following API calls:
|
| DocumentVersionResponse.Version |
|
| DocumentWorkflowMetadataResponse |
Model for the document response
|
| DocumentWorkflowMetadataResponse.Property |
|
| DocumentWorkflowMetadataResponse.Value |
|
| DomainAuditResponse |
Model for the following API calls responses:
|
| DomainAuditResponse.DomainAuditData |
|
| DomainResponse |
Model for the following API calls responses:
|
| DomainResponse.Domain |
|
| DomainResponse.Domain.DomainVault |
|
| DomainResponse.Domain.DomainVault.VaultFamily |
|
| EDLResponse |
Response model for an EDL API response
|
| EDLResponse.EDLNode |
|
| FileStagingItemBulkResponse |
|
| FileStagingItemBulkResponse.FileStagingItem |
|
| FileStagingItemBulkResponse.ResponseDetails |
|
| FileStagingItemResponse |
|
| FileStagingItemResponse.FileStagingItem |
|
| FileStagingJobResponse |
Response model for the following API calls:
|
| FileStagingJobResponse.Job |
|
| FileStagingSessionBulkResponse |
|
| FileStagingSessionBulkResponse.FileStagingSession |
|
| FileStagingSessionBulkResponse.ResponseDetails |
|
| FileStagingSessionResponse |
|
| FileStagingSessionResponse.FileStagingSession |
|
| GroupResponse |
Model for the following API calls responses:
|
| GroupRetrieveResponse |
Model for the following API calls responses:
|
| GroupRetrieveResponse.GroupNode |
|
| InitiateMultiDocumentWorkflowResponse |
Model for the following API calls responses:
|
| InitiateMultiDocumentWorkflowResponse.MultiDocumentWorkflowData |
|
| JobCreateResponse |
Response model for the following API calls:
|
| JobCreateResponse.Warning |
|
| JobHistoryResponse |
Response model for the API Job History response
|
| JobHistoryResponse.ResponseDetails |
|
| JobMonitorResponse |
Response model for the API Job Monitor response
|
| JobMonitorResponse.ResponseDetails |
|
| JobStatusResponse |
Response model for the API Job Status response
|
| JobTaskResponse |
Response model for the API Job Task response
|
| JobTaskResponse.JobTask |
|
| JobTaskResponse.ResponseDetails |
|
| LoaderResponse |
Model for the following API calls responses:
|
| LoginAuditResponse |
Model for the following API calls responses:
|
| LoginAuditResponse.LoginAuditData |
|
| MdlResponse |
Response model for the following API calls:
|
| MetaDataComponentRecordResponse |
Response model for the following API calls:
|
| MetaDataComponentTypeBulkResponse |
Response model for the following API calls:
|
| MetaDataComponentTypeResponse |
Response model for the following API calls:
|
| MetaDataDocumentLockResponse |
|
| MetaDataGroupResponse |
Response model for the following API call:
|
| MetaDataObjectBulkResponse |
Response model for the following API calls:
|
| MetaDataObjectFieldResponse |
Response model for the following API calls:
|
| MetaDataObjectResponse |
Response model for the following API calls:
|
| MetaDataUserResponse |
|
| MultiDocumentWorkflowDetailsResponse |
Model for the following API calls responses:
|
| MultiDocumentWorkflowDetailsResponse.Control |
For each control, the following data may be returned:
|
| MultiDocumentWorkflowDetailsResponse.MultiDocumentWorkflow |
|
| MultiDocumentWorkflowDetailsResponse.Prompt |
|
| MultiDocumentWorkflowsResponse |
Model for the following API calls responses:
|
| MultiDocumentWorkflowsResponse.MultiDocWorkflow |
|
| OauthTokenResponse |
|
| ObjectAuditResponse |
Model for the following API calls responses:
|
| ObjectAuditResponse.ObjectAuditData |
|
| ObjectRecordActionBulkResponse |
Model for the following API calls responses for the Object Workflow Action
operations:
|
| ObjectRecordActionResponse |
Model for the following API calls responses:
|
| ObjectRecordActionResponse.Action |
|
| ObjectRecordActionResponse.Link |
|
| ObjectRecordAttachmentResponse |
Model for the following API calls responses:
|
| ObjectRecordBulkResponse |
Model for the following API calls responses for the Object Record
CUD operations:
|
| ObjectRecordCollectionResponse |
Model for the following API calls responses for the Object Record CRUD
operations:
|
| ObjectRecordCollectionResponse.ResponseDetails |
|
| ObjectRecordDeletedResponse |
Model for Deleted Object Records recycle bin endpoint:
|
| ObjectRecordDeletedResponse.DeletedRecord |
|
| ObjectRecordResponse |
Model for the following API calls responses for the Object Record CRUD
operations:
|
| ObjectRecordResponse.ResponseDetails |
|
| ObjectRecordRoleChangeResponse |
Model for the Object Record Role API responses:
|
| ObjectRecordRoleChangeResponse.ObjectRoleChange |
|
| ObjectRecordRoleChangeResponse.ObjectRoleChange.ObjectRole |
|
| ObjectRecordRoleResponse |
Model for the Object Record Role API responses:
|
| ObjectRecordRoleResponse.ObjectRole |
|
| ObjectRecordTypeResponse |
Model for the Object Record Type or Object describe API responses:
|
| ObjectRecordTypeResponse.ObjectRecordType |
|
| ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeAction |
|
| ObjectRecordTypeResponse.ObjectRecordType.ObjectRecordTypeField |
|
| ObjectWorkflowActionDetailsResponse |
Model for the following API calls responses for the Object Workflow Action Details
operations:
|
| ObjectWorkflowActionResponse |
Model for the following API calls responses for the Object Workflow Action
operations:
|
| ObjectWorkflowActionResponse.WorkflowAction |
|
| ObjectWorkflowResponse |
Model for the following API calls responses for the Object workflow
operations:
|
| ObjectWorkflowResponse.ObjectWorkflow |
|
| ObjectWorkflowResponse.ResponseDetails |
|
| ObjectWorkflowTaskActionDetailsResponse |
Model for the following API calls responses for the Object Workflow Task Action Details
operations:
|
| ObjectWorkflowTaskActionDetailsResponse.Control |
|
| ObjectWorkflowTaskActionDetailsResponse.Control.Prompt |
|
| ObjectWorkflowTaskActionDetailsResponse.Control.Reason |
|
| ObjectWorkflowTaskActionDetailsResponse.Control.Verdict |
|
| ObjectWorkflowTaskActionDetailsResponse.ObjectWorkflowTaskAction |
|
| ObjectWorkflowTaskResponse |
Model for the following API calls responses for the Object WorkflowTask
operations:
|
| ObjectWorkflowTaskResponse.ObjectWorkflowTask |
|
| ObjectWorkflowTaskResponse.ResponseDetails |
|
| PackageResponse |
Model for the following API calls responses:
|
| PackageResponse.VaultPackage |
|
| PackageResultsResponse |
Model for the following API calls responses:
|
| PackageResultsResponse.ResponseDetails |
|
| PackageResultsResponse.ResponseDetails.DeploymentLog |
|
| PicklistResponse |
Model for the following API calls
|
| PicklistResponse.Picklist |
|
| PicklistResponse.Picklist.UsedIn |
|
| PicklistValueResponse |
Model for the following API calls
GET /api/{version}/objects/picklists/{picklist_name}
|
| PicklistValueResponse.PicklistValue |
|
| QueryResponse |
Model for VQL query API calls
|
| QueryResponse.QueryDescribe |
|
| QueryResponse.QueryDescribe.QueryObject |
|
| QueryResponse.QueryResult |
|
| QueryResponse.RecordProperty |
|
| QueryResponse.RecordProperty.FieldAdditionalData |
|
| QueueResponse |
Response model for the following API calls:
|
| QueueResponse.Queue |
|
| QueueResponse.Queue.Connection |
|
| QueueResponse.Queue.Connection.QueueError |
|
| SandboxEntitlementResponse |
|
| SandboxEntitlementResponse.SandboxEntitlement |
|
| SandboxEntitlementResponse.SandboxEntitlement.Entitlement |
|
| SandboxResponse |
|
| SandboxResponse.Limit |
|
| SandboxResponse.Sandbox |
|
| SCIMResponse |
|
| SCIMResponse.AuthenticationScheme |
|
| SCIMResponse.Bulk |
|
| SCIMResponse.ChangePassword |
|
| SCIMResponse.Etag |
|
| SCIMResponse.Filter |
|
| SCIMResponse.Meta |
|
| SCIMResponse.Patch |
|
| SCIMResponse.Resource |
|
| SCIMResponse.Resource.Schema |
|
| SCIMResponse.Sort |
|
| SCIMUserBulkResponse |
|
| SCIMUserResponse |
|
| SDKResponse |
Response model for the following API calls:
|
| SecurityPoliciesResponse |
Model for response to requests to the Retrieve Security Policies endpoint
|
| SecurityPoliciesResponse.SecurityPolicy |
|
| SecurityPolicyResponse |
Model for response to requests to the Retrieve Security Policy endpoint
|
| SecurityPolicyResponse.SecurityPolicy |
|
| SecurityPolicyResponse.SecurityPolicy.PolicyDetails |
|
| SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings |
|
| SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings.AuthenticationType |
|
| SystemAuditResponse |
Model for the following API calls responses:
|
| SystemAuditResponse.SystemAuditData |
|
| UserBulkResponse |
|
| UserPermissionResponse |
|
| UserPermissionResponse.UserPermissions |
|
| UserPermissionResponse.UserPermissions.PermissionSet |
|
| UserResponse |
|
| UserRetrieveResponse |
|
| UserRetrieveResponse.UserNode |
|
| ValidatePackageResponse |
Response model for the following API calls:
|
| ValidatePackageResponse.ResponseDetails |
|
| ValidatePackageResponse.ResponseDetails.PackageStep |
|
| VaultResponse |
Base Vault API response message
|
| VaultResponse.APIResponseError |
|