diff --git a/res/administration-apis.yaml b/res/administration-apis.yaml index 1824b38..2b36c13 100644 --- a/res/administration-apis.yaml +++ b/res/administration-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1447 + version: 22222222.99201.1448 paths: /v1/admin/capabilities: get: diff --git a/res/analytic-model-apis.yaml b/res/analytic-model-apis.yaml index e781a48..5abbbc1 100644 --- a/res/analytic-model-apis.yaml +++ b/res/analytic-model-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1447 + version: 22222222.99201.1448 paths: /v1/admin/calculation-concepts: get: diff --git a/res/authentication-apis.yaml b/res/authentication-apis.yaml index 5d40d60..109dec5 100644 --- a/res/authentication-apis.yaml +++ b/res/authentication-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1447 + version: 22222222.99201.1448 paths: /v1/auth/oauth2/userinfo: get: diff --git a/res/data-in-apis.yaml b/res/data-in-apis.yaml index 32629f2..605d043 100644 --- a/res/data-in-apis.yaml +++ b/res/data-in-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1447 + version: 22222222.99201.1448 paths: /v1/data/directloads/{draftId}/configs: get: @@ -1276,12 +1276,12 @@ paths: summary: Run a consolidated analytics job description: Run a job for a consolidated analytics tenant. This request retrieves data for all source tenants in a consolidated analytics tenant. After the job completes, you can run a processing job to generate a data version for the consolidated analytics tenant. To run a processing job, see `POST /v1alpha/op/jobs/processing-jobs`. operationId: DataAndJobHandling_AdhocConsolidatedAnalyticsJob - parameters: - - name: tenantCode - in: query - description: The tenant code of the consolidated analytics tenant; for example, "WFF_j1r~CAa7s". - schema: - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolidatedAnalyticsJobRequestDTO' + required: true responses: "200": description: OK @@ -1302,87 +1302,14 @@ paths: summary: Run a data connector extraction job description: |- Run an extraction job to retrieve data through a Visier data connector and generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. - If running extraction jobs for an administating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. + If running extraction jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. operationId: DataAndJobHandling_AdhocExtractionJob - parameters: - - name: tenants - in: query - description: The unique IDs of the tenants to run an extraction job for. - schema: - type: array - items: - type: string - - name: allTenants - in: query - description: If "true", runs an extraction job for all tenants and ignores the tenants field. - schema: - type: boolean - - name: overrideLastExtractionTimestamp - in: query - description: An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data. - schema: - type: string - - name: publishDataLoadArtifacts - in: query - description: If "true", publishes the project to production. - schema: - type: boolean - - name: runProcessingJob - in: query - description: If "true", runs a processing job to generate a data version after the extraction job succeeds. - schema: - type: boolean - - name: dataCategoryId - in: query - description: The unique ID of the data category in which to generate objects. - schema: - type: string - - name: disableArtifactGeneration - in: query - description: If "true", doesn't generate objects after the extraction jobs succeeds. - schema: - type: boolean - - name: connectorIds - in: query - description: The unique IDs of the connectors to run extraction jobs for. - schema: - type: array - items: - type: string - - name: lastExtractionTimeOffsetWeeks - in: query - description: The number of weeks from which to retrieve data. This overrides the last extraction date to retrieve more data. - schema: - type: integer - format: int32 - - name: monthsToExtract - in: query - description: The number of months to retrieve snapshot data from. - schema: - type: integer - format: int32 - - name: extractToTimeOverride - in: query - description: An epoch timestamp in milliseconds for the end time up to which to retrieve data. - schema: - type: string - - name: batchSizeOverride - in: query - description: The maximum amount of IDs the job can retrieve in each batch. - schema: - type: integer - format: int32 - - name: sqlBatchSize - in: query - description: The maximum amount of SQL table records the job can retrieve in each batch. - schema: - type: integer - format: int32 - - name: forceUpdateExistingArtifacts - in: query - description: If "true" and `disableArtifactGeneration` is "false", updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if `disableArtifactGeneration` is "true". - schema: - type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtractDataAndLoadDTO' + required: true responses: "200": description: OK @@ -1403,33 +1330,14 @@ paths: summary: Run a processing job description: |- Run a processing job to generate a new data version. Administrating tenants can run processing jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. - If running processing jobs for an administating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. + If running processing jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. operationId: DataAndJobHandling_AdhocProcessingJobs - parameters: - - name: tenants - in: query - description: The tenant codes of the tenants to run processing jobs for. If omitted, runs a processing job for the tenant associated with the user who made the API request. - schema: - type: array - items: - type: string - - name: allTenants - in: query - description: If `true`, runs processing jobs for all accessible analytic tenants. Default is `false`. - schema: - type: boolean - - name: dataCategoryId - in: query - description: |- - The unique identifier of the data category to run the job. If omitted, runs a job using the primary data category. - To retrieve a list of all data categories, see `GET /v1/op/data/categories`. - schema: - type: string - - name: publishToProduction - in: query - description: If `true`, publishes the generated data version to production. Default is `false`. - schema: - type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessingJobRequestDTO' + required: true responses: "200": description: OK @@ -1724,6 +1632,12 @@ components: description: An identifiable data connector name that is displayed within Visier. description: type: string + ConsolidatedAnalyticsJobRequestDTO: + type: object + properties: + tenantCode: + type: string + description: The tenant code of the consolidated analytics tenant; for example, "WFF_j1r~CAa7s". CopyS3AuthParamsDTO: type: object properties: @@ -2173,6 +2087,59 @@ components: allOf: - $ref: '#/components/schemas/UploadToExcludeModel' description: A form body key that contains a collection of key-value pairs. + ExtractDataAndLoadDTO: + type: object + properties: + tenants: + type: array + items: + type: string + description: The unique IDs of the tenants to run an extraction job for. + allTenants: + type: boolean + description: If "true", runs an extraction job for all tenants and ignores the tenants field. + overrideLastExtractionTimestamp: + type: string + description: An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data. + publishDataLoadArtifacts: + type: boolean + description: If "true", publishes the project to production. + runProcessingJob: + type: boolean + description: If "true", runs a processing job to generate a data version after the extraction job succeeds. + dataCategoryId: + type: string + description: The unique ID of the data category in which to generate objects. + disableArtifactGeneration: + type: boolean + description: If "true", doesn't generate objects after the extraction jobs succeeds. + connectorIds: + type: array + items: + type: string + description: The unique IDs of the connectors to run extraction jobs for. + lastExtractionTimeOffsetWeeks: + type: integer + description: The number of weeks from which to retrieve data. This overrides the last extraction date to retrieve more data. + format: int32 + monthsToExtract: + type: integer + description: The number of months to retrieve snapshot data from. + format: int32 + extractToTimeOverride: + type: string + description: An epoch timestamp in milliseconds for the end time up to which to retrieve data. + batchSizeOverride: + type: integer + description: The maximum amount of IDs the job can retrieve in each batch. + format: int32 + sqlBatchSize: + type: integer + description: The maximum amount of SQL table records the job can retrieve in each batch. + format: int32 + forceUpdateExistingArtifacts: + type: boolean + description: If "true" and `disableArtifactGeneration` is "false", updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if `disableArtifactGeneration` is "true". ExtractionJob: type: object properties: @@ -2419,10 +2386,7 @@ components: properties: jobId: type: string - description: |- - * @exclude - Response for requests with `jobId` as key to maintain compatibility with legacy APIs. - Future APIs returning a UUID should return `UUIDResponse`. + description: The unique identifier of the returned job. JobStatusListResponse: type: object properties: @@ -2584,6 +2548,25 @@ components: items: $ref: '#/components/schemas/ProcessingJob' description: A list of processing job information. + ProcessingJobRequestDTO: + type: object + properties: + tenants: + type: array + items: + type: string + description: The tenant codes of the tenants to run processing jobs for. If omitted, runs a processing job for the tenant associated with the user who made the API request. + allTenants: + type: boolean + description: If `true`, runs processing jobs for all accessible analytic tenants. Default is `false`. + dataCategoryId: + type: string + description: |- + The unique identifier of the data category to run the job. If omitted, runs a job using the primary data category. + To retrieve a list of all data categories, see `GET /v1/op/data/categories`. + publishToProduction: + type: boolean + description: If `true`, publishes the generated data version to production. Default is `false`. ProcessingJobStatusResponse: type: object properties: diff --git a/res/data-out-apis.yaml b/res/data-out-apis.yaml index c9e1cad..3971e19 100644 --- a/res/data-out-apis.yaml +++ b/res/data-out-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1447 + version: 22222222.99201.1448 paths: /v1/data/query/aggregate: post: