Visier Data and Job Handling API
Mock the Visier Data and Job Handling API in seconds. Visier APIs for data and job handling
[01]
About
Mock the Visier Data and Job Handling API as a turnkey Mockzilla sim with 21 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. Visier APIs for data and job handling Methods: 12x GET, 5x POST, 3x PUT, 1x DELETE. Top resource groups: DataAndJobHandling. Hit https://api.justmocks.com/visier-data-handling for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
21 across 1 resource group
Methods
GET 12 · POST 5 · PUT 3 · DEL 1 none deprecated
OpenAPI
3.0.3 spec version 22222222.99201.1256
Source spec
73 KB · YAML
[02]
Endpoints
| GET |
/v1/op/data-connector-credentials
|
Retrieve a list of all data connector credentials Use this API to retrieve a list of the connector credentials in a specified tenant. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. Mocked via Mockzilla.
|
| POST |
/v1/op/data-connector-credentials
|
Create a connector credential Use this API to create connector credentials for a specified tenant. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system.
|
| GET |
/v1/op/data-connectors
|
Retrieve a list of all data connectors Use this API to retrieve a list of the data connectors in a specified tenant. Data connectors are an alternative to generating flat files and transferring them to Visier via SFTP.
|
| POST |
/v1/op/data-connectors/assignCredentials
|
Assign connector credentials to data connectors This API allows you to assign a connector credential to a data connector.
|
| GET |
/v1/op/data-versions
|
Retrieve the latest enabled data versions for all analytic tenants If you discover any inconsistencies after running metric value validation, you may want to find the data versions causing inconsistencies so you can later disable them. Use this API to retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a single specified analytic tenant.
|
| PUT |
/v1/op/data-versions/disable
|
Disable data versions for a list of analytic tenants If you discover that a data version is not what is expected after running metric value validation on a data load, you may want to disable the data version for that processing job. Use this API to disable the latest enabled data versions for affected analytic tenants or to disable a particular data version for each analytic tenant. Note: Disabling an older data version may not have an effect on the state of the solution. Available as a Mockzilla mock endpoint.
|
| POST |
/v1/op/data/startExtractAndLoad
|
Trigger extraction jobs Use this API to generate extraction jobs for a list of analytic tenants or for the administrating tenant. This API creates a dispatching job that generates one extraction job per tenant. The extraction jobs retrieve data from your source systems through data connectors. The dispatching job is the "parent" of the extraction jobs and its job ID is returned in the response.
|
| POST |
/v1/op/data/startload
|
Start the data load for an analytic tenant This API starts the data load process for all analytic tenants included in the specified data files uploaded to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that spawn for each analytic tenant. With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status list of all related processing jobs. Prerequisite: You must first obtain Visier's public encryption key and upload the source data files to Visier's SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed. Visier provides SFTP server credentials and instructions. You can find the encryption key at https://www.visier.com/pgp/visier.public.pgp.asc. After downloading the file, open the file in a text editor or by dragging it into your browser. Note: - To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project. - For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no more than 5000 tenants are included in a batch.
|
| GET |
/v1/op/data/uploads
|
Retrieve data uploads Use this API to retrieve the data uploads and whether they're included in one of: - A list of analytic tenants managed by you. - A single specified analytic tenant. - An upload job.
|
| PUT |
/v1/op/data/uploads/exclude
|
Exclude data uploads Use this API to exclude either a specified list of data uploads or all data uploads for each analytic tenant.
|
| PUT |
/v1/op/data/uploads/include
|
Include data uploads Use this API to include either the specified list of data uploads or all data uploads for each analytic tenant. Mockzilla mock: no signup, no API key.
|
| GET |
/v1/op/job-status/jobs
|
Retrieve the statuses of all jobs Use this API to retrieve the list of statuses for all jobs.
|
| GET |
/v1/op/job-status/jobs/:jobId
|
Retrieve a specific job's status Use this API to retrieve the list of statuses for a specific job with id jobId.
|
| POST |
/v1/op/jobs/cancel
|
Cancel a list of jobs Use this API to cancel a list of processing jobs, upload jobs, receiving jobs, and extraction jobs. Note: Receiving jobs with the Running status cannot be cancelled.
|
| GET |
/v1/op/jobs/dispatching-jobs/:jobId
|
Retrieve a dispatching job's status Use this API to retrieve the status of a dispatching job, including its job ID and the number of jobs it generated.
|
| GET |
/v1/op/jobs/dispatching-jobs/:jobId/extraction-jobs
|
Retrieve a dispatching job's extraction jobs with their statuses Use this API to retrieve the statuses of extraction jobs associated with a dispatching job. The dispatching job is a "parent" to extraction jobs, which retrieve data from your source systems through data connectors. Served by the Mockzilla mock runtime.
|
| GET |
/v1/op/jobs/dispatching-jobs/:jobId/processing-jobs
|
Retrieve a dispatching job's processing jobs with their statuses Use this API to retrieve the statuses of processing jobs associated with a dispatching job. The dispatching job is a "parent" to extraction jobs, which in turn generate processing jobs and receiving jobs.
|
| GET |
/v1/op/jobs/dispatching-jobs/:jobId/receiving-jobs
|
Retrieve a dispatching job's receiving jobs with their statuses Use this API to retrieve the statuses of receiving jobs associated with a dispatching job. The dispatching job is a "parent" to extraction jobs, which in turn generate processing jobs and receiving jobs.
|
| GET |
/v1/op/jobs/processing-jobs/:receivingJobId
|
Retrieve processing job statuses by receiving job ID Use this API to retrieve a list of statuses for all processing jobs associated with the given receiving job ID. Processing jobs deal with an individual analytic tenant's data load. A processing job is either triggered through the UI or is one of many processing jobs spawned from a receiving job. When a processing job is triggered as part of a set from an receiving job, it is associated to the receiving job through a Parent ID.
|
| GET |
/v1/op/jobs/receiving-jobs/:receivingJobId
|
Retrieve a receiving job's status After sending data to Visier, you may want to know the status of the receiving job and the associated tenant receiving jobs. A receiving job validates the transferred data and adds the transferred data to Visier's data store. Use this API to retrieve the receiving job status and summary of analytic tenant receiving jobs.
|
| DEL |
/v1/op/data-connector-credentials/:id
|
Delete a connector credential Use this API to delete connector credentials from your tenants. Credentials that are no longer valid should be deleted. Mocked via Mockzilla.
|