openapi: 3.2.0
info:
title: Visier Data In Data And Job Handling API
description: Visier APIs for sending data to Visier and running data load jobs.
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 22222222.99201.3040
security:
- ApiKeyAuth: []
BearerAuth: []
- ApiKeyAuth: []
CookieAuth: []
- ApiKeyAuth: []
OAuth2Auth: []
tags:
- name: DataAndJobHandling
x-displayName: Data and Job Handling
description: Initiate and manage jobs, included or excluded data, and data connector credentials. Administrating tenant users can manage jobs and data for their analytic tenants.
paths:
/v1/op/data-connector-credentials:
get:
tags:
- DataAndJobHandling
summary: Retrieve a list of all data connector credentials
description: "Retrieve a list of the connector credentials in a specified tenant. Connector credentials allow\n Visier to retrieve data from your source systems through an integration user in the source system."
operationId: DataAndJobHandling_DataConnectorCredentials
parameters:
- name: tenantCode
in: query
description: The tenant code of a specific analytic tenant that you want to retrieve for.
schema:
type: string
- name: limit
in: query
description: The limit to retrieve.
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/designer.ExtractorCredentialsAPIDTO'
post:
tags:
- DataAndJobHandling
summary: Create a connector credential
description: "Create credentials for a data connector. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. \n \n In the request body, specify one data provider in the `dataProviderAuthParams` parameter. For example, to create connector credentials for a UKG data connector, your request body might look like the following sample.\n ```json\n {\n model={\n \"dataProviderAuthParams\": {\n \"provider\": \"UKG\",\n \"ultimateAuthParams\": {\n \"hostDomainName\": \"exampleHostDomain\",\n \"apiKey\": \"apiKey1234\",\n \"username\": \"username1234\",\n \"password\": \"password1234\",\n \"userAccessKey\": \"accessKey1234\"\n }\n },\n \"dataProviderBasicInformation\": {\n \"displayName\": \"exampleDisplayName\",\n \"description\": \"exampleDescription\"\n }\n }\n ```"
operationId: DataAndJobHandling_CreateConnectorCredential
parameters:
- name: tenantCode
in: query
description: The tenant code of a specific analytic tenant that you want to create the credential for.
schema:
type: string
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/designer.DataProviderAuthInformationDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/designer.CredentialCreationAPIResponseDTO'
/v1/op/data-connectors:
get:
tags:
- DataAndJobHandling
summary: Retrieve a list of all data connectors
description: "Retrieve a list of the data connectors in a specified tenant. Data connectors are an alternative\n to generating flat files and transferring them to Visier via SFTP."
operationId: DataAndJobHandling_DataConnectors
parameters:
- name: tenantCode
in: query
description: The tenant code of a specific analytic tenant that you want to retrieve for.
schema:
type: string
- name: limit
in: query
description: The limit to retrieve.
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.data.ImportDefinitionsAPIDTO'
/v1/op/data-connectors/assignCredentials:
post:
tags:
- DataAndJobHandling
summary: Assign connector credentials to data connectors
description: Assign a connector credential to a data connector.
operationId: DataAndJobHandling_AssignConnectorCredential
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.AssignConnectorCredentialRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.AssignConnectorCredentialsResponseDTO'
/v1/op/data-connectors/connector-settings:
get:
tags:
- DataAndJobHandling
summary: Retrieve data connector settings
description: Get a list of settings for all data connectors. This request retrieves data connectors from the production environment. The response returns a list of settings, if available, for each data connector in the tenant.
operationId: DataAndJobHandling_ListConnectorSettings
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ExtractorSettingsAPIDTO'
put:
tags:
- DataAndJobHandling
summary: Update data connector settings
description: Define the settings for one or more data connectors. To find the available settings, see `Retrieve data connector settings`.
operationId: DataAndJobHandling_SetConnectorSetting
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.SetConnectorSettingsRequestDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.SetConnectorSettingsResponseDTO'
/v1/op/data-versions:
get:
tags:
- DataAndJobHandling
summary: Retrieve the latest enabled data versions for all analytic tenants
description: "If you discover any inconsistencies after running metric value validation, you may want to find the data versions\n causing inconsistencies so you can later disable them.\n\n Retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a\n single specified analytic tenant."
operationId: DataAndJobHandling_LatestEnabledDV
parameters:
- name: tenantCode
in: query
description: "The tenant code of a specific analytic tenant that you want to retrieve data versions for.\n Use this if you are only interested in the results for one analytic tenant."
schema:
type: string
- name: limit
in: query
description: "The limit of analytic tenants to retrieve data versions for.\n This parameter is not used if the tenantCode parameter is specified."
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: numberOfVersions
in: query
description: The number of latest enabled data versions to retrieve. The maximum value is 5.
schema:
type: integer
format: int32
- name: dataCategory
in: query
description: "The object name of the data category. Default is the primary data category.\n For administrating tenants, the data category must exist in the requesting tenant; that is, the administrating tenant or the tenant specified in `TargetTenantID`."
schema:
type: string
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.MultipleTenantDataVersionsListDTO'
/v1/op/data-versions/disable:
put:
tags:
- DataAndJobHandling
summary: Disable data versions for a list of analytic tenants
description: "If you discover that a data version is not what is expected after running metric value validation on a data load,\n you may want to disable the data version for that processing job.\n\n Disable the latest enabled data versions for affected analytic tenants or to disable a particular\n data version for each analytic tenant.\n\n **Note:** Disabling an older data version may not have an effect on the state of the solution."
operationId: DataAndJobHandling_DisableDV
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.DisableDVRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.DisableDVResponse'
/v1/op/data/categories:
get:
tags:
- DataAndJobHandling
summary: Retrieve a list of all data categories
description: Retrieve a list of all available data categories.
operationId: DataAndJobHandling_RetrieveDataCategories
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.DataCategoriesResponseDTO'
/v1/op/data/startExtractAndLoad:
post:
tags:
- DataAndJobHandling
summary: Trigger data connector extraction jobs
description: "Run data connector extraction jobs for the administrating tenant or a list of analytic tenants.\n \n This API creates a dispatching job that generates one extraction job per tenant. The dispatching job is the \"parent\" of the extraction jobs and the dispatching job ID is returned in the response. Use that ID to monitor the extraction job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs`.\n\n The extraction job generates receiving jobs to validate the data and processing jobs to populate data in the analytic tenants. Use the dispatching job ID to monitor the receiving and processing job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs` or `GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs`."
operationId: DataAndJobHandling_StartExtraction
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.jobs.ExtractDataAndLoadDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.StartExtractionResponse'
/v1/op/data/startload:
post:
tags:
- DataAndJobHandling
summary: Start the data load for analytic tenants
description: "This API starts the data load process for all analytic tenants included in the specified data files uploaded\n to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the\n Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that\n spawn for each analytic tenant.\n\n With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status\n list of all related processing jobs.\n\n **Prerequisite:** You must first obtain a PGP public encryption key and upload the source data files to Visier's\n SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed.\n\n Visier provides ways to generate PGP key pairs and download the public key to encrypt your data files. You can either use\n the PGP Keys API or, in Visier, navigate to **Settings > Manage PGP Keys**.\n\n **Note:**\n - To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project.\n - For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no\n more than 5000 tenants are included in a batch."
operationId: DataAndJobHandling_StartLoad
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.DataLoadRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.DataLoadResponse'
/v1/op/data/uploads:
get:
tags:
- DataAndJobHandling
summary: Retrieve data uploads
description: "Retrieve the data uploads and whether they're included in one of:\n - A list of analytic tenants managed by you.\n - A single specified analytic tenant.\n - A receiving job."
operationId: DataAndJobHandling_RetrieveDataUploads
parameters:
- name: uploadJobId
in: query
description: The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job.
schema:
type: string
- name: tenantCode
in: query
description: The tenant code of a specific analytic tenant that you want to retrieve the data uploads for.
schema:
type: integer
format: int32
- name: limit
in: query
description: The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000.
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: numberOfDataUploads
in: query
description: The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.TenantDataUploadsListResponseDTO'
/v1/op/data/uploads/exclude:
put:
tags:
- DataAndJobHandling
summary: Exclude data uploads
description: Exclude either a specified list of data uploads or all data uploads for each analytic tenant.
operationId: DataAndJobHandling_ExcludeDataUplaods
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.ExcludeDataUploadsRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.TenantDataUploadsUpdateResponseDTO'
/v1/op/data/uploads/include:
put:
tags:
- DataAndJobHandling
summary: Include data uploads
description: Include either the specified list of data uploads or all data uploads for each analytic tenant.
operationId: DataAndJobHandling_IncludeDataUploads
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.IncludeDataUploadsRequest'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.TenantDataUploadsUpdateResponseDTO'
/v1/op/job-status/jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve the statuses of all jobs
description: Retrieve the list of statuses for all jobs.
operationId: DataAndJobHandling_JobStatus
parameters:
- name: startTime
in: query
description: The start time from which to retrieve job statuses.
schema:
type: string
- name: endTime
in: query
description: The end time from which to retrieve job statuses.
schema:
type: string
- name: status
in: query
description: The specific status to restrict the list of jobs to.
schema:
type: string
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.JobStatusListResponse'
/v1/op/jobs/cancel:
post:
tags:
- DataAndJobHandling
summary: Cancel a list of jobs
description: "Cancel a list of processing jobs, receiving jobs, and extraction jobs.\n\n **Note:** Receiving jobs with the Running status cannot be cancelled."
operationId: DataAndJobHandling_CancelJobs
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.CancelJobBatchFromJobIdDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/dp.JobCancellationResultsDTO'
/v1/op/jobs/dispatching-jobs/{jobId}:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's status
description: Retrieve the status of a dispatching job, including its job ID and the number of jobs it generated.
operationId: DataAndJobHandling_DispatchingJobStatus
parameters:
- name: jobId
in: path
description: The ID of the job you want to retrieve.
required: true
schema:
type: string
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.DispatchingJobStatusResponse'
/v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's extraction jobs with their statuses
description: "Retrieve the statuses of extraction jobs associated with a dispatching job. The dispatching job\n is a \"parent\" to extraction jobs, which retrieve data from your source systems through data connectors."
operationId: DataAndJobHandling_ExtractionJobAndStatus
parameters:
- name: jobId
in: path
description: The ID of the dispatching job you want to retrieve.
required: true
schema:
type: string
- name: dispatchingJobId
in: query
description: The ID of the dispatching job that generated the extraction jobs.
schema:
type: string
- name: tenantCode
in: query
description: "The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for.\n Use this if you are only interested in the results for one analytic tenant."
schema:
type: string
- name: limit
in: query
description: The limit of extraction job statuses to retrieve.
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.ExtractionJobAndStatusResponse'
/v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's processing jobs with their statuses
description: "Retrieve the statuses of processing jobs associated with a dispatching job. The dispatching job\n is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs."
operationId: DataAndJobHandling_ProcessingJobAndStatus
parameters:
- name: jobId
in: path
description: The ID of the dispatching job you want to retrieve.
required: true
schema:
type: string
- name: dispatchingJobId
in: query
description: The ID of the dispatching job that generated the extraction jobs.
schema:
type: string
- name: tenantCode
in: query
description: "The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for.\n Use this if you are only interested in the results for one analytic tenant."
schema:
type: string
- name: limit
in: query
description: The limit of extraction job statuses to retrieve.
schema:
type: integer
format: int32
- name: start
in: query
description: The index to start retrieving results from, also known as offset. The index begins at 0.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/data_in.ProcessingJobAndStatusResponse'
/v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs:
get:
tags:
- DataAndJobHandling
summary: Retrieve a dispatching job's receiving jobs with their statuses
description: "Retrieve the statuses of receiving jobs associated with a dispatching job. The dispatching job\n is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs."
operationId: DataAndJobHandling_ReceivingJobAndStatus
parameters:
- name: jobId
in: path
description: The ID of the dispatching job you want to retrieve.
required: true
schema:
type: string
- name: dispatchingJobId
in: query
description: The ID of the dispatching job that generated the extraction jobs.
schema:
type: string
- name: tenantCod
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visier/refs/heads/main/openapi/visier-dataandjobhandling-api-openapi.yml