Data Intake API
Send your raw data files to Visier and let us take care of the rest.
Note:
- Limited Availability This feature is in limited availability. If you're interested, please contact your Customer/Partner Success Manager.
- To send raw data to Visier, we recommend the Data Upload API because it is simpler than the Data Intake API. For example, the Data Intake API uses three API calls to send data to Visier, whereas the Data Upload API uses one API call. For more information, see Data Upload API.
Who can use this feature?
To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.
In addition to an API profile, your API user must have a profile with the following capabilities:
- Data: Write (access level), Simple (view level)
- Model: Write (access level), Simple (view level)
- Manage Jobs
- Data Upload
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
If your data requires transformations to work with Visier, you can use the Data Intake API to send raw data to Visier. To use this API, your Visier solution must contain existing mappings and rules. After we receive the data, Visier runs business rules to transform your data into the expected format for the existing mappings.
To send data files using the API, the data files must be in a location that your API application can access. If using Postman, the data files you want to upload must be in Postman's files folder on your local device. For more information, see "Working directory" in Setting up Postman.
Use the Data Intake API to send multiple files from your source system without compressing them into a ZIP file. Because the API uses transfer sessions, you can send portions of data in multiple API calls and then initiate the receiving job in an additional API call when you're finished sending data. Optionally, define the parameter processingData: true in the Complete a transfer session endpoint to start a processing job after the receiving job successfully completes. However, we encourage you to use the Data Upload API for sending raw data to Visier because it's simpler. For example, the Data Intake API requires at least three API calls to send data to Visier, whereas the Data Upload API only uses one API call. For more information, see Data Upload API.
With this API, you can:
- Retrieve a list of the sources in Visier so you know what kind of data you can send.
- Start a transfer session through which to send data to Visier.
- Transfer data to Visier in JSON, CSV, or ZIP format.
- Complete a transfer session to trigger a data receiving job in Visier.
Note: Filenames can contain letters (A-Z, a-z), numbers (0-9), hyphens (-), periods (.), and underscores (_).
To specify a single tenant to send data to, use TargetTenantID. To send data for many tenants in the same request, use tenantCode.
- The
TargetTenantIDrequest header defines the tenant that you're logged into. If defined, the API call executes from the specified tenant. If omitted, the default is the administrating tenant. - The
tenantCodeparameter defines the tenant to make changes to. In APIs that support many tenant codes, specify eachtenantCodeand omitTargetTenantID.
For more information about whether TargetTenantID or tenantCode is supported in an endpoint, see API Reference.