Turbo Data Sync APIs

{ "openapi": "3.0.1", "info": { "description": "## Basics\n\nThe Turbo Data Sync API follows a microservice architecture that enables CPQ into any part of an application and is built on the [JSON API](https://jsonapi.org/ \"https://jsonapi.org/\") specification, follows predictable [REST](https://en.wikipedia.org/wiki/Representational_state_transfer \"https://en.wikipedia.org/wiki/Representational_state_transfer\") URLs and supports [cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing \"https://en.wikipedia.org/wiki/Cross-origin_resource_sharing\").\n\n## Authentication\n\nAll requests to the API need to be accompanied by an authorization header with a standard salesforce authentication token\n\n Authorization: Bearer 00D230000000nZM!ARMAQHLLm33JxYYP.UJn1gF6FFmLv8sDYK_8szeckHWtbguztoBpF0HL8...\n\n## Versions\n\nThe Turbo Data Sync API ensures backward compatibility by properly versioning any changes to the APIs. When a change to the API structure is required, it will occur within a new version and older functionality will be preserved.\n\n## X-Storefront Header Parameter\n\nIn order to match your API requests with a storefront, the x-storefront parameter must be used with all requests in the request header. It should match a storefront name record in SFDC.\n\n x-storefront: my-storefront`\n\n\n## Content Type\n\nRequests made to the API must be encoded as **JSON** and contain the header\n\n Content-Type: application/json\n\n## Includes\n\nYou can easily include resource relationships on most top-level resources. Multiple includes are defined using comma delimited values.\n\n## Caching\n\nServer-side caching is used and can be configured based on request using the cacheStrategy query parameter.\n\n## Errors\n\nAny request that returns an error follows a standard format. The Turb Data Sync API will return an array of errors that contain objects containing the status, title and data with the error details.\n\n|**Code**|**Response**|\n|--|--|\n| 201 | Created Successfully |\n| 200 | Updated Successfully |\n| 204 | Deleted Successfully |\n| 400 | Invalid JSON |\n| 422 | Validation Error |\n| 500 | Something went wrong on our end |",    "title": "Apttus.Lightsaber.DataIntegrationServices.Api", "version": "v1" }, "paths": { "/ds/api/dataintegration/v1/Configuration/{name}": { "get": { "tags": [ "Configuration" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false } } } } } } }, "post": { "tags": [ "Configuration" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DISConfiguration" } } } } } } }, "/ds/api/dataintegration/v1/ConsumerConfiguration/{consumerName}": { "get": { "tags": [ "ConsumerConfiguration" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "ConsumerConfiguration" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "importDIS_Configuration", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FileData": { "type": "string", "format": "binary", "nullable": true } } }, "encoding": { "FileData": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/ConsumerConfiguration/consumerBulkSyncEnabledSyncActions/{consumerName}": { "get": { "tags": [ "ConsumerConfiguration" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerBulkSyncEnabledSyncActionsAPIModel" } } } } } }, "put": { "tags": [ "ConsumerConfiguration" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerBulkSyncEnabledSyncActionsAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/ConsumerProfile": { "post": { "tags": [ "ConsumerProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConsumerProfile" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfile" } } } } } }, "put": { "tags": [ "ConsumerProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseConsumerProfileAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BaseConsumerProfileAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BaseConsumerProfileAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfileAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/ConsumerProfile/{consumerName}": { "get": { "tags": [ "ConsumerProfile" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfileAPIModel" } } } } } }, "delete": { "tags": [ "ConsumerProfile" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/ConsumerGroup/{groupName}/ConsumerProfiles": { "get": { "tags": [ "ConsumerProfile" ], "parameters": [ { "name": "groupName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumerProfileListAPIModel" } } } } } } } }, "/ds/api/dataintegration/v1/ConsumerProfile/{consumerName}/statistics": { "get": { "tags": [ "ConsumerProfile" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordCountAPIModel" } } } } } } } }, "/ds/api/dataintegration/v1/ConsumerProfile/{consumerName}/{entity}": { "delete": { "tags": [ "ConsumerProfile" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entity", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/ConsumerProfile/ToggleProfile": { "post": { "tags": [ "ConsumerProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleConsumerProfileAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ToggleConsumerProfileAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ToggleConsumerProfileAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerProfileAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/ConsumerProfileSync/run": { "get": { "tags": [ "ConsumerProfileSync" ], "parameters": [ { "name": "consumerName", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/DataCleanup/GetDataCleanupResults": { "get": { "tags": [ "DataCleanup" ], "parameters": [ { "name": "dataCleanupExecutionId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCleanupResults" } } } } } } }, "/ds/api/dataintegration/v1/DataCleanup": { "delete": { "tags": [ "DataCleanup" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/DataSync/run/{consumerName}/{forceSync}": { "get": { "tags": [ "DataSync" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "forceSync", "in": "path", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSynRunAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/DataSync/runentitysync/{consumerName}": { "post": { "tags": [ "DataSync" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Debug/{collectionName}/{recordsToSkip}": { "post": { "tags": [ "Debug" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "recordsToSkip", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "nullable": true } }, "text/json": { "schema": { "type": "string", "nullable": true } }, "application/*+json": { "schema": { "type": "string", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Debug/{executionId}": { "get": { "tags": [ "Debug" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/DisasterRecovery/recover": { "post": { "tags": [ "DisasterRecovery" ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/DisasterRecovery/offsetSyncOnConsumerGenericDeployment": { "post": { "tags": [ "DisasterRecovery" ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/FailedBatch/{profileName}/{executionId}": { "post": { "tags": [ "FailedBatch" ], "parameters": [ { "name": "profileName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/Feature/{featurename}": { "get": { "tags": [ "Feature" ], "parameters": [ { "name": "featurename", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/GroupTag/{consumerName}": { "get": { "tags": [ "GroupTag" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupTagApiModel" } } } } } } }, "/ds/api/dataintegration/v1/GroupTag": { "get": { "tags": [ "GroupTag" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupTagApiModel" } } } } } } } }, "/ds/api/dataintegration/v1/GroupTag/Assign": { "post": { "tags": [ "GroupTag" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupTagApiModel" } } } } } } } }, "/ds/api/dataintegration/v1/GroupTag/Reset": { "post": { "tags": [ "GroupTag" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupTagApiModel" } } } } } } } }, "/ds/api/dataintegration/v1/HealthCheck": { "get": { "tags": [ "HealthCheck" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/HealthCheck/status": { "get": { "tags": [ "HealthCheck" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } } } } } } }, "/ds/api/dataintegration/v1/HealthCheck/liveness": { "get": { "tags": [ "HealthCheck" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}": { "get": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MongoIndex" } } } } } } }, "post": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexFieldRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}/{indexName}": { "get": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "indexName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MongoIndex" } } } } } }, "delete": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "indexName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}/field/{fieldName}": { "get": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MongoIndex" } } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}/compound": { "post": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexFieldRequest" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexFieldRequest" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexFieldRequest" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}/metadata": { "post": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexMetadata" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexMetadata" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexMetadata" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Index" ], "parameters": [ { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexMetadata" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexMetadata" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Index/{collectionName}/metadata/{deleteMetadataForCollection}": { "delete": { "tags": [ "Index" ], "parameters": [ { "name": "deleteMetadataForCollection", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "collectionName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/KafkaManager/InitializeOffsetDocument": { "post": { "tags": [ "KafkaManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KafkaMessageOffsetCounter" } } } } } } } }, "/ds/api/dataintegration/v1/KafkaManager/GetOffsetDocument": { "get": { "tags": [ "KafkaManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KafkaMessageOffsetCounter" } } } } } } } }, "/ds/api/dataintegration/v1/MetaDataSync/run": { "get": { "tags": [ "MetaDataSync" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/MetaDataSync/run/consumerName/{consumerName}": { "get": { "tags": [ "MetaDataSync" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/MetaDataSync/run/entity": { "post": { "tags": [ "MetaDataSync" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/MetaDataSync/resync/{consumerName}/{entityName}": { "get": { "tags": [ "MetaDataSync" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Metadata/objects/{objectName}": { "get": { "tags": [ "Metadata" ], "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SFObjectMetadataApiResponseModel" } } } } } } }, "/ds/api/dataintegration/v1/Metadata/objects": { "get": { "tags": [ "Metadata" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SFObjectsApiResponseModel" } } } } } } }, "/ds/api/dataintegration/v1/Probe": { "get": { "tags": [ "Probe" ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/Probe/services": { "get": { "tags": [ "Probe" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentDetail" } } } } } } } }, "/ds/api/dataintegration/v1/Probe/pods": { "get": { "tags": [ "Probe" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/ds/api/dataintegration/v1/Probe/deployments": { "get": { "tags": [ "Probe" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/ds/api/dataintegration/v1/PushTopic/{consumerName}/enable": { "post": { "tags": [ "PushTopic" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/PushTopic/{consumerName}/syncaction/{syncactionName}/enable": { "post": { "tags": [ "PushTopic" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncactionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/PushTopic/{consumerName}/syncaction/{syncactionName}/disable": { "post": { "tags": [ "PushTopic" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncactionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/PushTopic/{consumerName}/disable": { "post": { "tags": [ "PushTopic" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/RealtimeSync/{consumerName}/{entityName}": { "post": { "tags": [ "RealtimeSync" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeSyncResponse" } } } } } } }, "/ds/api/dataintegration/v1/Retry/datasyncCompletedMessages": { "post": { "tags": [ "Retry" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerPushRetryAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsumerPushRetryAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConsumerPushRetryAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Retry/publishmessagetokafka": { "post": { "tags": [ "Retry" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "nullable": true } }, "text/json": { "schema": { "type": "string", "nullable": true } }, "application/*+json": { "schema": { "type": "string", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Retry/publishmessagetotriggertopic": { "post": { "tags": [ "Retry" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "nullable": true } }, "text/json": { "schema": { "type": "string", "nullable": true } }, "application/*+json": { "schema": { "type": "string", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Retry/consumerName/{consumerName}/consumerDataSyncRunId/{consumerDataSyncRunId}": { "get": { "tags": [ "Retry" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "consumerDataSyncRunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunHistoryBatchDetailAPIModel" } } } } } } }, "post": { "tags": [ "Retry" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "consumerDataSyncRunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/{consumerName}/{consumerrunid}/detail": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "consumerrunid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunHistoryDetailAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/{executionId}/detailbyexecutionId": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunHistoryDetailAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/Metadata/{entityName}/{executionId}": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailureDetailAPIModel" } } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/Consumer/{consumerName}/{entityName}/{executionId}/{syncActionName}": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailureDetailAPIModel" } } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/{consumerName}/{limit}/{pageNo}": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "limit", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageNo", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunHistoryLandingAPIModelListAPIViewModel" } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/Failure/{executionId}": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailureDetailAPIModel" } } } } } } } }, "/ds/api/dataintegration/v1/RunHistory/executionhistory/abort/{executionId}": { "post": { "tags": [ "RunHistory" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/RunHistory/{consumerName}/{consumerRunId}/{syncActionName}/syncRecordsDetail": { "get": { "tags": [ "RunHistory" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "consumerRunId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRecordsDetailAPIModel" } } } } } } }, "/ds/api/dataintegration/v1/SeedData": { "post": { "tags": [ "SeedData" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "deprecated": true } }, "/ds/api/dataintegration/v1/SeedData/{consumerName}": { "post": { "tags": [ "SeedData" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/ds/api/dataintegration/v1/SeedData/{consumerName}/Functionality/Include": { "post": { "tags": [ "SeedData" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/ds/api/dataintegration/v1/SeedData/{consumerName}/Functionality/Exclude": { "post": { "tags": [ "SeedData" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/ds/api/dataintegration/v1/SeedData/indices": { "post": { "tags": [ "SeedData" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "/ds/api/dataintegration/v1/SeedData/profile/cms": { "get": { "tags": [ "SeedData" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "deprecated": true } }, "/ds/api/dataintegration/v1/SeedData/OnboardNewProfile/{consumerName}": { "post": { "tags": [ "SeedData" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "deprecated": true } }, "/ds/api/dataintegration/v1/Stats/limits": { "get": { "tags": [ "Stats" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitsApiModel" } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/{consumerName}": { "get": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyncAction" } } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/{consumerName}/SyncAction/{syncActionName}": { "get": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncAction" } } } } } }, "delete": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/{consumerName}/UpsertSyncAction": { "post": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "performResync", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/{consumerName}/PerformConsumerProfileSync/{entityName}": { "post": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/{consumerName}/ValidateResync": { "post": { "tags": [ "SyncAction" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncActionAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncAction/UpsertCurrencyType": { "get": { "tags": [ "SyncAction" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/SyncActionIndex/{consumerName}/entity/{entityName}/syncaction/{syncActionName}": { "get": { "tags": [ "SyncActionIndex" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexInfoApiModel" } } } } } } }, "post": { "tags": [ "SyncActionIndex" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexInfo" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncActionIndex/{consumerName}/entity/{entityName}/syncaction/{syncActionName}/indexname/{indexName}": { "delete": { "tags": [ "SyncActionIndex" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "indexName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncCriteria/{entityName}/enable": { "post": { "tags": [ "SyncCriteria" ], "parameters": [ { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriteriaBasedSyncEnabledEntity" } } } } } } }, "/ds/api/dataintegration/v1/SyncCriteria/{entityName}/disable": { "post": { "tags": [ "SyncCriteria" ], "parameters": [ { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriteriaBasedSyncEnabledEntity" } } } } } } }, "/ds/api/dataintegration/v1/SyncCriteria/{entityName}/CleanDataForCriteriaBasedSync": { "delete": { "tags": [ "SyncCriteria" ], "parameters": [ { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/ds/api/dataintegration/v1/SyncCriteria/{consumerName}/SyncAction/{syncActionName}/FilterCriteria": { "delete": { "tags": [ "SyncCriteria" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "syncActionName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncAction" } } } } } } }, "/ds/api/dataintegration/v1/SyncEntity": { "post": { "tags": [ "SyncEntity" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncEntityApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncEntityApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncEntityApiModel" } } } }, "responses": { "200": { "description": "Success" } } } }, "/ds/api/dataintegration/v1/SyncPreference/recipientemailinfo/{consumerName}": { "get": { "tags": [ "SyncPreference" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientEmailInfoApiModel" } } } } } }, "put": { "tags": [ "SyncPreference" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientEmailInfoApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecipientEmailInfoApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecipientEmailInfoApiModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientEmailInfoApiModel" } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityPullDetails": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityPullBatchThroughput": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityPullDetailsincremental": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityOnGoing": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntitySyncActionLapV1": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityOnlyLapV1": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/SyncActionOnlyLapV1": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/ConsumerBatchThroughput": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntitySyncActionTimevsTimeTakenTelemetry/{entityName}": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntitySyncActionTimevsRecordCountTelemetry/{entityName}": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntitySyncActionBatchNumberTimeTakenTelemetry/{entityName}": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntitySyncActionConsumerBatchNumberTimeTakenTelemetry/{entityName}": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "entityName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/EntityPullTime": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/SyncActionPushTime": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Telemetry/{executionId}/RunHistoryDetails/SyncActionPushTime": { "get": { "tags": [ "Telemetry" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IrregulatTimeSeriesElement" } } } } } } } }, "/ds/api/dataintegration/v1/Upgrade/{fromVersion}/{toVersion}": { "get": { "tags": [ "Upgrade" ], "parameters": [ { "name": "fromVersion", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "toVersion", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Upgrade/TriggerResync/{consumerName}": { "post": { "tags": [ "Upgrade" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Validate": { "get": { "tags": [ "Validate" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Validate/{consumerName}": { "get": { "tags": [ "Validate" ], "parameters": [ { "name": "consumerName", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/ds/api/dataintegration/v1/Validate/SFDCDetails": { "get": { "tags": [ "Validate" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesforceDetailsModel" } } } } } } }, "/ds/api/dataintegration/v1/Validate/GetValidationResults": { "get": { "tags": [ "Validate" ], "parameters": [ { "name": "validationExecutionId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResults" } } } } } } } }, "components": { "schemas": { "DISConfiguration": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true } }, "additionalProperties": false }, "ConsumerBulkSyncEnabledSyncActionsAPIModel": { "type": "object", "properties": { "consumerName": { "type": "string", "nullable": true }, "bulkSyncEnabledSyncActions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SyncActionType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "SyncCriteriaOperator": { "enum": [ 1 ], "type": "integer", "format": "int32" }, "SyncFilterCriteria": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "object", "additionalProperties": false, "nullable": true }, "operator": { "$ref": "#/components/schemas/SyncCriteriaOperator" } }, "additionalProperties": false }, "IndexInfo": { "type": "object", "properties": { "indexName": { "type": "string", "nullable": true }, "indexFields": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SyncField": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "isNewlyAdded": { "type": "boolean" }, "isBeingHandeled": { "type": "boolean" }, "calculated": { "type": "boolean" }, "calculatedFormula": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChildRelationship": { "type": "object", "properties": { "childFieldName": { "type": "string", "nullable": true }, "childRelationshipName": { "type": "string", "nullable": true }, "childEntityName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "syncAllFields": { "type": "boolean" }, "filterCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFilterCriteria" }, "nullable": true }, "lookupRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRelationship" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationship" }, "nullable": true }, "shouldReProcessedDueToFieldAddition": { "type": "boolean" }, "shouldReProcessDueToFormulaFieldAddition": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SyncField" }, "nullable": true } }, "additionalProperties": false }, "LookupRelationship": { "type": "object", "properties": { "lookupFieldName": { "type": "string", "nullable": true }, "relationshipName": { "type": "string", "nullable": true }, "relatedEntityName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "syncAllFields": { "type": "boolean" }, "filterCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFilterCriteria" }, "nullable": true }, "lookupRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRelationship" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationship" }, "nullable": true }, "shouldReProcessedDueToFieldAddition": { "type": "boolean" }, "shouldReProcessDueToFormulaFieldAddition": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SyncField" }, "nullable": true } }, "additionalProperties": false }, "SyncAction": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "baseEntity": { "type": "string", "nullable": true }, "isOOTBSyncAction": { "type": "boolean" }, "isSystemAdded": { "type": "boolean" }, "isFirstTimeProcessing": { "type": "boolean" }, "isPushTopicEnabled": { "type": "boolean" }, "isMetadataOnly": { "type": "boolean" }, "actionType": { "$ref": "#/components/schemas/SyncActionType" }, "modifiedTime": { "type": "string", "format": "date-time", "nullable": true }, "syncAllFields": { "type": "boolean" }, "sendAllRecords": { "type": "boolean" }, "dontSyncInitiallySyncedRecords": { "type": "boolean" }, "filterCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFilterCriteria" }, "nullable": true }, "targetIndexes": { "type": "array", "items": { "$ref": "#/components/schemas/IndexInfo" }, "nullable": true }, "lookupRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRelationship" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationship" }, "nullable": true }, "seedFunctionalityTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "functionalityTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "shouldReProcessedDueToFieldAddition": { "type": "boolean" }, "shouldReProcessDueToFormulaFieldAddition": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SyncField" }, "nullable": true } }, "additionalProperties": false }, "ConsumerSyncEntity": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "allowRealtimeSync": { "type": "boolean" }, "syncMetadataOnly": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "isSystemAdded": { "type": "boolean" }, "syncActions": { "type": "array", "items": { "$ref": "#/components/schemas/SyncAction" }, "nullable": true }, "seedFunctionalityTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "functionalityTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ConsumerProfile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "consumerGroup": { "type": "string", "nullable": true }, "syncFrequency": { "type": "integer", "format": "int32", "nullable": true }, "entitiesToSync": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumerSyncEntity" }, "nullable": true }, "isActive": { "type": "boolean" }, "isReadonly": { "type": "boolean" }, "allowAddObject": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "profileChangeTimeStamp": { "type": "string", "nullable": true }, "initialScheduleStartingTime": { "type": "string", "nullable": true }, "isDeprecated": { "type": "boolean" } }, "additionalProperties": false }, "BaseConsumerProfileAPIModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "syncFrequency": { "type": "integer", "format": "int32", "nullable": true }, "syncStartTime": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isReadonly": { "type": "boolean" }, "allowAddObject": { "type": "boolean" } }, "additionalProperties": false }, "SyncActionsListAPIModel": { "type": "object", "properties": { "consumerProfileName": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "syncActionBaseEntityName": { "type": "string", "nullable": true }, "syncActionName": { "type": "string", "nullable": true }, "syncActionDisplayName": { "type": "string", "nullable": true }, "isSystemAdded": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isPushTopicEnabled": { "type": "boolean" }, "isMetadataOnly": { "type": "boolean" }, "actionType": { "$ref": "#/components/schemas/SyncActionType" } }, "additionalProperties": false }, "ConsumerProfileAPIModel": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "isIndexEnabled": { "type": "boolean" }, "isDeprecated": { "type": "boolean" }, "syncActionsListAPIModel": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActionsListAPIModel" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "syncFrequency": { "type": "integer", "format": "int32", "nullable": true }, "syncStartTime": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isReadonly": { "type": "boolean" }, "allowAddObject": { "type": "boolean" } }, "additionalProperties": false }, "ConsumerProfileListAPIModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "consumerGroup": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "RecordCountAPIModel": { "type": "object", "properties": { "syncActionBaseEntityName": { "type": "string", "nullable": true }, "syncActionName": { "type": "string", "nullable": true }, "syncActionDisplayName": { "type": "string", "nullable": true }, "salesforceRecordCount": { "type": "string", "nullable": true }, "consumerRecordCount": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ToggleConsumerProfileAPIModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "EntityCleanupDetail": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "deletedRecordsCount": { "type": "integer", "format": "int64" }, "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataCleanupStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "DataCleanupResults": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "dataCleanupExecutionId": { "type": "string", "nullable": true }, "dataCleanupResponse": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCleanupDetail" }, "nullable": true }, "dataCleanupException": { "type": "string", "nullable": true }, "dataCleanupStartTime": { "type": "string", "format": "date-time", "nullable": true }, "dataCleanupEndTime": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/DataCleanupStatus" } }, "additionalProperties": false }, "DataSynRunAPIModel": { "type": "object", "properties": { "executionId": { "type": "string", "nullable": true }, "consumerDataSyncRunId": { "type": "string", "nullable": true }, "consumerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupTagApiModel": { "type": "object", "properties": { "consumerName": { "type": "string", "nullable": true }, "eventsTopicGroup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HealthCheckSummary": { "type": "object", "properties": { "healthComponentName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HealthCheckResponse": { "type": "object", "properties": { "serviceName": { "type": "string", "nullable": true }, "healthCheckSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/HealthCheckSummary" }, "nullable": true } }, "additionalProperties": false }, "MongoIndex": { "type": "object", "properties": { "indexName": { "type": "string", "nullable": true }, "indexFields": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "IndexFieldRequest": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "isAscending": { "type": "boolean" } }, "additionalProperties": false }, "IndexMetadata": { "type": "object", "properties": { "collectionName": { "type": "string", "nullable": true }, "indexedFields": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ComponentOffsetCounter": { "type": "object", "properties": { "componentName": { "type": "string", "nullable": true }, "lastHighestOffSet": { "type": "integer", "format": "int64" }, "podName": { "type": "string", "nullable": true }, "timeStamp": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KafkaMessageOffsetCounter": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "topicName": { "type": "string", "nullable": true }, "partitionNo": { "type": "integer", "format": "int32" }, "sentOffsets": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentOffsetCounter" }, "nullable": true }, "receivedOffsets": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentOffsetCounter" }, "nullable": true } }, "additionalProperties": false }, "ReferenceObjectModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "referenceTo": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceObjectModel" }, "nullable": true }, "relationshipName": { "type": "string", "nullable": true }, "calculated": { "type": "boolean" }, "calculatedFormula": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChildRelationshipModel": { "type": "object", "properties": { "childSObject": { "type": "string", "nullable": true }, "childSObjectLabel": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "relationshipName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SFObjectMetadataApiResponseModel": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldModel" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationshipModel" }, "nullable": true } }, "additionalProperties": false }, "SFObjectModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SFObjectsApiResponseModel": { "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/SFObjectModel" }, "nullable": true } }, "additionalProperties": false }, "Container": { "type": "object", "properties": { "serviceContainerName": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeploymentDetail": { "type": "object", "properties": { "deploymentName": { "type": "string", "nullable": true }, "containers": { "type": "array", "items": { "$ref": "#/components/schemas/Container" }, "nullable": true }, "instanceCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SyncStatus": { "enum": [ 1, 4, 5, 6, 7, 10, 13, 14, 15, 16, 17 ], "type": "integer", "format": "int32" }, "DataPullDetail": { "type": "object", "properties": { "recordsPulled": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "errorDetails": { "type": "string", "nullable": true }, "warningDetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsumerPushDetail": { "type": "object", "properties": { "recordsPushed": { "type": "array", "items": { "type": "string" }, "nullable": true }, "errorDetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RealtimeSyncResponse": { "type": "object", "properties": { "syncStatus": { "$ref": "#/components/schemas/SyncStatus" }, "dataPullSummary": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataPullDetail" }, "nullable": true }, "consumerPushSummary": { "$ref": "#/components/schemas/ConsumerPushDetail" }, "errorDetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsumerPushRetryAPIModel": { "type": "object", "properties": { "listOfDataSyncCompletedMessage": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataPullBatchMessagesCompletedMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RunHistoryBatchDetailAPIModel": { "type": "object", "properties": { "triggeredSyncProfileName": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SyncStatus" }, "isSystemAdded": { "type": "boolean" }, "entityName": { "type": "string", "nullable": true }, "syncActionAlias": { "type": "string", "nullable": true }, "dscmDataSyncRunId": { "type": "integer", "format": "int64" }, "triggeredConsumerDataSyncRunId": { "type": "integer", "format": "int64" }, "dscmConsumerDataSyncRunId": { "type": "integer", "format": "int64" }, "triggeredExecutionId": { "type": "string", "nullable": true }, "dscmExecutionId": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserInfo": { "type": "object", "properties": { "preferredUserName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RunHistoryLandingAPIModel": { "type": "object", "properties": { "executionId": { "type": "string", "nullable": true }, "auditType": { "type": "string", "nullable": true }, "triggerPoint": { "type": "string", "nullable": true }, "syncTypeInfo": { "type": "string", "nullable": true, "readOnly": true }, "syncStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "startedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "completedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "dataSyncRunId": { "type": "string", "nullable": true }, "consumerDataSyncRunId": { "type": "string", "nullable": true }, "syncProfileName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "totalSyncActionsCount": { "type": "string", "nullable": true }, "succeededSyncActionsCount": { "type": "string", "nullable": true }, "failedSyncActionsCount": { "type": "string", "nullable": true }, "triggeredBy": { "$ref": "#/components/schemas/UserInfo" }, "statusDisplayText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityRunHistoryAPIModel": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "recordCount": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SyncActionRunHistoryAPIModel": { "type": "object", "properties": { "syncActionAlias": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "sentRecordCount": { "type": "integer", "format": "int32" }, "recordCount": { "type": "string", "nullable": true }, "successRecordCount": { "type": "integer", "format": "int32" }, "logicalSuccessRecordCount": { "type": "integer", "format": "int32" }, "inProgressRecordCount": { "type": "integer", "format": "int32" }, "failedRecordCount": { "type": "integer", "format": "int32" }, "validationFailedRecordCount": { "type": "integer", "format": "int32" }, "enableRetry": { "type": "boolean" }, "actionType": { "$ref": "#/components/schemas/SyncActionType" }, "syncStatus": { "type": "string", "nullable": true }, "statusDisplayText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RunHistoryDetailAPIModel": { "type": "object", "properties": { "executionHistory": { "$ref": "#/components/schemas/RunHistoryLandingAPIModel" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EntityRunHistoryAPIModel" }, "nullable": true }, "syncActions": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActionRunHistoryAPIModel" }, "nullable": true } }, "additionalProperties": false }, "FailureDetailAPIModel": { "type": "object", "properties": { "friendlyMessage": { "type": "string", "nullable": true }, "auditComponent": { "type": "string", "nullable": true }, "suggestiveActions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "HttpStatusCode": { "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 ], "type": "integer", "format": "int32" }, "RunHistoryLandingAPIModelListAPIViewModel": { "type": "object", "properties": { "statusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "payload": { "type": "array", "items": { "$ref": "#/components/schemas/RunHistoryLandingAPIModel" }, "nullable": true }, "aditionalMessage": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "EntitySpecificDetail": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "sentRecordCount": { "type": "integer", "format": "int32" }, "inProgressRecordCount": { "type": "integer", "format": "int32" }, "successRecordCount": { "type": "integer", "format": "int32" }, "failedRecordCount": { "type": "integer", "format": "int32" }, "validationFailedRecordCount": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SyncStatus" }, "startedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SyncRecordsDetailAPIModel": { "type": "object", "properties": { "syncStatus": { "type": "string", "nullable": true }, "statusDisplayText": { "type": "string", "nullable": true }, "sentRecordCount": { "type": "integer", "format": "int32" }, "inProgressRecordCount": { "type": "integer", "format": "int32" }, "successRecordCount": { "type": "integer", "format": "int32" }, "failedRecordCount": { "type": "integer", "format": "int32" }, "validationFailedRecordCount": { "type": "integer", "format": "int32" }, "logicalSuccessRecordCount": { "type": "integer", "format": "int32" }, "entitySpecificDetails": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySpecificDetail" }, "nullable": true } }, "additionalProperties": false }, "LimitsApiModel": { "type": "object", "properties": { "dataSyncConsumedRegularApiCount": { "type": "integer", "format": "int32" }, "sfRemainingRegularApiCount": { "type": "integer", "format": "int32" }, "dataSyncConsumedBulkApiCount": { "type": "integer", "format": "int32" }, "sfRemainingBulkApiCount": { "type": "integer", "format": "int32" }, "dataSyncConsumedPushTopicMessagesCount": { "type": "integer", "format": "int32" }, "sfRemainingPushTopicMessagesCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SyncActionAPIModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "baseEntity": { "type": "string", "nullable": true }, "isMetadataOnly": { "type": "boolean" }, "actionType": { "$ref": "#/components/schemas/SyncActionType" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SyncField" }, "nullable": true }, "lookupRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRelationship" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationship" }, "nullable": true } }, "additionalProperties": false }, "IndexInfoFieldsStructure": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SyncField" }, "nullable": true }, "lookupRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LookupRelationship" }, "nullable": true }, "childRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChildRelationship" }, "nullable": true } }, "additionalProperties": false }, "IndexInfoApiModel": { "type": "object", "properties": { "indexFieldsStructure": { "$ref": "#/components/schemas/IndexInfoFieldsStructure" }, "indexName": { "type": "string", "nullable": true }, "indexFields": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CriteriaBasedSyncEnabledEntity": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "lastEnabledTime": { "type": "string", "format": "date-time" }, "lastDisabledTime": { "type": "string", "format": "date-time" }, "userName": { "type": "string", "nullable": true }, "doesMetadataContainTurboExpiryDate": { "type": "boolean" } }, "additionalProperties": false }, "SyncEntityApiModel": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "sfdcLastModifiedDateTimeCutOff": { "type": "string", "nullable": true }, "lastMetadataSyncedTimeInGMT": { "type": "string", "nullable": true }, "isInitiallySynced": { "type": "boolean" } }, "additionalProperties": false }, "RecipientEmailInfoApiModel": { "type": "object", "properties": { "shouldReceiveNotification": { "type": "boolean" }, "emailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IrregulatTimeSeriesElement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } }, "nullable": true } }, "additionalProperties": false }, "SalesforceDetailsModel": { "type": "object", "properties": { "configuredSFDCUrl": { "type": "string", "nullable": true }, "sfdcUrlFromToken": { "type": "string", "nullable": true }, "oAuthUrl": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "validate": { "type": "boolean" }, "isInstanceUrlMatches": { "type": "boolean" }, "rsaPrivateKey": { "type": "string", "nullable": true }, "featureFlagInitlized": { "type": "boolean" }, "jwtAuthFeatureFlagEnabled": { "type": "boolean" } }, "additionalProperties": false }, "ValidationStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "ValidationResults": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "validationExecutionId": { "type": "string", "nullable": true }, "consumerNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "validationResponse": { "type": "string", "nullable": true }, "validationException": { "type": "string", "nullable": true }, "validationStartTime": { "type": "string", "format": "date-time", "nullable": true }, "validationEndTime": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/ValidationStatus" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with 'Bearer' prefix and one space into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }