Overview
Configuration is provided for establishing connections with Veeva Vault service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Advanced settings for managing file uploads
When uploading a file optional request headers can be specified. The headers can be specified in the File Transfer Task property AdditionalOptions. The property is optional and can be shown by clicking the Expand Options button.
The format of the property is [header name]=[value] (e.g) overwrite=true
Quick Start
This guide provides a detailed, step-by-step walkthrough for establishing a connection to the Veeva Vault REST API using COZYROC's REST Connection Manager.
Step 1. Launch Visual Studio as an Administrator. Right-click on the Connection Managers tab, then select New Connection. In the Add SSIS Connection Manager window, scroll down and choose REST Connection Manager, then click Add.
Step 2. From the Configuration drop-down menu, select Veeva Vault.
Step 3. In the Server Host parameter set the vaultDNS to your desired DNS. Then, you can just enter the username and password in the corresponding fields below for the username and password parameters.
Step 4. Click Test Connection to test your connection.
Congratulations! You have successfully established a connection to your Veeva Vault instance.
In this guide, we will demonstrate how to retrieve data from the Veeva Vault service using the COZYROC REST Source component.
Step 1. Select an existing Data Flow Task or create a new one.
Step 2. Open SSIS Toolbox and drag and drop the COZYROC REST Source component.
Step 3. Double-click the REST Source component and choose the Veeva Vault connection from the dropdown menu. Then, select the desired Veeva Vault resource from the second dropdown below.
Optionally, you can add additional parameters in the grid below, if required.
Step 4. Click on the Columns tab and select the Veeva Vault resource columns you wish to read.
Step 5. Click Preview to ensure all required resource columns are included.
Congratulations! You’ve successfully learned how to read data from the Veeva Vault service.
In this guide, we will demonstrate how to write data to the Veeva Vault service using the COZYROC REST Destination component.
Step 1. Select an existing Data Flow task or create a new Data Flow Task.
Step 2. Open the SSIS Toolbox and drag and drop the COZYROC REST Destination component.
Step 3. Double-click the REST Destination component, select the Veeva Vault connection from the dropdown menu, and choose the desired resource action and Veeva Vault resource to work with.
Step 4. Click on the Mapping tab and map the input columns for the process you're configuring.
If you need to provide input for other resource composite objects, modify the input above and map the corresponding columns.
Congratulations! You’ve successfully learned how to write data to the Veeva Vault resource.
Configuration
Base URL address: https://[vaultDNS]/api/v24.2.
- Basic
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- username: Required. Specify the username.
- password: Required. Specify the password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=token.Access}}
Documentation: https://developer.veevavault.com/api/24.2/#authentication.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/domain.
The result is extracted from:{{=response.domain__v}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-domain-information.
- domain_name__v
Template: ShortText.
- domain_type__v
Template: ShortText.
- vaults__v
Field components:
- An array.
- Contains the following components: id, vault_name__v, vault_status__v, vault_application__v, vault_family__v.
- name
Template: ShortText.
- type
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vobjects/{{=Veeva.UI.ObjectEditor.getValue(parameters)}}/{{=parameters.id}}/attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- object: Required. Specify the object name.
- id: Required. Specify the record identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-object-record-attachments.
- [Create] action
-
Endpoint URL address:
/vobjects/{{=item.object}}/{{=item.record_id}}/attachments.The following request parameters will be automatically processed:
-
file:
{{=item.content}}
Documentation: https://developer.veevavault.com/api/24.2/#create-object-record-attachment.
-
file:
- [Update] action
-
Endpoint URL address:
/vobjects/{{=item.object}}/{{=item.record_id}}/attachments/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-object-record-attachment-description.
- [Delete] action
-
Endpoint URL address:
/vobjects/{{=item.object}}/{{=item.record_id}}/attachments/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-object-record-attachment.
The resource includes the fields from the Attachment template.
- object
Template: ShortText.
- record_id
Data type: DT_I4
- content
Data type: DT_IMAGE The value is gathered from
/vobjects/{{=parameters.object}}/{{=parameters.id}}/attachments/{{=item.id}}address.
Based on resource template Document.
- [Read] action
-
Endpoint URL address:
/objects/documents.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-documents.
- [Read Single] action
-
Endpoint URL address:
/objects/documents/{{=parameters.id}}.
The result is extracted from:{{=[response.document]}}.The action has the following user-defined parameters:
- id: Required. Specify the document identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document.
- [Create] action
-
Endpoint URL address:
/objects/documents.The following request parameters will be automatically processed:
-
X-VaultAPI-MigrationMode:
{{=parameters.get('X-VaultAPI-MigrationMode')}} -
file:
{{=item.content}} -
item:
{{=_.omit(item, 'content')}}
Documentation: https://developer.veevavault.com/api/24.2/#create-single-document.
-
X-VaultAPI-MigrationMode:
- [Update] action
-
Endpoint URL address:
/objects/documents/{{=item.id}}.The following request parameters will be automatically processed:
-
X-VaultAPI-MigrationMode:
{{=parameters.get('X-VaultAPI-MigrationMode')}}
Documentation: https://developer.veevavault.com/api/24.2/#update-single-document.
-
X-VaultAPI-MigrationMode:
- [Delete] action
-
Endpoint URL address:
/objects/documents/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-object-record-attachment.
- owner__v
Template: GroupUser.
- editor__v
Template: GroupUser.
- reviewer__v
Template: GroupUser.
- viewer__v
Template: GroupUser.
- coordinator__v
Template: GroupUser.
- approver__v
Template: GroupUser.
- consumer__v
Template: GroupUser.
- distribution_contacts__v
Template: GroupUser.
- versions
A read-only field. The value is gathered from
/objects/documents/{{=item.id}}/versionsaddress. The gathered value is processed with{{=response.versions}}expression. Field components:- An array.
-
Uses template:
DocVersion.
- content
Data type: DT_IMAGE The value is gathered from
/objects/documents/{{=item.id}}/fileaddress.- lock
A read-only field. The value is gathered from
/objects/documents/{{=item.id}}/lockaddress. Field components:- Contains the following components: lock.
- renditions
A read-only field. The value is gathered from
/objects/documents/{{=item.id}}/renditionsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: responseStatus, renditionTypes, renditions.
-
Uses template:
- attachments
A read-only field. The value is gathered from
/objects/documents/{{=item.id}}/attachmentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
Attachment.
- events
A read-only field. The value is gathered from
/objects/documents/{{=item.id}}/eventsaddress. The gathered value is processed with{{=response.events}}expression. Field components:- An array.
-
Uses template:
DocEvent.
- action
Template: ShortText. Field components:
- Contains the following components: createLock, deleteLock.
- [External]
-
The external fields URL address:
/metadata/objects/documents/properties. The external fields list is extracted from:{{=response.properties}}.- {{=external.name}}
Template: {{=Veeva.getFieldTemplate(external.type)}}. ( length {{=external.maxLength || 255}} )
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/documents/{{=parameters.documentId}}/attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- documentId: Required. Specify the document identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document-attachments.
- [Read Single] action
-
Endpoint URL address:
/objects/documents/{{=parameters.documentId}}/attachments/{{=parameters.attachmentId}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- documentId: Required. Specify the document identifier.
- attachmentId: Required. Specify the attachment identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document-attachment-metadata.
- [Create] action
-
Endpoint URL address:
/objects/documents/{{=item.documentId}}/attachments.The following request parameters will be automatically processed:
-
file:
{{=item.content}}
Documentation: https://developer.veevavault.com/api/24.2/#create-document-attachment.
-
file:
- [Update] action
-
Endpoint URL address:
/objects/documents/{{=item.documentId}}/attachments/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-document-attachment-description.
- [Delete] action
-
Endpoint URL address:
/objects/documents/{{=item.documentId}}/attachments/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-single-document-attachment.
The resource includes the fields from the Attachment template.
- documentId
A key field. Data type: DT_I4
- versions
A read-only field. The value is gathered from
/objects/documents/{{=parameters.documentId}}/attachments/{{=item.id}}/versionsaddress. The gathered value is processed with{{=response.versions}}expression. Field components:- An array.
-
Uses template:
DocVersion.
- content
Data type: DT_IMAGE The value is gathered from
/objects/documents/{{=parameters.documentId}}/attachments/{{=item.id}}/fileaddress.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/documents/templates.
The result is extracted from:{{=response.data}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document-template-collection.
- [Read Single] action
-
Endpoint URL address:
/objects/documents/templates/{{=parameters.templateName}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- templateName: Required. Specify the template name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document-template-attributes.
- [Create] action
-
Endpoint URL address:
/objects/documents/templates.The following request parameters will be automatically processed:
-
file:
{{=item.content}} -
item:
{{=_.omit(item, 'content')}}
Documentation: https://developer.veevavault.com/api/24.2/#create-single-document-template.
-
file:
- [Update] action
-
Endpoint URL address:
/objects/documents/templates/{{=item.name__v}}.Documentation: https://developer.veevavault.com/api/24.2/#update-single-document-template.
- [Delete] action
-
Endpoint URL address:
/objects/documents/templates/{{=item.name__v}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-basic-document-template.
- name__v
A key field. Template: ShortText.
- label__v
Template: ShortText.
- active__v
Data type: DT_BOOL
- type__v
Template: ShortText.
- subtype__v
Template: ShortText.
- classification__v
Template: ShortText.
- format__v
Template: ShortText.
- size__v
Data type: DT_I4
- created_by__v
Data type: DT_I4 A read-only field.
- file_uploaded_by__v
Data type: DT_I4
- md5checksum__v
Template: ShortText.
- content
Data type: DT_IMAGE The value is gathered from
/objects/documents/templates/{{=item.name__v}}/fileaddress.
Based on resource template Document.
- [Read] action
-
Endpoint URL address:
/objects/documents.
The result is extracted from:{{=_.where(_.pluck(response.documents, 'document'), { binder__v: true })}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binders.
- [Read Single] action
-
Endpoint URL address:
/objects/binders/{{=parameters.binderId}}.
The result is extracted from:{{=_.pluck(response.binder.nodes, 'properties')}}.The action has the following user-defined parameters:
- binderId: Required. Specify the binder identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder.
- [Create] action
-
Endpoint URL address:
/objects/binders.Documentation: https://developer.veevavault.com/api/24.2/#create-binders.
- [Update] action
-
Endpoint URL address:
/objects/binders/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-binder.
- [Delete] action
-
Endpoint URL address:
/objects/binders/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-binders.
- id
A key field. Data type: DT_I4
- version_id
Template: ShortText.
- binder__v
Data type: DT_BOOL
- owner__v
Template: GroupUser.
- editor__v
Template: GroupUser.
- reviewer__v
Template: GroupUser.
- viewer__v
Template: GroupUser.
- coordinator__v
Template: GroupUser.
- approver__v
Template: GroupUser.
- consumer__v
Template: GroupUser.
- distribution_contacts__v
Template: GroupUser.
- annotations_all__v
Data type: DT_I4
- annotations_permalink__v
Data type: DT_I4
- language__v
Template: LongText. A composite field.
- filename__v
Template: ShortText.
- locked_by__v
Data type: DT_I4
- version_created_by__v
Data type: DT_I4 A read-only field.
- content_creation_cost__v
Template: ShortText.
- lifecycle__v
Template: ShortText.
- detail_group__v
Template: LongText. A composite field.
- global_id__sys
Template: ShortText.
- latest_version__v
Data type: DT_BOOL
- allow_pdf_download__v
Template: LongText. A composite field.
- name__v
Template: ShortText.
- pages__v
Data type: DT_I4
- type__v
Template: ShortText.
- title__v
Template: ShortText.
- annotations_unresolved__v
Data type: DT_I4
- last_modified_by__v
Data type: DT_I4
- annotations_approved__v
Data type: DT_I4
- version_modified_date__v
Template: DateTime.
- annotations_claim__v
Data type: DT_I4
- created_by__v
Data type: DT_I4 A read-only field.
- version_creation_date__v
Template: DateTime.
- format__v
Template: ShortText.
- content_creation_currency__v
Template: ShortText.
- from_address__v
Template: ShortText.
- annotations_links__v
Data type: DT_I4
- bookmarks_edited__sys
Template: ShortText.
- global_version_id__sys
Template: ShortText.
- status__v
Template: ShortText.
- suppress_rendition__v
Template: ShortText.
- annotations_auto__v
Data type: DT_I4
- product__v
Template: LongText. A composite field.
- country__v
Template: LongText. A composite field.
- subject__v
Template: ShortText.
- annotations_anchors__v
Data type: DT_I4
- document_number__v
Template: ShortText.
- crosslink__v
Data type: DT_BOOL
- annotations_notes__v
Data type: DT_I4
- annotations_suggested__v
Data type: DT_I4
- locked__v
Data type: DT_BOOL
- restrict_fragments_by_product__v
Data type: DT_BOOL
- locked_date__v
Template: DateTime.
- size__v
Data type: DT_I4
- md5checksum__v
Template: ShortText.
- global_content_type__v
Template: LongText. A composite field.
- document_creation_date__v
Template: DateTime. A read-only field.
- annotations_resolved__v
Data type: DT_I4
- annotations_lines__v
Data type: DT_I4
- check_consent__v
Template: LongText. A composite field.
- document_id__v
Data type: DT_I4
- section_number__v
Template: ShortText.
- order__v
Data type: DT_I4
- parent_id__v
Template: ShortText.
- major_version_number__v
Data type: DT_I4
- minor_version_number__v
Data type: DT_I4
- type
Template: ShortText.
- relationships
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Binder Relationship'].getData({ parameters: [ 'binderId=' + item.id, 'major_version=' + item.major_version_number__v, 'minor_version=' + item.minor_version_number__v] })}}expression. Field components:- An array.
-
Uses template:
BinderRelationship.
- sections
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Binder Section'].getData({ parameters: ['binderId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
BinderSection.
- action
Template: ShortText. Field components:
-
Uses template:
ActionItemT. - Contains the following components: addDocument, moveDocument, removeDocument, updateRule.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/binders/{{=parameters.binderId}}/versions/{{=parameters.major_version}}/{{=parameters.minor_version}}/relationships.
The result is extracted from:{{=_.pluck(response.relationships, 'relationship')}}.The action has the following user-defined parameters:
- binderId: Required. Specify the binder identifier.
- major_version: Required. Specify the major version numberr.
- minor_version: Required. Specify the minor version number.
- [Read Single] action
-
Endpoint URL address:
/objects/binders/{{=parameters.binderId}}/versions/{{=parameters.major_version}}/{{=parameters.minor_version}}/relationships/{{=parameters.relationshipId}}.
The result is extracted from:{{=_.pluck(response.relationships, 'relationship')}}.The action has the following user-defined parameters:
- binderId: Required. Specify the binder identifier.
- relationshipId: Required. Specify the relationship identifier.
- major_version: Required. Specify the major version numberr.
- minor_version: Required. Specify the minor version number.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder-relationship.
- [Create] action
-
Endpoint URL address:
/objects/binders/{{=item.binderId}}/versions/{{=item.major_version}}/{{=item.minor_version}}/relationships.Documentation: https://developer.veevavault.com/api/24.2/#create-binder-relationship.
- [Delete] action
-
Endpoint URL address:
/objects/binders/{{=item.binderId}}/versions/{{=item.major_version}}/{{=item.minor_version}}/relationships/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-binder-relationship.
The resource includes the fields from the BinderRelationship template.
- binderId
A key field. Data type: DT_I4
- major_version
A key field. Data type: DT_I4
- minor_version
A key field. Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/binders/{{=parameters.binderId}}/sections.
The result is extracted from:{{=_.pluck(response.binder.nodes, 'properties')}}.The action has the following user-defined parameters:
- binderId: Required. Specify the binder identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder-sections.
- [Create] action
-
Endpoint URL address:
/objects/binders/{{=item.binderId}}/sections.Documentation: https://developer.veevavault.com/api/24.2/#create-binder-section.
- [Update] action
-
Endpoint URL address:
/objects/binders/{{=item.binderId}}/sections/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-binder-section.
- [Delete] action
-
Endpoint URL address:
/objects/binders/{{=item.binderId}}/sections/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-binder-section.
The resource includes the fields from the BinderSection template.
- binderId
A key field. Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/binders/templates.
The result is extracted from:{{=response.data}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder-template-collection.
- [Read Single] action
-
Endpoint URL address:
/objects/binders/templates/{{=parameters.templateName}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- templateName: Required. Specify the template name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder-template-attributes.
- [Create] action
-
Endpoint URL address:
/objects/binders/templates.Documentation: https://developer.veevavault.com/api/24.2/#create-binder-template.
- [Update] action
-
Endpoint URL address:
/objects/binders/templates/{{=item.templateName}}.Documentation: https://developer.veevavault.com/api/24.2/#update-binder-section.
- [Delete] action
-
Endpoint URL address:
/objects/binders/templates/{{=item.templateName}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-binder-template.
- name__v
A key field. Template: ShortText.
- label__v
Template: ShortText.
- active__v
Data type: DT_BOOL
- type__v
Template: ShortText.
- subtype__v
Template: ShortText.
- classification__v
Template: ShortText.
- filing_model__v
Template: ShortText.
- node
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Binder Template Node'].getData({ parameters: ['templateName=' + item.name__v] })}}expression. Field components:- An array.
-
Uses template:
TemplateNode.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/binders/templates/{{=parameters.templateName}/bindernodes.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- templateName: Required. Specify the template name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-binder-template-node-attributes.
- [Create] action
-
Endpoint URL address:
/objects/binders/templates/{{=item.templateName}/bindernodes.Documentation: https://developer.veevavault.com/api/24.2/#create-binder-template-node.
The resource includes the fields from the TemplateNode template.
- templateName
A key field. Template: ShortText.
Based on resource template VaultObject.
- [Read] action
-
Endpoint URL address:
/audittrail/{{=parameters.auditTrailType}}.The action has the following user-defined parameters:
- auditTrailType: Required. Specify the audit trial type.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-audit-details.
- id
A key field. Data type: DT_R8
- timestamp
A key field. Template: DateTime. A read-only field.
- user_name
Template: ShortText.
- full_name
Template: ShortText.
- source_ip
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- browser
Template: ShortText.
- platform
Template: ShortText.
Based on resource template VaultObject.
- [Read document] action
-
Endpoint URL address:
/objects/documents/{{=parameters.docId}}/audittrail.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- docId: Required. Specify the doc identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-complete-audit-history-for-a-single-document.
- [Read object] action
-
Endpoint URL address:
/vobjects/{{=Veeva.UI.ObjectEditor.getValue(parameters)}}/{{=parameters.recordId}}/audittrail.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- object: Required. Specify the object name.
- recordId: Required. Specify the object record identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-complete-audit-history-for-a-single-object-record.
- id
A key field. Data type: DT_I4
- timestamp
Template: DateTime. A read-only field.
- user_name
Template: ShortText.
- full_name
Template: ShortText.
- action
Template: ShortText.
- item
Template: ShortText.
- field_name
Template: ShortText.
- field_label
Template: ShortText.
- old_value
Template: ShortText.
- new_value
Template: ShortText.
- old_display_value
Template: ShortText.
- new_display_value
Template: ShortText.
- workflow_name
Template: ShortText.
- task_name
Template: ShortText.
- signature_meaning
Template: ShortText.
- view_license
Template: ShortText.
- job_instance_id
Template: ShortText.
- doc_id
Data type: DT_I4
- version
Template: ShortText.
- document_url
Template: ShortText.
- event_description
Template: ShortText.
- record_id
Template: ShortText.
- object_label
Template: ShortText.
- object_name
Template: ShortText.
- verdict
Template: ShortText.
- reason
Template: ShortText.
Based on resource template VaultObject.
- [Read] action
-
Endpoint URL address:
/notifications/histories.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-complete-audit-history-for-a-single-document.
- send_date
Template: DateTime. A read-only field.
- recipient_name
Template: ShortText.
- recipient_id
Data type: DT_I4
- recipient_email
Template: ShortText.
- status
Template: ShortText.
- error_message
Template: LongText.
- subject
Template: ShortText.
- workflow_id
Data type: DT_I4
- task_id
Template: ShortText.
- document_id
Template: ShortText.
- major_version
Template: ShortText.
- minor_version
Template: ShortText.
- object_name
Template: ShortText.
- object_record_id
Template: ShortText.
- sender_name
Template: ShortText.
- sender_id
Data type: DT_I4
- notification_id
Data type: DT_I4
- included_notification_ids
Template: ShortText.
- status_date
Template: DateTime.
- template_name
Template: ShortText.
Based on resource template VaultObject.
- [Read] action
-
Endpoint URL address:
/objects/objectworkflows.The action has the following user-defined parameters:
- object: Required. Specify the Vault object name__v.
- record_id__v: Required. Specify the record identifier.
The following request parameters will be automatically processed:
-
object__v:
{{=Veeva.UI.ObjectEditor.getValue(parameters)}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflows.
- [Read Single] action
-
Endpoint URL address:
/objects/objectworkflows/{{=parameters.workflowId}}.The action has the following user-defined parameters:
- workflowId: Required. Specify the workflow identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflows.
- id
A key field. Data type: DT_I4
- label__v
Template: ShortText.
- status__v
Template: LongText. A composite field.
- object__v
Template: ShortText.
- record_id__v
Template: ShortText.
- initiator__v
Data type: DT_I4
- started_date__v
Template: DateTime. A read-only field.
- completed_date__v
Template: DateTime. A read-only field.
- cancelled_date__v
Template: DateTime. A read-only field.
- actions
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Workflow Action'].getData({ parameters: ['workflowId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
WorkflowAction.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/objectworkflows/{{=parameters.workflowId}}/actions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- workflowId: Required. Specify the workflow identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflow-actions.
- [Read Single] action
-
Endpoint URL address:
/objects/objectworkflows/{{=parameters.workflowId}}/actions/{{=parameters.workflowAction}}.The action has the following user-defined parameters:
- workflowId: Required. Specify the workflow identifier.
- workflowAction: Required. Specify the workflow identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflow-action-details.
The resource includes the fields from the WorkflowAction template.
Based on resource template VaultObject.
- [Read] action
-
Endpoint URL address:
/objects/objectworkflows/tasks.The action has the following user-defined parameters:
- object: Required. Specify the Vault object name__v.
- record_id__v: Required. Specify the record identifier.
The following request parameters will be automatically processed:
-
object__v:
{{=Veeva.UI.ObjectEditor.getValue(parameters)}} -
page_size:
{{=parameters.batchSize}} -
limit:
{{=undefined}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflows.
- [Read Single] action
-
Endpoint URL address:
/objects/objectworkflows/tasks/{{=parameters.taskId}}.The action has the following user-defined parameters:
- taskId: Required. Specify the workflow identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflow-task-details.
- id
A key field. Data type: DT_I4
- label__v
Template: ShortText.
- status__v
Template: LongText. A composite field.
- object__v
Template: ShortText.
- record_id__v
Template: ShortText.
- instructions__v
Template: ShortText.
- assignee__v
Template: ShortText.
- created_date__v
Template: DateTime. A read-only field.
- assigned_date__v
Template: DateTime.
- workflow__v
Template: ShortText.
- workflow_class__sys
Template: ShortText.
- actions
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Workflow Task Action'].getData({ parameters: ['taskId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
WorkflowTaskAction.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/objectworkflows/tasks/{{=parameters.taskId}}/actions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- taskId: Required. Specify the workflow identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflow-task-actions.
- [Read Single] action
-
Endpoint URL address:
/objects/objectworkflows/tasks/{{=parameters.taskId}}/actions/{{=parameters.action}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- taskId: Required. Specify the workflow identifier.
- action: Required. Specify the task action name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-workflow-task-action-details.
The resource includes the fields from the WorkflowTaskAction template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/{{=parameters.source}}/lifecycle_actions.
The result is extracted from:{{=response.lifecycle_actions__v}}.
The action uses POST method.The action has the following user-defined parameters:
- source: Required. Specify the source (e.g) documents or binders.
- docIds: Required. Specify comma delimited docIds for document or binder.
The following request parameters will be automatically processed:
-
fields:
{{=undefined}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-user-actions-on-multiple-documents-or-binders.
- name__v
A key field. Template: ShortText.
- label__v
Template: ShortText.
- lifecycle_action_type__v
Template: ShortText.
- lifecycle__v
Template: ShortText.
- state__v
Template: ShortText.
- entry_requirements__v
Template: LongText.
Based on resource template VaultObject.
- [Read] action
-
Endpoint URL address:
/configuration/role_assignment_rule.
The result is paginated.The following request parameters will be automatically processed:
-
fields:
{{=undefined}} -
limit:
{{=undefined}} -
offset:
{{=undefined}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-lifecycle-role-assignment-rules-default-amp-override.
-
fields:
- [Create] action
-
Endpoint URL address:
/configuration/role_assignment_rule.Documentation: https://developer.veevavault.com/api/24.2/#create-lifecycle-role-assignment-override-rules.
- [Update] action
-
Endpoint URL address:
/configuration/role_assignment_rule.Documentation: https://developer.veevavault.com/api/24.2/#update-lifecycle-role-assignment-rules-default-amp-override.
- [Delete] action
-
Endpoint URL address:
/configuration/role_assignment_rule.The following request parameters will be automatically processed:
-
application/json:
{{=undefined}} -
item:
{{=function() { var result = item; if (item.object) { result[item.object] = item.id; result[item.object + '.' + name__v] = item.name__v; } return result; }()}}
Documentation: https://developer.veevavault.com/api/24.2/#delete-lifecycle-role-assignment-override-rules.
-
application/json:
- id
A key field. Template: ShortText.
- lifecycle__v
Template: ShortText.
- role__v
Template: ShortText.
- name__v
A key field. Template: ShortText.
- user_name__v
Template: ShortText.
- allowed_users__v
Template: LongText. A composite field.
- allowed_groups__v
Template: LongText. A composite field.
- allowed_default_users__v
Template: LongText. A composite field.
- allowed_default_groups__v
Template: LongText. A composite field.
- object
A key field. Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/documents/actions.
The result is extracted from:{{=response.data}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-document-workflows.
- [Read Single] action
-
Endpoint URL address:
/objects/documents/actions/{{=parameters.workflowName}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- workflowName: Optional. Specify the document workflow name value.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-document-workflow-details.
- name
Template: ShortText.
- controls
Field components:
- An array.
-
Uses template:
CommonActionRef. - Contains the following components: type, instructions.
- label
Template: ShortText.
- type
Template: ShortText.
- cardinality
Template: ShortText.
- participant
Template: ShortText.
- documents
Template: ShortText.
- date
Template: Date.
- description
Template: LongText.
- variable
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vobjects/{{=Veeva.UI.ObjectEditor.getValue(parameters)}}/{{=parameters.id}}/actions.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- object: Required. Specify the object name.
- id: Required. Specify the record identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-object-record-user-actions.
- [Read Single] action
-
Endpoint URL address:
/vobjects/{{=Veeva.UI.ObjectEditor.getValue(parameters)}}/{{=parameters.id}}/actions/{{=parameters.action}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- object: Required. Specify the object name.
- id: Required. Specify the record identifier.
- action: Required. Specify the action name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-object-user-action-details.
- name
A key field. Template: ShortText.
- links
Field components:
- An array.
- Contains the following components: rel, href, accept, method.
- label
Template: ShortText.
- type
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/scim/v2/ServiceProviderConfig.
The result is extracted from:{{=[response]}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-object-record-user-actions.
- schemas
Template: LongText. A composite field.
- documentationUri
Template: ShortText.
- patch
Field components:
- Contains the following components: supported.
- bulk
Field components:
- Contains the following components: supported, maxOperations, maxPayloadSize.
- filter
Field components:
- Contains the following components: supported, maxResults.
- changePassword
Field components:
- Contains the following components: supported.
- sort
Field components:
- Contains the following components: supported.
- etag
Field components:
- Contains the following components: supported.
- authenticationSchemes
Field components:
- An array.
- Contains the following components: name, description, type, primary.
- meta
Field components:
-
Uses template:
ShortText. - Contains the following components: resourceType, location.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/scim/v2/Schemas.
The result is extracted from:{{=response.Resources}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-scim-schema-information.
- [Read Single] action
-
Endpoint URL address:
/scim/v2/Schemas/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the identifier for specific schema.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-single-scim-schema-information.
- id
A key field. Template: ShortText.
- schemas
Template: LongText. A composite field.
- name
Template: ShortText.
- description
Template: LongText.
- attributes
Field components:
- An array.
- Contains the following components: name, type, subAttributes, multiValued, description, required, caseExact, mutability, returned, uniqueness.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/scim/v2/ResourceTypes.
The result is extracted from:{{=response.Resources}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-scim-resource-types.
- [Read Single] action
-
Endpoint URL address:
/scim/v2/ResourceTypes/{{=parameters.type}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- type: Required. Specify a specific resource type.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-single-scim-resource-type.
- id
A key field. Template: ShortText.
- schemas
Template: LongText. A composite field.
- name
Template: ShortText.
- description
Template: LongText.
- endpoint
Template: ShortText.
- schema
Template: ShortText.
- schemaExtensions
Field components:
- An array.
- Contains the following components: schema, required.
- meta
Field components:
-
Uses template:
ShortText. - Contains the following components: resourceType, location.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/scim/v2/Users.
The result is extracted from:{{=response.Resources}}.
The result is paginated.The following request parameters will be automatically processed:
-
count:
{{=parameters.batchSize}} -
startIndex:
{{=parameters.iterator}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-users-with-scim.
-
count:
- [Read Single] action
-
Endpoint URL address:
/scim/v2/Users/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the identifier for specific user.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-single-user-with-scim.
- [Read current] action
-
Endpoint URL address:
/scim/v2/me.
The result is extracted from:{{=[response]}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-users-with-scim.
- [Create] action
-
Endpoint URL address:
/scim/v2/Users.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.veevavault.com/api/24.2/#create-user-with-scim.
-
application/json:
- [Update] action
-
Endpoint URL address:
/scim/v2/Users/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.veevavault.com/api/24.2/#update-user-with-scim.
-
application/json:
- id
A key field. Data type: DT_I4
- schemas
Template: LongText. A composite field.
- meta
Field components:
-
Uses template:
DateTime. - Contains the following components: created, lastModified, resourceType, location.
-
Uses template:
- active
Data type: DT_BOOL
- displayName
Template: ShortText.
- emails
Field components:
- An array.
- Contains the following components: value, type.
- locale
Template: ShortText.
- name
Field components:
-
Uses template:
ShortText. - Contains the following components: familyName, givenName.
-
Uses template:
- preferredLanguage
Template: ShortText.
- timezone
Template: ShortText.
- userName
Template: ShortText.
- urn:ietf:params:scim:schemas:extension:veevavault:2.0:User
Field components:
-
Uses template:
ShortText. - Contains the following components: createdBy, domainAdmin, extendedAttributes, favoriteDocNewComment, favoriteDocNewContent, favoriteDocNewStatus, globalId, inactivationDate, activationDate, lastLogin, lastModifiedBy, licenseType, lifecycle, lockedUser, productAnnouncementEmails, securityProfile, sendWelcomeEmail, systemAvailabilityEmails, systemOwnedUser.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/groups.
The result is extracted from:{{=_.pluck(response.groups, 'group')}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-groups.
- [Read auto managed] action
-
Endpoint URL address:
/objects/groups/auto.
The result is extracted from:{{=_.pluck(response.data, 'group')}}.
The result is paginated.The following request parameters will be automatically processed:
-
limit:
{{=parameters.batchSize}} -
offset:
{{=parameters.iterator}}
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-groups.
-
limit:
- [Read Single] action
-
Endpoint URL address:
/objects/groups/{{=Veeva.UI.GroupEditor.getValue(parameters)}}.
The result is extracted from:{{=_.pluck(response.groups, 'group')}}.The action has the following user-defined parameters:
- id: Required. Specify a specific group identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-group.
- [Create] action
-
Endpoint URL address:
/objects/groups.Documentation: https://developer.veevavault.com/api/24.2/#create-group.
- [Update] action
-
Endpoint URL address:
/objects/groups/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-group.
- [Delete] action
-
Endpoint URL address:
/objects/groups/{{=item.id}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-group.
- id
A key field. Data type: DT_R8
- members__v
Template: LongText. A composite field.
- active__v
Data type: DT_BOOL
- security_profiles__v
Template: LongText. A composite field.
- name__v
Template: ShortText.
- modified_by__v
Data type: DT_I4
- editable__v
Data type: DT_BOOL
- allow_delegation_among_members__v
Data type: DT_BOOL
- modified_date__v
Template: DateTime. A read-only field.
- group_description__v
Template: LongText.
- system_group__v
Data type: DT_BOOL
- label__v
Template: ShortText.
- created_date__v
Template: DateTime. A read-only field.
- type__v
Template: ShortText.
- created_by__v
Data type: DT_I4 A read-only field.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/picklists.
The result is extracted from:{{=response.picklists}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-picklists.
- name
A key field. Template: ShortText.
- label
Template: ShortText.
- kind
Template: ShortText.
- system
Data type: DT_BOOL
- usedIn
Field components:
- An array.
- Contains the following components: documentTypeName, propertyName, objectName.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/picklists/{{=Veeva.UI.PicklistEditor.getValue(parameters)}}.
The result is extracted from:{{=response.picklistValues}}.The action has the following user-defined parameters:
- picklistName: Required. Specify a specific picklist name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-picklist-values.
- [Create] action
-
Endpoint URL address:
/objects/picklists/{{=item.picklistName}}.The following request parameters will be automatically processed:
-
_item:
{{=function() { var result = {}; _.each(item,function(v, index) { var pre = 'value_' + (1); result[pre] = v; }); return result; }()}}
Documentation: https://developer.veevavault.com/api/24.2/#create-picklist-values.
-
_item:
- [Update] action
-
Endpoint URL address:
/objects/picklists/{{=item.picklistName}}/{{=item.name}}.The following request parameters will be automatically processed:
-
_item:
{{=function() { var result ={}; _.each(item,function(v, index) { result['name'] = v; }); return result; }()}}
Documentation: https://developer.veevavault.com/api/24.2/#create-picklist-values.
-
_item:
- name
A key field. Template: ShortText.
- newname
Template: ShortText.
- label
Template: ShortText.
- status
Template: ShortText.
- picklistName
A key field. Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/securitypolicies.
The result is extracted from:{{=response.security_policies__v}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-all-security-policies.
- [Read Single] action
-
Endpoint URL address:
/objects/securitypolicies/{{=parameters.securityPolicyName}}.
The result is extracted from:{{=[response.security_policy__v]}}.The action has the following user-defined parameters:
- securityPolicyName: Required. Specify a specific security policy name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-security-policy.
- name__v
A key field. Data type: DT_I4
- label__v
Template: ShortText.
- value__v
Template: ShortText.
- policy_details__v
Field components:
-
Uses template:
ShortText. - Contains the following components: name__v, label__v, is_active__v.
-
Uses template:
- policy_security_settings__v
Field components:
-
Uses template:
ShortText. - Contains the following components: authentication_type__v, passwords_require_number__v, passwords_require_uppercase_letter__v, min_password_length__v, password_expiration__v, password_history_reuse__v, require_question_on_password_reset__v, allow_delegated_auth_sfdc__v, sfdc_org_id__v.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/sandbox.
The result is extracted from:{{=response.data.active}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-sandboxes.
- [Read Single] action
-
Endpoint URL address:
/objects/sandbox/{{=parameters.sandboxName}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- sandboxName: Required. Specify a specific security policy name.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-security-policy.
- [Create] action
-
Endpoint URL address:
/objects/sandbox.Documentation: https://developer.veevavault.com/api/24.2/#create-or-refresh-sandbox.
- [Update] action
-
Endpoint URL address:
/objects/sandbox/batch/changesize.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.veevavault.com/api/24.2/#change-sandbox-size.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/objects/sandbox/{{=item.nameKey}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-sandbox.
- nameKey
A key field. Template: ShortText. The gathered value is processed with
{{=item.name}}expression.- pod
Template: ShortText.
- vault_id
Data type: DT_I4
- name
Template: ShortText.
- type
Template: ShortText.
- size
Template: ShortText.
- status
Template: ShortText.
- domain
Template: ShortText.
- dns
Template: ShortText.
- source_vault_id
Data type: DT_I4
- refresh_available
Template: DateTime.
- created_date
Template: DateTime. A read-only field.
- created_by
Data type: DT_I4
- modified_date
Template: DateTime. A read-only field.
- modified_by
Data type: DT_I4
- limits
Field components:
- An array.
- Contains the following components: name, used, allowed.
- entitlements
Field components:
- An array.
- Contains the following components: size, available, allowed, temporary.
- release
Template: ShortText.
- expiration_date
Template: DateTime.
- action
Template: ShortText. Field components:
-
Uses template:
ActionItemT. - Contains the following components: recheckUsage, setEntitlements, refreshFromSpanshot.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/objects/sandbox/snapshot.
The result is extracted from:{{=response.data.snapshots}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-sandbox-snapshots.
- [Create] action
-
Endpoint URL address:
/objects/sandbox/snapshot.Documentation: https://developer.veevavault.com/api/24.2/#create-sandbox-snapshot.
- [Update] action
-
Endpoint URL address:
/objects/sandbox/snapshot/{{=item.api_name}}/actions/update.
The action uses POST method.Documentation: https://developer.veevavault.com/api/24.2/#update-sandbox-snapshot.
- [Delete] action
-
Endpoint URL address:
/objects/sandbox/snapshot/{{=item.api_name}}.Documentation: https://developer.veevavault.com/api/24.2/#delete-sandbox-snapshot.
- api_name
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- description
Template: LongText.
- status
Template: ShortText.
- upgrade_status
Template: ShortText.
- source_sandbox
Template: ShortText.
- total_object_records
Data type: DT_I4
- document_versions
Data type: DT_I4
- vault_version
Template: ShortText.
- update_available
Template: DateTime.
- created_date
Template: DateTime. A read-only field.
- expiration_date
Template: DateTime.
- domain
Template: ShortText.
- created_by
Data type: DT_I4
- action
Template: ShortText. Field components:
- Contains the following components: upgrade.
Based on resource template VaultObject.
- [Read histories] action
-
Endpoint URL address:
/services/jobs/histories.
The result is extracted from:{{=response.jobs}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-job-histories.
- [Read monitors] action
-
Endpoint URL address:
/services/jobs/monitors.
The result is extracted from:{{=response.jobs}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-job-monitors.
- job_id
A key field. Data type: DT_I4
- title
Template: ShortText.
- status
Template: ShortText.
- created_by
Data type: DT_I4
- created_date
Template: DateTime. A read-only field.
- modified_by
Data type: DT_I4
- modified_date
Template: DateTime. A read-only field.
- run_start_date
Template: DateTime. A read-only field.
- run_end_date
Template: DateTime. A read-only field.
- statusDetails
The value is gathered from
/services/jobs/{{=item.job_id}}address. The gathered value is processed with{{=response.data}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, status, method, links, created_by, created_date, run_start_date, run_end_date.
-
Uses template:
- tasks
The value is gathered from
/services/jobs/{{=item.job_id}}/tasksaddress. The gathered value is processed with{{=response.tasks}}expression. Field components:- An array.
- Contains the following components: id, state.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/services/directdata/files.
The result is extracted from:{{=response.data}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-available-direct-data-files.
- name
A key field. Template: ShortText.
- filename
Template: ShortText.
- extract_type
Template: ShortText.
- start_time
Template: DateTime. A read-only field.
- stop_time
Template: DateTime. A read-only field.
- record_count
Data type: DT_I4
- size
Data type: DT_I4
- fileparts
Data type: DT_I4
- filepart_details
Field components:
- An array.
- Contains the following components: name, filename, filepart, size, url.
- downloadFile
Data type: DT_IMAGE The value is gathered from
/services/directdata/files/{{=item.name}}address.
Based on resource template General.
- [Read latest] action
-
The result is extracted from:{{=Veeva.exportSubmission(parameters)}}.The action has the following user-defined parameters:
- binderId: Required. Specify a specific binder identifier.
- submission: Required. Specify the id field value of the submission__v object record.
Documentation: https://developer.veevavault.com/api/24.2/#export-submission.
- [Read specific] action
-
The result is extracted from:{{=Veeva.exportSubmission(parameters)}}.The action has the following user-defined parameters:
- binderId: Required. Specify a specific binder identifier.
- majorVersion: Required. Specify a major version.
- minorVersion: Required. Specify a minor version.
- submission: Required. Specify the id field value of the submission__v object record.
Documentation: https://developer.veevavault.com/api/24.2/#export-submission.
- file
Data type: DT_IMAGE
Based on resource template General.
- [Read results] action
-
Endpoint URL address:
/vobjects/submission__v/{{=parameters.submissionId}}/actions/import/{{=parameters.jobId}}/results.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- submissionId: Required. Specify a specific submission identifier.
- jobId: Required. Specify a specific job identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-submission-import-results.
- [Create] action
-
Endpoint URL address:
/vobjects/submission__v/{{=item.submission_id}}/actions/import.Documentation: https://developer.veevavault.com/api/24.2/#import-submission.
- id
A key field. Data type: DT_I4
- file
Data type: ShortText
- major_version_number__v
Data type: DT_I4
- minor_version_number__v
Data type: DT_I4
- action
Template: ShortText. Field components:
- Contains the following components: remove, deleteLock.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vobjects/submission__v/{{=parameters.submissionId}}/actions/ectdmapping.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- submissionId: Required. Specify a specific submission identifier.
Documentation: https://developer.veevavault.com/api/24.2/#retrieve-submission-metadata-mapping.
- [Update] action
-
Endpoint URL address:
/vobjects/submission__v/{{=item.id}}/actions/ectdmapping.Documentation: https://developer.veevavault.com/api/24.2/#import-submission.
- id
A key field. Template: ShortText.
- name__v
Template: ShortText.
- external_id__v
Template: ShortText.
- drug_substance__v
Template: ShortText.
- drug_substance__v.name__v
Template: ShortText.
- xml_id
Template: ShortText.
- manufacturer__v
Template: ShortText.
- manufacturer__v.name__v
Template: ShortText.
Based on resource template General.
- [Create] action
-
Endpoint URL address:
/app/sitevault/useradmin/persons.Documentation: https://developer.veevavault.com/api/24.2/#create-user.
- [Update] action
-
Endpoint URL address:
/app/sitevault/useradmin/persons/{{=item.personid}}.Documentation: https://developer.veevavault.com/api/24.2/#edit-user.
- personid
A key field. Template: ShortText.
- user
Field components:
-
Uses template:
ShortText. - Contains the following components: email, first_name, last_name, security_policy_id, person_type, language.
-
Uses template:
- person_type
Template: ShortText.
- is_investigator
Data type: DT_BOOL
- assignments
Field components:
- Contains the following components: org_assignment, site_assignments.
- [Read] action
-
Endpoint URL address:
/query.
The result is extracted from:{{=response.data}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- statement: Required. Specify the query statement statement.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
q:
{{=parameters.statement + ' PAGESIZE ' + parameters.batchSize + (parameters.iterator ? ' PAGEOFFSET ' + parameters.iterator : '')}}
Documentation: https://developer.veevavault.com/api/24.2/#submitting-a-query.
- [External]
-
The external fields URL address:
/query. The external fields list is extracted from:{{=response.queryDescribe.fields}}.- {{=external.name}}
Template: {{=Veeva.getFieldTemplate(external.type)}}. ( length {{=external.maxLength || 255}} )
- [Read] action
-
Endpoint URL address:
/vobjects/{{=resource.external.name}}.Documentation: https://developer.veevavault.com/api/24.2/#retrieve-object-record-collection.
- [Read Single] action
-
Endpoint URL address:
/vobjects/{{=resource.external.name}}/{{=parameters.id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Required. Specify the record identifier.
- [Update] action
-
Endpoint URL address:
/vobjects/{{=resource.external.name}}.
The result is extracted from:{{=Veeva.getBatchResult(resource, batch, response.data)}}.The following request parameters will be automatically processed:
-
X-VaultAPI-MigrationMode:
{{=parameters.get('X-VaultAPI-MigrationMode')}} -
idParam:
{{=parameters.get('idParam')}} -
application/json:
{{=batch}}
Documentation: https://developer.veevavault.com/api/24.2/#update-object-records.
-
X-VaultAPI-MigrationMode:
- [Upsert] action
-
Endpoint URL address:
/vobjects/{{=resource.external.name}}.
The result is extracted from:{{=Veeva.getBatchResult(resource, batch, response.data)}}.The following request parameters will be automatically processed:
-
X-VaultAPI-MigrationMode:
{{=parameters.get('X-VaultAPI-MigrationMode')}} -
idParam:
{{=parameters.get('idParam')}} -
application/json:
{{=batch}}
Documentation: https://developer.veevavault.com/api/24.2/#create-amp-upsert-object-records.
-
X-VaultAPI-MigrationMode:
- [Delete] action
-
Endpoint URL address:
/vobjects/{{=resource.external.name}}.
The result is extracted from:{{=Veeva.getBatchResult(resource, batch, response.data)}}.The following request parameters will be automatically processed:
-
idParam:
{{=parameters.get('idParam')}} -
application/json:
{{=batch}}
Documentation: https://developer.veevavault.com/api/24.2/#delete-object-records.
-
idParam:
- auditHistory
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Log Audit History'].getData({ endpoint: 'object', parameters: ['object=' + resource.external.name, 'recordId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TemplateNode.
- attachments
A read-only field. The value is gathered from
/vobjects/{{=resource.external.name}}/{{=item.id}}/attachmentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
Attachment.
- [External]
-
The external fields URL address:
/metadata/vobjects/{{=resource.external.name}}. The external fields list is extracted from:{{=response.object.fields}}.- {{=external.name}}
Template: {{=Veeva.getFieldTemplate(external.type)}}. ( length {{=external.maxLength || 255}} )
The external resource list URL address: /metadata/vobjects.
The external resource list is extracted from: {{=response.objects}}.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
limit:
{{=parameters.batchSize}} -
offset:
{{=parameters.iterator}} -
fields:
{{=_.without(parameters.fields, 'auditHistory').join()}} -
_includeUserParameters:
{{=parameters}}
-
limit:
Based on resource template Base.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Upsert] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Read] action
-
The following request parameters will be automatically processed:
-
fields:
{{=parameters.fields.join()}} -
_includeUserParameters:
{{=parameters}}
-
fields:
- [Read Single] action
-
The following request parameters will be automatically processed:
-
fields:
{{=undefined}}
-
fields:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template General.
- [Read] action
-
The result is extracted from:{{=_.pluck(response.documents, 'document')}}.
The result is paginated.The following request parameters will be automatically processed:
-
start:
{{=parameters.iterator}} -
fields:
{{=undefined}} -
_includeUserParameters:
{{=parameters}}
-
start:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- GroupUser
Field components:
-
Uses template:
LongText. - Contains the following components: groups, users.
-
Uses template:
- DocVersion
Field components:
-
Uses template:
Number. - Contains the following components: number, value, Url.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, filename__v, format__v, size__v, md5checksum__v, version__v, created_by__v, created_date__v, versions.
-
Uses template:
- DocEvent
Field components:
-
Uses template:
ShortText. - Contains the following components: name, label, properties.
-
Uses template:
- BinderRelationship
Field components:
-
Uses template:
ShortText. - Contains the following components: id, target_major_version__v, target_minor_version__v, source_doc_id__v, relationship_type__v, target_doc_id__v, created_by__v, created_date__v.
-
Uses template:
- BinderSection
Field components:
-
Uses template:
ShortText. - Contains the following components: id, document_id__v, name__v, order__v, type__v, parent_id__v.
-
Uses template:
- TemplateNode
Field components:
-
Uses template:
ShortText. - Contains the following components: id, parent_id__v, order__v, node_type__v, label__v, number__v, type__v, subtype__v, classification__v, lifecycle__v, document_template__v.
-
Uses template:
- Prompt
Field components:
- An array.
- Contains the following components: name, label.
- CommonActionRef
Field components:
-
Uses template:
ShortText. - Contains the following components: label, required, prompts.
-
Uses template:
- WorkflowControl
Field components:
-
Uses template:
ShortText. - Contains the following components: label, type, prompts, current_values.
-
Uses template:
- WorkflowAction
Field components:
-
Uses template:
ShortText. - Contains the following components: name, label, controls.
-
Uses template:
- WorkflowTaskControl
Field components:
-
Uses template:
ShortText. - Contains the following components: label, type, verdict, reason, capacity, instructions, verdicts.
-
Uses template:
- WorkflowTaskAction
Field components:
-
Uses template:
ShortText. - Contains the following components: name, label, type, description, controls.
-
Uses template:
- ActionItemT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.