Veeva connection actions and objects

• •The Get Session ID action authenticates the account using your Vault user name and password to get a Vault session ID. The action returns a SessionId that is required to authenticate subsequent Veeva Connector actions.
To use this action, specify the Vault username and password as input parameters.
The following snippet is a sample response:
<VersionedAuthRestResult xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd">
<responseStatus>SUCCESS</responseStatus>
<sessionId>C22891F9D8F97B053A96A85FD45A07B2470E7159EB6295172FF719A04FB3425BFC807375F4D238E01723D71C693D457693B07017FF8</sessionId>
<userId>22222</userId>
<vaultIds>
<vault>
<id>22222</id>
<name>vaultcrm01</name>
<url>https://domain.veevavault.com/api</url>
</vault>
</vaultIds>
<vaultId>222222</vaultId>
</VersionedAuthRestResult>
• •The Get Version List action retrieves a list of supported versions of the Vault REST API.
To retrieve a list of supported versions, specify the SessionId to authenticate the request.
The following snippet is a sample response:
<MapRestResult xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd">
<responseStatus>SUCCESS</responseStatus>
<values>
<v23.1>https://vvtechpartner-informatica.veevavault.com/api/v23.1</v23.1>
<v23.2>https://vvtechpartner-informatica.veevavault.com/api/v23.2</v23.2>
<v23.3>https://vvtechpartner-informatica.veevavault.com/api/v23.3</v23.3>
<v24.1>https://vvtechpartner-informatica.veevavault.com/api/v24.1</v24.1>
<v24.2>https://vvtechpartner-informatica.veevavault.com/api/v24.2</v24.2>
<v24.3>https://vvtechpartner-informatica.veevavault.com/api/v24.3</v24.3>
</values>
</MapRestResult>
• •The Retrieve Objects action retrieves objects, vault object records, documents, attachments, and object metadata.
To use this action, specify the following details:
• - SessionId to authenticate the request.
• - Entity type and required segments to construct a proper GET URL according to the Veeva documentation.
• - QueryParam input field to specify URL query key-value pairs.
• - Accept the input field to specify the content type of the request according to the Veeva documentation. Default is application/json.
The following snippet is a sample response:
<root>
<metadata>
<objects>
<name>state</name>
<description>Lifecycle State</description>
<properties>
<name>name v</name>
<type>string</type>
</properties>
<properties>
<minValue>1</minValue>
<onCreateEditable>true</onCreateEditable>
<maxValue>60</maxValue>
<editable>true</editable>
<name>label_v</name>
<description>Lifecycle state name</description>
<type>string</type>
<required>true</required>
</properties>
</objects>
</metadata>
<responseStatus>SUCCESS</responseStatus>
<responseMessage>Success</responseMessage>
</root>
• •The Create Object action creates and upserts vault object records. You must use the entity type and segments to construct the correct URL request.
The following snippet is a sample of the Create Object action's rawData input field:
<root>
<records>
<id>604</id>
<minor_version_number__v>1</minor_version_number__v>
<major_version_number____v>0</major_version_number____v>
</records>
</root>
The following snippet is a sample response:
<root>
<job_id>131513</job_id>
<responseStatus>SUCCESS</responseStatus>
<url>/api/v24.2/services/jobs/131513</url>
</root>
• •The Update Object action updates Vault object records and attachment descriptions. You must use the entity type and segments to construct the correct URL request.
The following snippet is a sample response:
<root>
<data>
<data>
<id>VAL000000003044</id>
<url>/api/v24.2/vobjects/product_v/VAL000000003044</url>
</data>
<responseStatus>SUCCESS</responseStatus>
</data>
<responseStatus>SUCCESS</responseStatus>
</root>
• •The Delete Object action deletes vault object records, object attachments, documents, and document attachments. You must use the entity type and segments to construct the correct URL request.
The following snippet is a sample of the Delete Object action's rawData input field:
<root>
<records>
<id>VAL000000003044</id>
</records>
</root>
The following snippet is a sample response:
<root>
<data>
<data>
<id>VAL000000003044</id>
</data>
<responseStatus>SUCCESS</responseStatus>
</data>
<responseStatus>SUCCESS</responseStatus>
</root>
• •The Create Object Attachment action creates a vault object attachment. You must use the entity type and segments to construct the correct URL request and the file field to specify the attachment.
The following snippet is a sample response:
<root>
<data>
<version__v>1</version__v>
<id>622</id>
</data>
<responseStatus>SUCCESS</responseStatus>
</root>
• •The Post Object with Form action posts a vault object using x-www-form-urlencoded Content-Type.
The following snippet is a sample response:
<DocumentPropertiesRestResult xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd">
<responseStatus>SUCCESS</responseStatus>
<properties>
<property>
<name>batch_number_v</name>
<scope>DocumentVersion</scope>
<type>ObjectReference</type>
<required>false</required>
<repeating>true</repeating>
<systemAttribute>true</systemAttribute>
<editable>true</editable>
<setOnCreateOnly>false</setOnCreateOnly>
<disabled>false</disabled>
<objectType>batch__v</objectType>
<label>Batch Number</label>
</property>
</properties>
</DocumentPropertiesRestResult>
• •The Submit Query action sends a query with the object to query, the fields to retrieve from that object, and the filters to determine whether a given object must be queried.
The action constructs and executes queries using Vault Query Language (VQL). You must use the paginationId, pagesize, and pageoffset input fields for pagination.
The following snippet is a sample of the Submit Query action's q input field:
SELECT id FROM product__v PAGESIZE 5 PAGEOFFSET 10
The following snippet is a sample response:
<VqlQueryRestResult xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd">
<warnings>
<warning>
<type>MANUAL_PAGINATION</type>
<message>Manual pagination detected. Use previous_page/next_page instead.</message>
</warning>
</warnings>
<responseDetails>
<next_page>/api/v24.2/query/ced263f0-91f7-4129-afa3-e5867c544171?pagesize=2&pageoffset=15</next_page>
<pageoffset>10</pageoffset>
<pagesize>5</pagesize>
<previous_page>/api/v24.2/query/ced263f0-91f7-4129-afa3-e5867c544171?pagesize=5&pageoffset=5</previous_page>
<size>5</size>
<total>39</total>
</responseDetails>
<data>
<row>
<id>VAL000000008005</id>
</row>
<row>
<id>VAL000000008006</id>
</row>
</data>
</VqlQueryRestResult>
• •The Create Document action creates a Veeva document record using the .csv file as an attachment.
The following snippet is a sample response:
<IdRestResult xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd">
<responseStatus>SUCCESS</responseStatus>
<responseMessage>successfully created document</responseMessage>
<id>623</id>
</IdRestResult>
• •The Update Document action updates a Veeva document record. You must specify values for the fields to be updated.
The following snippet is a sample response:
<root>
<id>623</id>
<responseStatus>SUCCESS</responseStatus>
</root>
• •The Delete Document action deletes a Veeva document record. You must specify the document_id field of the document to be deleted.
The following snippet is a sample response:
<root>
<id>623</id>
<responseStatus>SUCCESS</responseStatus>
</root>