--- schema_version: "1" id: 5af3b0b063c92dd3f905f87619e7202ef14b853aed8d92a695cdff50398450ce title: Data 360 Connect API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/data-cloud/connectapi/references/generated-api-specs/spec.md canonical_url: https://developer.salesforce.com/docs/data/connectapi/references/spec source_site: developer.salesforce.com content_type: documentation content_hash: 11571f0bc964f54ebb23433bc7ccf6408c771d3ce0a502d85b24b5ebfb6bad93 products: - Data 360 Connect REST API - Data 360 Developer Documentation --- Data 360 Connect API # Data 360 Connect API > **Note:** The Data 360 Connect REST API Reference section has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access payload examples on the right. Manage and orchestrate end-to-end data lifecycles within Data 360. Use these resources to ingest metadata, execute complex data queries, and programmatically control data assets, including calculated insights, identity resolution rulesets, and segments. Connect REST API authentication is different from the authentication for other [Data 360 REST APIs](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/dc-rest-api-overview.html). See [OAuth and Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_using_oauth.htm) for more information. For limit information, see [Data 360 Limits and Guidelines](https://help.salesforce.com/s/articleView?id=data.c360_a_limits_and_guidelines.htm). To make Data 360 Connect REST API calls with Postman, see the [Data 360 Connect API Postman Collection](https://developer.salesforce.com/docs/platform/connectapi/guide/postman-collection.html). > **Note:** As of October 14, 2025, Data Cloud has been rebranded to Data 360. During this transition, you may see references to Data Cloud in our application and documentation. While the name is new, the functionality and content remain unchanged. **Version:** 68.0 ## Servers * `https://{dne_cdpInstanceUrl}/services/data/v{version}` * ``dne_cdpInstanceUrl (default None) The instance_url value returned from the Auth Request in the Data 360 Connect REST API Postman Collection. You must call the OAuth endpoint in the Auth Request to get the instance information and access tokens necessary to configure a connected app or Postman collection. For example: `https://datacloud-abc-wks29-dev-ed.develop.my.salesforce.com`.`` * `version (default 67.0) Version of the Connect API.` ## Tags ### Activation External Platforms Connect REST API endpoints for Data 360 activation external platforms: | Operation | Path | | --- | --- | | [Get activation external platforms](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-External-Platforms/paths/~1ssot~1activation-external-platforms/get) | `GET /ssot/activation-external-platforms` | | [Get activation external platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-External-Platforms/paths/~1ssot~1activation-external-platforms~1%7BidOrName%7D/get) | `GET /ssot/activation-external-platforms/{idOrName}` | ### Activation Platforms Connect REST API endpoints for Data 360 activation platforms: | Operation | Path | | --- | --- | | [Get activation platforms](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms/get) | `GET /ssot/activation-platforms` | | [Create activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms/post) | `POST /ssot/activation-platforms` | | [Delete activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D/delete) | `DELETE /ssot/activation-platforms/{idOrName}` | | [Get activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D/get) | `GET /ssot/activation-platforms/{idOrName}` | | [Update activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D/patch) | `PATCH /ssot/activation-platforms/{idOrName}` | | [Disable activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1actions~1disable/post) | `POST /ssot/activation-platforms/{idOrName}/actions/disable` | | [Enable activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1actions~1enable/post) | `POST /ssot/activation-platforms/{idOrName}/actions/enable` | | [Publish activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1actions~1publish/post) | `POST /ssot/activation-platforms/{idOrName}/actions/publish` | | [Retry activation platform sync](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1actions~1retry-sync/post) | `POST /ssot/activation-platforms/{idOrName}/actions/retry-sync` | | [Set activation platform privacy type](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1actions~1set-privacy-type/post) | `POST /ssot/activation-platforms/{idOrName}/actions/set-privacy-type` | | [Get action sources for an event](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1metadata~1action-sources/get) | `GET /ssot/activation-platforms/{idOrName}/metadata/action-sources` | | [Get events for an activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1metadata~1events/get) | `GET /ssot/activation-platforms/{idOrName}/metadata/events` | | [Get partner-object types for an activation platform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Platforms/paths/~1ssot~1activation-platforms~1%7BidOrName%7D~1metadata~1partner-object-types/get) | `GET /ssot/activation-platforms/{idOrName}/metadata/partner-object-types` | ### Activation Targets Connect REST API endpoints for Data 360 activation targets: | Operation | Path | | --- | --- | | [Get activation targets](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Targets/paths/~1ssot~1activation-targets/get) | `GET /ssot/activation-targets` | | [Create activation target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Targets/paths/~1ssot~1activation-targets/post) | `POST /ssot/activation-targets` | | [Delete activation target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Targets/paths/~1ssot~1activation-targets~1%7BactivationTargetId%7D/delete) | `DELETE /ssot/activation-targets/{activationTargetId}` | | [Get activation target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Targets/paths/~1ssot~1activation-targets~1%7BactivationTargetId%7D/get) | `GET /ssot/activation-targets/{activationTargetId}` | | [Update activation target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activation-Targets/paths/~1ssot~1activation-targets~1%7BactivationTargetId%7D/patch) | `PATCH /ssot/activation-targets/{activationTargetId}` | ### Activations Connect REST API endpoints for Data 360 activations: | Operation | Path | | --- | --- | | [Get activations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations/get) | `GET /ssot/activations` | | [Create activation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations/post) | `POST /ssot/activations` | | [Delete activation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations~1%7BactivationId%7D/delete) | `DELETE /ssot/activations/{activationId}` | | [Get activation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations~1%7BactivationId%7D/get) | `GET /ssot/activations/{activationId}` | | [Update activation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations~1%7BactivationId%7D/put) | `PUT /ssot/activations/{activationId}` | | [Publish a Batch DMO activation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations~1%7BactivationId%7D~1actions~1publish/post) | `GET /ssot/activations/{activationId}/actions/publish` | | [Get Audience DMO activation records](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activations~1%7BactivationId%7D~1data/get) | `GET /ssot/activations/{activationId}/data` | ### Agent Configuration Connect REST API endpoints for Data 360 agent configuration: | Operation | Path | | --- | --- | | [Get agents](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Agent-Configuration/paths/~1ssot~1agentic~1agents/get) | `GET /ssot/agentic/agents` | | [Create agent](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Agent-Configuration/paths/~1ssot~1agentic~1agent/post) | `POST /ssot/agentic/agent` | | [Delete agent](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Agent-Configuration/paths/~1ssot~1agentic~1agent~1%7BagentIdOrApiName%7D/delete) | `DELETE /ssot/agentic/agent/{agentIdOrApiName}` | | [Get agent](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Agent-Configuration/paths/~1ssot~1agentic~1agent~1%7BagentIdOrApiName%7D/get) | `GET /ssot/agentic/agent/{agentIdOrApiName}` | ### Calculated Insights Connect REST API endpoints for Data 360 calculated insights: | Operation | Path | | --- | --- | | [Get calculated insights](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights/get) | `GET /ssot/calculated-insights` | | [Create calculated insights](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights/post) | `POST /ssot/calculated-insights` | | [Delete calculated insight](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights~1%7BapiName%7D/delete) | `DELETE /ssot/calculated-insights/{apiName}` | | [Get calculated insight](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights~1%7BapiName%7D/get) | `GET /ssot/calculated-insights/{apiName}` | | [Update calculated insight](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights~1%7BapiName%7D/patch) | `PATCH /ssot/calculated-insights/{apiName}` | | [Run calculated insight](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Calculated-Insights/paths/~1ssot~1calculated-insights~1%7BapiName%7D~1actions~1run/post) | `POST /ssot/calculated-insights/{apiName}/actions/run` | ### Clean Rooms Connect REST API endpoints for Data 360 clean rooms: | Operation | Path | | --- | --- | | [Get collaborations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations/get) | `GET /ssot/data-clean-room/collaborations` | | [Create a collaboration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations/post) | `POST /ssot/data-clean-room/collaborations` | | [Accept a collaboration invitation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1actions~1accept-invitation/post) | `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/accept-invitation` | | [Disable a collaboration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1actions~1disable/post) | `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/disable` | | [Refresh collaboration metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1actions~1refresh-metadata/put) | `PUT /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/refresh-metadata` | | [Reject a collaboration invitation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1actions~1reject-invitation/post) | `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/reject-invitation` | | [Run a query](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1actions~1run/post) | `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/run` | | [Get query jobs](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1jobs/get) | `GET /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/jobs` | | [Get collaboration result objects](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1collaborations~1%7BcollaborationIdOrApiName%7D~1result-data-objects/get) | `GET /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/result-data-objects` | | [Get providers](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1providers/get) | `GET /ssot/data-clean-room/providers` | | [Create a provider](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1providers/post) | `POST /ssot/data-clean-room/providers` | | [Get a provider](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1providers~1%7BproviderIdOrName%7D/get) | `GET /ssot/data-clean-room/providers/{providerIdOrName}` | | [Get provider templates](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1providers~1%7BproviderIdOrName%7D~1templates/get) | `GET /ssot/data-clean-room/providers/{providerIdOrName}/templates` | | [Get specifications](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1specifications/get) | `GET /ssot/data-clean-room/specifications` | | [Create a specification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1specifications/post) | `POST /ssot/data-clean-room/specifications` | | [Delete a specification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1specifications~1%7BspecificationIdOrApiName%7D/delete) | `DELETE /ssot/data-clean-room/specifications/{specificationIdOrApiName}` | | [Get templates](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1templates/get) | `GET /ssot/data-clean-room/templates` | | [Get template collaborations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1templates~1%7BuseCaseTemplateType%7D~1collaborations/get) | `GET /ssot/data-clean-room/templates/{useCaseTemplateType}/collaborations` | | [Test connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Clean-Rooms/paths/~1ssot~1data-clean-room~1test-connection/post) | `POST /ssot/data-clean-room/test-connection` | ### Communication Capping Connect REST API endpoints for Data 360 communication capping: | Operation | Path | | --- | --- | | [Create communication capping configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping/post) | `POST /ssot/communication-capping` | | [Get activation target dimension metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1activation-target-capping-metadata~1%7BactivationTargetId%7D/get) | `GET /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` | | [Map dimension metadata to activation target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1activation-target-capping-metadata~1%7BactivationTargetId%7D/post) | `POST /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` | | [Delete activation target metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1activation-target-capping-metadata~1%7BactivationTargetId%7D/delete) | `DELETE /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` | | [Get communication capping dimensions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1dimensions/get) | `GET /ssot/communication-capping/dimensions` | | [Create communication capping dimension](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1dimensions/post) | `POST /ssot/communication-capping/dimensions` | | [Update communication capping dimension priority](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1dimensions~1actions~1swap-priority/patch) | `PATCH /ssot/communication-capping/dimensions/actions/swap-priority` | | [Update communication capping dimension](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1dimensions~1%7BdimensionId%7D/patch) | `PATCH /ssot/communication-capping/dimensions/{dimensionId}` | | [Delete communication capping rule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1rules~1%7BruleIdOrName%7D/delete) | `DELETE /ssot/communication-capping/rules/{ruleIdOrName}` | | [Get communication capping configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D/get) | `GET /ssot/communication-capping/{id}` | | [Update communication capping configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D/patch) | `PATCH /ssot/communication-capping/{id}` | | [Disable communication capping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1actions~1disable/post) | `POST /ssot/communication-capping/{id}/actions/disable` | | [Enable communication capping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1actions~1enable/post) | `POST /ssot/communication-capping/{id}/actions/enable` | | [Get communication capping activation targets](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1activation-targets/get) | `GET /ssot/communication-capping/{id}/activation-targets` | | [Get communication capping rules](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1rules/get) | `GET /ssot/communication-capping/{id}/rules` | | [Create communication capping rule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1rules/post) | `POST /ssot/communication-capping/{id}/rules` | | [Update communication capping rule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Communication%20Capping/paths/~1ssot~1communication-capping~1%7Bid%7D~1rules~1%7BruleIdOrName%7D/patch) | `PATCH /ssot/communication-capping/{id}/rules/{ruleIdOrName}` | ### Connections Connect REST API endpoints for Data 360 connections: | Operation | Path | | --- | --- | | [Get connections](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections/get) | `GET /ssot/connections` | | [Create connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections/post) | `POST /ssot/connections` | | [Delete connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D/delete) | `DELETE /ssot/connections/{connectionId}` | | [Get connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D/get) | `GET /ssot/connections/{connectionId}` | | [Update connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D/patch) | `PATCH /ssot/connections/{connectionId}` | | [Replace connection](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D/put) | `PUT /ssot/connections/{connectionId}` | | [Get connection database schemas](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1database-schemas/post) | `POST /ssot/connections/{connectionId}/database-schemas` | | [Get connection databases](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1databases/post) | `POST /ssot/connections/{connectionId}/databases` | | [Get connection endpoints](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1endpoints/get) | `GET /ssot/connections/{connectionId}/endpoints` | | [Get connection fields](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1objects~1%7BresourceName%7D~1fields/post) | `POST /ssot/connections/{connectionId}/objects/{resourceName}/fields` | | [Get connection objects](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1objects/post) | `POST /ssot/connections/{connectionId}/objects` | | [Get connection preview](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1objects~1%7BresourceName%7D~1preview/post) | `POST /ssot/connections/{connectionId}/objects/{resourceName}/preview` | | [Get connection schema](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1schema/get) | `GET /ssot/connections/{connectionId}/schema` | | [Upsert connection schema](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1schema/put) | `PUT /ssot/connections/{connectionId}/schema` | | [Get connection site map](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1sitemap/get) | `GET /ssot/connections/{connectionId}/sitemap` | | [Upsert connection site map](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1sitemap/put) | `PUT /ssot/connections/{connectionId}/sitemap` | | [Test connection action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1actions~1test/post) | `POST /ssot/connections/actions/test` | | [Run connection action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1actions~1%7Bcommand%7D/post) | `POST /ssot/connections/actions/{command}` | | [Test existing connection action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1actions~1test/post) | `POST /ssot/connections/{connectionId}/actions/test` | | [Run existing connection action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1actions~1%7Bcommand%7D/post) | `POST /ssot/connections/{connectionId}/actions/{command}` | | [Test existing connection schema action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connections~1%7BconnectionId%7D~1schema~1actions~1test/post) | `POST /ssot/connections/{connectionId}/schema/actions/test` | | [Get connectors](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connectors/get) | `GET /ssot/connectors` | | [Get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connectors~1%7BconnectorType%7D/get) | `GET /ssot/connectors/{connectorType}` | ### Connectors Connect REST API endpoints for Data 360 connectors: | Operation | Path | | --- | --- | | [Get connectors](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connectors/get) | `GET /ssot/connectors` | | [Get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connectors~1%7BconnectorType%7D/get) | `GET /ssot/connectors/{connectorType}` | ### Data Action Targets Connect REST API endpoints for Data 360 data action targets: | Operation | Path | | --- | --- | | [Get data action targets](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Action-Targets/paths/~1ssot~1data-action-targets/get) | `GET /ssot/data-action-targets` | | [Create data action target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Action-Targets/paths/~1ssot~1data-action-targets/post) | `POST /ssot/data-action-targets` | | [Delete data action target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Action-Targets/paths/~1ssot~1data-action-targets~1%7BapiName%7D/delete) | `DELETE /ssot/data-action-targets/{apiName}` | | [Get data action target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Action-Targets/paths/~1ssot~1data-action-targets~1%7BapiName%7D/get) | `GET /ssot/data-action-targets/{apiName}` | | [Generate data action target signing key](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Action-Targets/paths/~1ssot~1data-action-targets~1%7BapiName%7D~1signing-key/post) | `POST /ssot/data-action-targets/{apiName}/signing-key` | ### Data Actions Connect REST API endpoints for Data 360 data actions: | Operation | Path | | --- | --- | | [Get data actions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Actions/paths/~1ssot~1data-actions/get) | `GET /ssot/data-actions` | | [Create data action](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Actions/paths/~1ssot~1data-actions/post) | `POST /ssot/data-actions` | ### Data Custom Code Connect REST API endpoints for Data 360 custom code: | Operation | Path | | --- | --- | | [Get custom code deployments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code/get) | `GET /ssot/data-custom-code` | | [Create custom code deployment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code/post) | `POST /ssot/data-custom-code` | | [Delete custom code deployment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code~1%7BcustomCodeNameOrId%7D/delete) | `DELETE /ssot/data-custom-code/{customCodeNameOrId}` | | [Get custom code deployment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code~1%7BcustomCodeNameOrId%7D/get) | `GET /ssot/data-custom-code/{customCodeNameOrId}` | | [Update custom code deployment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code~1%7BcustomCodeNameOrId%7D/patch) | `PATCH /ssot/data-custom-code/{customCodeNameOrId}` | | [Get custom code executions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code~1%7BcustomCodeNameOrId%7D~1executions/get) | `GET /ssot/data-custom-code/{customCodeNameOrId}/executions` | | [Get custom code execution](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Custom-Code/paths/~1ssot~1data-custom-code~1%7BcustomCodeNameOrId%7D~1executions~1%7BcustomCodeExecutionId%7D/get) | `GET /ssot/data-custom-code/{customCodeNameOrId}/executions/{customCodeExecutionId}` | ### Data Governance Connect REST API endpoints for Data 360 data governance: | Operation | Path | | --- | --- | | [Get access policies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies/get) | `GET /ssot/data-governance/access-policies` | | [Create access policy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies/post) | `POST /ssot/data-governance/access-policies` | | [Get access policy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies~1%7Bname%7D/get) | `GET /ssot/data-governance/access-policies/{name}` | | [Update access policy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies~1%7Bname%7D/patch) | `PATCH /ssot/data-governance/access-policies/{name}` | | [Delete access policy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies~1%7Bname%7D/delete) | `DELETE /ssot/data-governance/access-policies/{name}` | | [Get access policy rule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies~1%7Bname%7D~1rules~1%7BruleName%7D/get) | `GET /ssot/data-governance/access-policies/{name}/rules/{ruleName}` | | [Replace access policy rule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1access-policies~1%7Bname%7D~1rules~1%7BruleName%7D/put) | `PUT /ssot/data-governance/access-policies/{name}/rules/{ruleName}` | | [Get auto-tagging jobs](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1auto-tagging-jobs/get) | `GET /ssot/data-governance/auto-tagging-jobs` | | [Get auto-tagging job](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1auto-tagging-jobs~1%7Bid%7D/get) | `GET /ssot/data-governance/auto-tagging-jobs/{id}` | | [Get classification assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments/get) | `GET /ssot/data-governance/classification-assignments` | | [Create classification assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments/post) | `POST /ssot/data-governance/classification-assignments` | | [Get classification assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments~1%7Bid%7D/get) | `GET /ssot/data-governance/classification-assignments/{id}` | | [Delete classification assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments~1%7Bid%7D/delete) | `DELETE /ssot/data-governance/classification-assignments/{id}` | | [Bulk create classification assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments~1actions~1bulk-create/post) | `POST /ssot/data-governance/classification-assignments/actions/bulk-create` | | [Bulk delete classification assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-assignments~1actions~1bulk-delete/post) | `POST /ssot/data-governance/classification-assignments/actions/bulk-delete` | | [Get classification taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies/get) | `GET /ssot/data-governance/classification-taxonomies` | | [Create classification taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies/post) | `POST /ssot/data-governance/classification-taxonomies` | | [Get classification taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1%7Bname%7D/get) | `GET /ssot/data-governance/classification-taxonomies/{name}` | | [Update classification taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1%7Bname%7D/patch) | `PATCH /ssot/data-governance/classification-taxonomies/{name}` | | [Delete classification taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1%7Bname%7D/delete) | `DELETE /ssot/data-governance/classification-taxonomies/{name}` | | [Bulk create classification taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1actions~1bulk-create/post) | `POST /ssot/data-governance/classification-taxonomies/actions/bulk-create` | | [Bulk update classification taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1actions~1bulk-update/post) | `POST /ssot/data-governance/classification-taxonomies/actions/bulk-update` | | [Bulk delete classification taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classification-taxonomies~1actions~1bulk-delete/post) | `POST /ssot/data-governance/classification-taxonomies/actions/bulk-delete` | | [Get classifications](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications/get) | `GET /ssot/data-governance/classifications` | | [Create classification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications/post) | `POST /ssot/data-governance/classifications` | | [Get classification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1%7BfullyQualifiedName%7D/get) | `GET /ssot/data-governance/classifications/{fullyQualifiedName}` | | [Update classification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1%7BfullyQualifiedName%7D/patch) | `PATCH /ssot/data-governance/classifications/{fullyQualifiedName}` | | [Delete classification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1%7BfullyQualifiedName%7D/delete) | `DELETE /ssot/data-governance/classifications/{fullyQualifiedName}` | | [Get classification assignments on a classification](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1%7BfullyQualifiedName%7D~1assignments/get) | `GET /ssot/data-governance/classifications/{fullyQualifiedName}/assignments` | | [Bulk create classifications](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1actions~1bulk-create/post) | `POST /ssot/data-governance/classifications/actions/bulk-create` | | [Bulk update classifications](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1actions~1bulk-update/post) | `POST /ssot/data-governance/classifications/actions/bulk-update` | | [Bulk delete classifications](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1classifications~1actions~1bulk-delete/post) | `POST /ssot/data-governance/classifications/actions/bulk-delete` | | [Get object access grants](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants/get) | `GET /ssot/data-governance/object-access-grants` | | [Create object access grant](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants/post) | `POST /ssot/data-governance/object-access-grants` | | [Get object access grant](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants~1%7BobjectApiName%7D/get) | `GET /ssot/data-governance/object-access-grants/{objectApiName}` | | [Delete object access grant](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants~1%7BobjectApiName%7D/delete) | `DELETE /ssot/data-governance/object-access-grants/{objectApiName}` | | [Bulk create object access grants](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants~1actions~1bulk-create/post) | `POST /ssot/data-governance/object-access-grants/actions/bulk-create` | | [Bulk delete object access grants](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1object-access-grants~1actions~1bulk-delete/post) | `POST /ssot/data-governance/object-access-grants/actions/bulk-delete` | | [Get tag assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments/get) | `GET /ssot/data-governance/tag-assignments` | | [Create tag assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments/post) | `POST /ssot/data-governance/tag-assignments` | | [Get tag assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments~1%7Bid%7D/get) | `GET /ssot/data-governance/tag-assignments/{id}` | | [Delete tag assignment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments~1%7Bid%7D/delete) | `DELETE /ssot/data-governance/tag-assignments/{id}` | | [Bulk create tag assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments~1actions~1bulk-create/post) | `POST /ssot/data-governance/tag-assignments/actions/bulk-create` | | [Bulk delete tag assignments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-assignments~1actions~1bulk-delete/post) | `POST /ssot/data-governance/tag-assignments/actions/bulk-delete` | | [Get tag suggestions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-suggestions/get) | `GET /ssot/data-governance/tag-suggestions` | | [Get tag suggestion](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-suggestions~1%7Bid%7D/get) | `GET /ssot/data-governance/tag-suggestions/{id}` | | [Approve tag suggestions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-suggestions~1actions~1approve/post) | `POST /ssot/data-governance/tag-suggestions/actions/approve` | | [Generate tag suggestions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-suggestions~1actions~1generate/post) | `POST /ssot/data-governance/tag-suggestions/actions/generate` | | [Reject tag suggestions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-suggestions~1actions~1reject/post) | `POST /ssot/data-governance/tag-suggestions/actions/reject` | | [List tag taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies/get) | `GET /ssot/data-governance/tag-taxonomies` | | [Create tag taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies/post) | `POST /ssot/data-governance/tag-taxonomies` | | [Get tag taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1%7BfullyQualifiedName%7D/get) | `GET /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` | | [Update tag taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1%7BfullyQualifiedName%7D/patch) | `PATCH /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` | | [Delete tag taxonomy](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1%7BfullyQualifiedName%7D/delete) | `DELETE /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` | | [Bulk create tag detection instructions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1%7BfullyQualifiedName%7D~1detection-instructions~1actions~1bulk-create/post) | `POST /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}/detection-instructions/actions/bulk-create` | | [Get tags with active detection instructions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1%7BfullyQualifiedName%7D~1tags-with-active-detection-instructions/get) | `GET /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}/tags-with-active-detection-instructions` | | [Bulk create tag taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1actions~1bulk-create/post) | `POST /ssot/data-governance/tag-taxonomies/actions/bulk-create` | | [Bulk update tag taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1actions~1bulk-update/post) | `POST /ssot/data-governance/tag-taxonomies/actions/bulk-update` | | [Bulk delete tag taxonomies](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tag-taxonomies~1actions~1bulk-delete/post) | `POST /ssot/data-governance/tag-taxonomies/actions/bulk-delete` | | [Get tags](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags/get) | `GET /ssot/data-governance/tags` | | [Create tag](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags/post) | `POST /ssot/data-governance/tags` | | [Get tag](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D/get) | `GET /ssot/data-governance/tags/{fullyQualifiedName}` | | [Update tag](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D/patch) | `PATCH /ssot/data-governance/tags/{fullyQualifiedName}` | | [Delete tag](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D/delete) | `DELETE /ssot/data-governance/tags/{fullyQualifiedName}` | | [Get tag assignments on a tag](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D~1assignments/get) | `GET /ssot/data-governance/tags/{fullyQualifiedName}/assignments` | | [Create tag detection instruction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D~1detection-instructions/post) | `POST /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions` | | [Get tag detection instruction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D~1detection-instructions~1active/get) | `GET /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions/active` | | [Delete tag detection instruction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1%7BfullyQualifiedName%7D~1detection-instructions~1active/delete) | `DELETE /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions/active` | | [Bulk create tags](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1actions~1bulk-create/post) | `POST /ssot/data-governance/tags/actions/bulk-create` | | [Bulk update tags](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1actions~1bulk-update/post) | `POST /ssot/data-governance/tags/actions/bulk-update` | | [Bulk delete tags](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1actions~1bulk-delete/post) | `POST /ssot/data-governance/tags/actions/bulk-delete` | | [Propagate tags](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Governance/paths/~1ssot~1data-governance~1tags~1actions~1propagate/post) | `POST /ssot/data-governance/tags/actions/propagate` | ### Data Graphs Connect REST API endpoints for Data 360 data graphs: | Operation | Path | | --- | --- | | [Create data graph](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs/post) | `POST /ssot/data-graphs` | | [Get data graph data by entity name](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1data~1%7BdataGraphEntityName%7D/get) | `GET /ssot/data-graphs/data/{dataGraphEntityName}` | | [Get data graph data by ID](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1data~1%7BdataGraphEntityName%7D~1%7Bid%7D/get) | `GET /ssot/data-graphs/data/{dataGraphEntityName}/{id}` | | [Get data graph metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1metadata/get) | `GET /ssot/data-graphs/metadata` | | [Delete data graph](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1%7BdataGraphName%7D/delete) | `DELETE /ssot/data-graphs/{dataGraphName}` | | [Get data graph](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1%7BdataGraphName%7D/get) | `GET /ssot/data-graphs/{dataGraphName}` | | [Activate data graph](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1%7BdataGraphName%7D~1actions~1activate/post) | `POST /ssot/data-graphs/{dataGraphName}/actions/activate` | | [Refresh data graph](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Graphs/paths/~1ssot~1data-graphs~1%7BdataGraphName%7D~1actions~1refresh/post) | `POST /ssot/data-graphs/{dataGraphName}/actions/refresh` | ### Data Kits Connect REST API endpoints for Data 360 data kits: | Operation | Path | | --- | --- | | [Get data kits](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits/get) | `GET /ssot/data-kits` | | [Create data kit](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits/post) | `POST /ssot/data-kits` | | [Get data kit available components](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1available-components/get) | `GET /ssot/data-kits/available-components` | | [Delete data kit](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitDevName%7D/delete) | `DELETE /ssot/data-kits/{dataKitDevName}` | | [Update data kit components](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitDevName%7D/patch) | `PATCH /ssot/data-kits/{dataKitDevName}` | | [Deploy data kit components](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitDevName%7D/post) | `POST /ssot/data-kits/{dataKitDevName}` | | [Get data kit manifest](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitDevName%7D~1manifest/get) | `GET /ssot/data-kits/{dataKitDevName}/manifest` | | [Undeploy data kit component](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitName%7D~1undeploy/post) | `POST /ssot/data-kits/{dataKitName}/undeploy` | | [Get data kit component dependency](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitName%7D~1components~1%7BcomponentName%7D~1dependencies/get) | `GET /ssot/data-kits/{dataKitName}/components/{componentName}/dependencies` | | [Get data kit component status](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Kits/paths/~1ssot~1data-kits~1%7BdataKitName%7D~1components~1%7BcomponentName%7D~1deployment-status/get) | `GET /ssot/data-kits/{dataKitName}/components/{componentName}/deployment-status` | ### Data Lake Objects Connect REST API endpoints for Data 360 data lake objects (DLOs): | Operation | Path | | --- | --- | | [Get data lake objects](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Lake-Objects/paths/~1ssot~1data-lake-objects/get) | `GET /ssot/data-lake-objects` | | [Create data lake object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Lake-Objects/paths/~1ssot~1data-lake-objects/post) | `POST /ssot/data-lake-objects` | | [Delete data lake object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Lake-Objects/paths/~1ssot~1data-lake-objects~1%7BrecordIdOrDeveloperName%7D/delete) | `DELETE /ssot/data-lake-objects/{recordIdOrDeveloperName}` | | [Get data lake object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Lake-Objects/paths/~1ssot~1data-lake-objects~1%7BrecordIdOrDeveloperName%7D/get) | `GET /ssot/data-lake-objects/{recordIdOrDeveloperName}` | | [Update data lake object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Lake-Objects/paths/~1ssot~1data-lake-objects~1%7BrecordIdOrDeveloperName%7D/patch) | `PATCH /ssot/data-lake-objects/{recordIdOrDeveloperName}` | ### Data Model Objects Connect REST API endpoints for Data 360 data model objects (DMOs): | Operation | Path | | --- | --- | | [Get data model objects](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects/get) | `GET /ssot/data-model-objects` | | [Create data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects/post) | `POST /ssot/data-model-objects` | | [Delete data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1%7BdataModelObjectName%7D/delete) | `DELETE /ssot/data-model-objects/{dataModelObjectName}` | | [Get data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1%7BdataModelObjectName%7D/get) | `GET /ssot/data-model-objects/{dataModelObjectName}` | | [Update data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1%7BdataModelObjectName%7D/patch) | `PATCH /ssot/data-model-objects/{dataModelObjectName}` | | [Get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings/get) | `GET /ssot/data-model-object-mappings` | | [Create data model object mapping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings/post) | `POST /ssot/data-model-object-mappings` | | [Delete data model object mapping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings~1%7BobjectSourceTargetMapDeveloperName%7D/delete) | `DELETE /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}` | | [Get data model object mapping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings~1%7BobjectSourceTargetMapDeveloperName%7D/get) | `GET /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}` | | [Delete data model object field mapping](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings~1%7BobjectSourceTargetMapDeveloperName%7D~1field-mappings/delete) | `DELETE /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings` | | [Update data model object field mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-object-mappings~1%7BobjectSourceTargetMapDeveloperName%7D~1field-mappings~1%7BfieldSourceTargetMapDeveloperName%7D/patch) | `PATCH /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings/{fieldSourceTargetMapDeveloperName}` | | [Delete field source target relationship](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1relationships~1%7Bname%7D/delete) | `DELETE /ssot/data-model-objects/relationships/{name}` | | [Get field source target relationships](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1%7BdataModelObjectName%7D~1relationships/get) | `GET /ssot/data-model-objects/{dataModelObjectName}/relationships` | | [Create field source target relationships](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Model-Objects/paths/~1ssot~1data-model-objects~1%7BdataModelObjectName%7D~1relationships/post) | `POST /ssot/data-model-objects/{dataModelObjectName}/relationships` | ### Data Shares Connect REST API endpoints for Data 360 data shares and data share targets: | Operation | Path | | --- | --- | | [Get data shares](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-shares/get) | `GET /ssot/data-shares` | | [Create data share](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share/post) | `POST /ssot/data-share` | | [Delete data share](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share~1%7BnameOrId%7D/delete) | `DELETE /ssot/data-share/{nameOrId}` | | [Get data share](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share~1%7BnameOrId%7D/get) | `GET /ssot/data-share/{nameOrId}` | | [Update data share](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share~1%7BnameOrId%7D/patch) | `PATCH /ssot/data-share/{nameOrId}` | | [Link data share with target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share~1%7BnameOrId%7D~1actions~1link/post) | `POST /ssot/data-share/{nameOrId}/actions/link` | | [Unlink data share with target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share~1%7BnameOrId%7D~1actions~1unlink/post) | `POST /ssot/data-share/{nameOrId}/actions/unlink` | | [Create data share target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share-target/post) | `POST /ssot/data-share-target` | | [Delete data share target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share-target~1%7BnameOrId%7D/delete) | `DELETE /ssot/data-share-target/{nameOrId}` | | [Get data share target](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share-target~1%7BnameOrId%7D/get) | `GET /ssot/data-share-target/{nameOrId}` | | [Get data share targets](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Shares/paths/~1ssot~1data-share-targets~1%7BtargetType%7D/get) | `GET /ssot/data-share-targets/{targetType}` | ### Data Spaces Connect REST API endpoints for Data 360 data spaces: | Operation | Path | | --- | --- | | [Get data spaces](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces/get) | `GET /ssot/data-spaces` | | [Create data space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces/post) | `POST /ssot/data-spaces` | | [Get data space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D/get) | `GET /ssot/data-spaces/{idOrName}` | | [Update data space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D/patch) | `PATCH /ssot/data-spaces/{idOrName}` | | [Delete data space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D/delete) | `DELETE /ssot/data-spaces/{idOrName}` | | [Sync data space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1actions~1retry/post) | `POST /ssot/data-spaces/{idOrName}/actions/retry` | | [Delete data space members](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1members/delete) | `GET /ssot/data-spaces/{idOrName}/members` | | [Get data space members](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1members/get) | `GET /ssot/data-spaces/{idOrName}/members` | | [Upsert data space members](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1members/put) | `PUT /ssot/data-spaces/{idOrName}/members` | | [Get data space member](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1members~1%7BdataSpaceMemberObjectName%7D/get) | `GET /ssot/data-spaces/{idOrName}/members/{dataSpaceMemberObjectName}` | | [Sync data space member](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Spaces/paths/~1ssot~1data-spaces~1%7BidOrName%7D~1members~1%7BdataSpaceMemberObjectName%7D~1actions~1retry/post) | `POST /ssot/data-spaces/{idOrName}/members/{dataSpaceMemberObjectName}/actions/retry` | ### Data Streams Connect REST API endpoints for Data 360 data streams: | Operation | Path | | --- | --- | | [Get data streams](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams/get) | `GET /ssot/data-streams` | | [Create data stream](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams/post) | `POST /ssot/data-streams` | | [Delete data stream](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams~1%7BrecordIdOrDeveloperName%7D/delete) | `DELETE /ssot/data-streams/{recordIdOrDeveloperName}` | | [Get data stream](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams~1%7BrecordIdOrDeveloperName%7D/get) | `GET /ssot/data-streams/{recordIdOrDeveloperName}` | | [Update data stream](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams~1%7BrecordIdOrDeveloperName%7D/patch) | `PATCH /ssot/data-streams/{recordIdOrDeveloperName}` | | [Run data streams](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Streams/paths/~1ssot~1data-streams~1%7BrecordIdOrDeveloperName%7D~1actions~1run/post) | `POST /ssot/data-streams/{recordIdOrDeveloperName}/actions/run` | ### Data Transforms Connect REST API endpoints for Data 360 data transforms: | Operation | Path | | --- | --- | | [Get data transforms](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms/get) | `GET /ssot/data-transforms` | | [Create data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms/post) | `POST /ssot/data-transforms` | | [Delete data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D/delete) | `DELETE /ssot/data-transforms/{dataTransformNameOrId}` | | [Get data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D/get) | `GET /ssot/data-transforms/{dataTransformNameOrId}` | | [Update data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D/put) | `PUT /ssot/data-transforms/{dataTransformNameOrId}` | | [Cancel data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1actions~1cancel/post) | `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/cancel` | | [Rebuild data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1actions~1rebuild/post) | `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/rebuild` | | [Refresh data transform status](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1actions~1refresh-status/post) | `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/refresh-status` | | [Retry data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1actions~1retry/post) | `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/retry` | | [Run data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1actions~1run/post) | `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/run` | | [Get data transform run history](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1run-history/get) | `GET /ssot/data-transforms/{dataTransformNameOrId}/run-history` | | [Get data transform schedule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1schedule/get) | `GET /ssot/data-transforms/{dataTransformNameOrId}/schedule` | | [Update data transform schedule](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms~1%7BdataTransformNameOrId%7D~1schedule/put) | `PUT /ssot/data-transforms/{dataTransformNameOrId}/schedule` | | [Validate data transform](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Data-Transforms/paths/~1ssot~1data-transforms-validation/post) | `POST /ssot/data-transforms-validation` | ### Document AI Connect REST API endpoints for Data 360 Document AI: | Operation | Path | | --- | --- | | [Detect Document AI schema](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1actions~1detect-schema/post) | `POST /ssot/document-processing/actions/detect-schema` | | [Extract Document AI configuration data](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1actions~1extract-data/post) | `POST /ssot/document-processing/actions/extract-data` | | [Generate Document AI schema](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1actions~1generate-schema/post) | `POST /ssot/document-processing/actions/generate-schema` | | [Get Document AI configurations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations/get) | `GET /ssot/document-processing/configurations` | | [Create Document AI configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations/post) | `POST /ssot/document-processing/configurations` | | [Get Document AI configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations~1%7BidOrApiName%7D/get) | `GET /ssot/document-processing/configurations/{idOrApiName}` | | [Update Document AI configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations~1%7BidOrApiName%7D/patch) | `PATCH /ssot/document-processing/configurations/{idOrApiName}` | | [Delete Document AI configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations~1%7BidOrApiName%7D/delete) | `DELETE /ssot/document-processing/configurations/{idOrApiName}` | | [Run Document AI process](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1configurations~1%7BidOrApiName%7D~1actions~1run/post) | `POST /ssot/document-processing/configurations/{idOrApiName}/actions/run` | | [Get Document AI global configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1global-config/get) | `GET /ssot/document-processing/global-config` | ### Identity Resolutions Connect REST API endpoints for Data 360 identity resolutions: | Operation | Path | | --- | --- | | [Get identity resolution rulesets](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions/get) | `GET /ssot/identity-resolutions` | | [Create identity resolution ruleset](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions/post) | `POST /ssot/identity-resolutions` | | [Delete identity resolution ruleset](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions~1%7BidentityResolution%7D/delete) | `DELETE /ssot/identity-resolutions/{identityResolution}` | | [Get identity resolution ruleset](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions~1%7BidentityResolution%7D/get) | `GET /ssot/identity-resolutions/{identityResolution}` | | [Update identity resolution ruleset](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions~1%7BidentityResolution%7D/patch) | `PATCH /ssot/identity-resolutions/{identityResolution}` | | [Run identity resolution ruleset now](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Identity-Resolutions/paths/~1ssot~1identity-resolutions~1%7BidentityResolution%7D~1actions~1run-now/post) | `POST /ssot/identity-resolutions/{identityResolution}/actions/run-now` | ### Insights Connect REST API endpoints for Data 360 insights: | Operation | Path | | --- | --- | | [Get calculated insight object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Insights/paths/~1ssot~1insight~1calculated-insights~1%7BciName%7D/get) | `GET /ssot/insight/calculated-insights/{ciName}` | | [Get insight metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Insights/paths/~1ssot~1insight~1metadata/get) | `GET /ssot/insight/metadata` | | [Get calculated insight object metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Insights/paths/~1ssot~1insight~1metadata~1%7BciName%7D/get) | `GET /ssot/insight/metadata/{ciName}` | ### Machine Learning Connect REST API endpoints for Data 360 machine learning: | Operation | Path | | --- | --- | | [Create data alert](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1alerts/post) | `POST /ssot/machine-learning/alerts` | | [Update data alert](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1alerts~1%7BalertId%7D/patch) | `PATCH /ssot/machine-learning/alerts/{alertId}` | | [Get configured models](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1configured-models/get) | `GET /ssot/machine-learning/configured-models` | | [Delete configured model](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1configured-models~1%7BconfiguredModelIdOrName%7D/delete) | `DELETE /ssot/machine-learning/configured-models/{configuredModelIdOrName}` | | [Get configured model](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1configured-models~1%7BconfiguredModelIdOrName%7D/get) | `GET /ssot/machine-learning/configured-models/{configuredModelIdOrName}` | | [Update configured model](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1configured-models~1%7BconfiguredModelIdOrName%7D/patch) | `PATCH /ssot/machine-learning/configured-models/{configuredModelIdOrName}` | | [Get predict jobs](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1jobs/get) | `GET /ssot/machine-learning/jobs` | | [Get a predict job](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1jobs~1%7BjobId%7D/get) | `GET /ssot/machine-learning/jobs/{jobId}` | | [Get predict job tasks](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1jobs~1%7BjobId%7D~1tasks/get) | `GET /ssot/machine-learning/jobs/{jobId}/tasks` | | [Get a predict job task](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1jobs~1%7BjobId%7D~1tasks~1%7BtaskId%7D/get) | `GET /ssot/machine-learning/jobs/{jobId}/tasks/{taskId}` | | [Get model artifacts](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-artifacts/get) | `GET /ssot/machine-learning/model-artifacts` | | [Delete model artifact](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-artifacts~1%7BmodelArtifactIdOrName%7D/delete) | `DELETE /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` | | [Get model artifact](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-artifacts~1%7BmodelArtifactIdOrName%7D/get) | `GET /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` | | [Update model artifact](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-artifacts~1%7BmodelArtifactIdOrName%7D/patch) | `PATCH /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` | | [Get model setup versions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions` | | [Create model setup version](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions/post) | `POST /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions` | | [Get model setup version](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions~1%7BmodelSetupVersionId%7D/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}` | | [Update model setup version](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions~1%7BmodelSetupVersionId%7D/patch) | `PATCH /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}` | | [Get model setup version partitions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions~1%7BmodelSetupVersionId%7D~1partitions/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions` | | [Get model setup version partition](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1model-setups~1%7BmodelSetupIdOrName%7D~1setup-versions~1%7BmodelSetupVersionId%7D~1partitions~1%7BmodelSetupPartitionId%7D/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Get prediction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1predict/post) | `POST /ssot/machine-learning/prediction-job-definitions` | | [Get prediction job definitions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1prediction-job-definitions/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Create a prediction job definition](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1prediction-job-definitions/post) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Get prediction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1predict/post) | `POST /ssot/machine-learning/prediction-job-definitions` | | [Delete a prediction job definition](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1prediction-job-definitions~1%7BpredictionJobDefIdOrName%7D/delete) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Get prediction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1predict/post) | `POST /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` | | [Get a prediction job definition](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1prediction-job-definitions~1%7BpredictionJobDefIdOrName%7D/get) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Get prediction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1predict/post) | `POST /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` | | [Update a prediction job definition](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1prediction-job-definitions~1%7BpredictionJobDefIdOrName%7D/patch) | `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` | | [Get prediction](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1predict/post) | `POST /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` | | [Get retrievers](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers/get) | `GET /ssot/machine-learning/retrievers` | | [Create retriever](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers/post) | `POST /ssot/machine-learning/retrievers` | | [Review retriever](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1actions~1review/post) | `POST /ssot/machine-learning/retrievers/actions/review` | | [Delete retriever](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D/delete) | `DELETE /ssot/machine-learning/retrievers/{retrieverIdOrName}` | | [Get retriever](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D/get) | `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}` | | [Update retriever](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D/patch) | `PATCH /ssot/machine-learning/retrievers/{retrieverIdOrName}` | | [Get retriever configurations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D~1configurations/get) | `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations` | | [Create retriever configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D~1configurations/post) | `POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations` | | [Delete retriever configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D~1configurations~1%7BretrieverConfigurationIdOrName%7D/delete) | `DELETE /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` | | [Get retriever configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D~1configurations~1%7BretrieverConfigurationIdOrName%7D/get) | `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` | | [Update retriever configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Machine-Learning/paths/~1ssot~1machine-learning~1retrievers~1%7BretrieverIdOrName%7D~1configurations~1%7BretrieverConfigurationIdOrName%7D/patch) | `PATCH /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` | ### Metadata Connect REST API endpoints for Data 360 metadata: | Operation | Path | | --- | --- | | [Get metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1metadata/get) | `GET /ssot/metadata` | | [Get metadata entities](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1metadata-entities/get) | `GET /ssot/metadata-entities` | | [Get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Connections/paths/~1ssot~1connectors~1%7BconnectorType%7D/get) | `GET /ssot/connectors/{connectorType}` | | [Get data graph metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1data-graphs~1metadata/get) | `GET /ssot/data-graphs/metadata` | | [Get insight metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1insight~1metadata/get) | `GET /ssot/insight/metadata` | | [Get calculated insight metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1insight~1metadata~1%7BciName%7D/get) | `GET /ssot/insight/metadata/{ciName}` | | [Get profile metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1profile~1metadata/get) | `GET /ssot/profile/metadata` | | [Get profile data model object metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Metadata/paths/~1ssot~1profile~1metadata~1%7BdataModelName%7D/get) | `GET /ssot/profile/metadata/{dataModelName}` | ### Notebook AI Connect REST API endpoints for Data 360 Notebook AI: | Operation | Path | | --- | --- | | [Get knowledge spaces](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space/get) | `GET /ssot/knowledge-space` | | [Create knowledge space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space/post) | `POST /ssot/knowledge-space` | | [Get knowledge space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D/get) | `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` | | [Update knowledge space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D/patch) | `PATCH /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` | | [Delete knowledge space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D/delete) | `DELETE /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` | | [Get knowledge space details](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D~1details/get) | `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/details` | | [Provision knowledge space](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1provision/post) | `POST /ssot/knowledge-space/provision` | | [Get knowledge space configurations](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1config/get) | `GET /ssot/knowledge-space/config` | | [Create knowledge space configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1config/post) | `POST /ssot/knowledge-space/config` | | [Get knowledge space configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1config~1%7BknowledgeSpaceConfigApiNameOrId%7D/get) | `GET /ssot/knowledge-space/config/{knowledgeSpaceConfigApiNameOrId}` | | [Delete knowledge space configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1config~1%7BknowledgeSpaceConfigApiNameOrId%7D/delete) | `DELETE /ssot/knowledge-space/config/{knowledgeSpaceConfigApiNameOrId}` | | [Get knowledge libraries](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library/get) | `GET /ssot/knowledge-space/library` | | [Create knowledge library](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library/post) | `POST /ssot/knowledge-space/library` | | [Update knowledge library](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library~1%7Bid%7D/patch) | `PATCH /ssot/knowledge-space/library/{id}` | | [Get knowledge library details](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library~1%7BlibraryId%7D~1details/get) | `GET /ssot/knowledge-space/library/{libraryId}/details` | | [Remove knowledge library](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library~1remove-library/post) | `POST /ssot/knowledge-space/library/remove-library` | | [Search knowledge libraries](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1library~1search/post) | `POST /ssot/knowledge-space/library/search` | | [Get presigned URLs](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1presigned-urls/post) | `POST /ssot/knowledge-space/presigned-urls` | | [Index files](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1index-files/post) | `POST /ssot/knowledge-space/index-files` | | [Get file status](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1files~1status/post) | `POST /ssot/knowledge-space/files/status` | | [Remove files](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1remove-files/post) | `POST /ssot/knowledge-space/remove-files` | | [Get file chunks summary](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1summary/post) | `POST /ssot/knowledge-space/summary` | | [Get knowledge for import](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1getKnowledgeForImport/post) | `POST /ssot/knowledge-space/getKnowledgeForImport` | | [Import knowledge](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1importKnowledge/post) | `POST /ssot/knowledge-space/importKnowledge` | | [Run deep research job](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1deep-research~1%7BresearchId%7D~1run/post) | `POST /ssot/knowledge-space/deep-research/{researchId}/run` | | [Get deep research status](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1deep-research~1%7BresearchId%7D/get) | `GET /ssot/knowledge-space/deep-research/{researchId}` | | [Update deep research plan](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1deep-research~1%7BresearchId%7D/patch) | `PATCH /ssot/knowledge-space/deep-research/{researchId}` | | [Cancel deep research job](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1deep-research~1%7BresearchId%7D~1cancel/post) | `POST /ssot/knowledge-space/deep-research/{researchId}/cancel` | | [Get deep research report](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1deep-research~1%7BresearchId%7D~1report/post) | `POST /ssot/knowledge-space/deep-research/{researchId}/report` | | [Add deep research as knowledge source](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1space~1%7BknowledgeSpaceApiNameOrId%7D~1deep-research~1source/post) | `POST /ssot/knowledge-space/space/{knowledgeSpaceApiNameOrId}/deep-research/source` | | [Get knowledge space sessions](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D~1sessions/get) | `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/sessions` | | [Get knowledge space session](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1session~1%7BknowledgeSpaceSessionId%7D/get) | `GET /ssot/knowledge-space/session/{knowledgeSpaceSessionId}` | | [Create knowledge space session](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D~1sessions/post) | `POST /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/sessions` | | [Delete knowledge space session](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1session~1%7BknowledgeSpaceSessionId%7D/delete) | `DELETE /ssot/knowledge-space/session/{knowledgeSpaceSessionId}` | | [Get session conversation](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Notebook-AI/paths/~1ssot~1knowledge-space~1%7BknowledgeSpaceApiNameOrId%7D~1session~1%7BknowledgeSpaceSessionId%7D~1conversation/get) | `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/session/{knowledgeSpaceSessionId}/conversation` | ### Private Network Routes Connect REST API endpoints for Data 360 Private Network Routes: | Operation | Path | | --- | --- | | [Get private network routes](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Private-Network-Routes/paths/~1ssot~1private-network-routes/get) | `GET /ssot/private-network-routes` | | [Create private network route](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Private-Network-Routes/paths/~1ssot~1private-network-routes/post) | `POST /ssot/private-network-routes` | | [Delete private network route](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Private-Network-Routes/paths/~1ssot~1private-network-routes~1%7BrouteIdOrName%7D/delete) | `DELETE /ssot/private-network-routes/{routeIdOrName}` | | [Get private network route](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Private-Network-Routes/paths/~1ssot~1private-network-routes~1%7BrouteIdOrName%7D/get) | `GET /ssot/private-network-routes/{routeIdOrName}` | ### Profile Connect REST API endpoints for Data 360 profile: | Operation | Path | | --- | --- | | [Get profile metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1metadata/get) | `GET /ssot/profile/metadata` | | [Get profile data model object metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1metadata~1%7BdataModelName%7D/get) | `GET /ssot/profile/metadata/{dataModelName}` | | [Get profile data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1%7BdataModelName%7D/get) | `GET /ssot/profile/{dataModelName}` | | [Get profile data model object with search key](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1%7BdataModelName%7D~1%7Bid%7D/get) | `GET /ssot/profile/{dataModelName}/{id}` | | [Get profile data model object and calculated insight with search key](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1%7BdataModelName%7D~1%7Bid%7D~1calculated-insights~1%7BciName%7D/get) | `GET /ssot/profile/{dataModelName}/{id}/calculated-insights/{ciName}` | | [Get profile data model object and child object with search key](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Profile/paths/~1ssot~1profile~1%7BdataModelName%7D~1%7Bid%7D~1%7BchildDataModelName%7D/get) | `GET /ssot/profile/{dataModelName}/{id}/{childDataModelName}` | ### Query V1 & V2 Connect REST API endpoints for Data 360 query V1 and V2: | Operation | Path | | --- | --- | | [Query data V1](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-V1-&-V2/paths/~1ssot~1query/post) | `POST /ssot/query` | | [Query data V2](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-V1-&-V2/paths/~1ssot~1queryv2/post) | `POST /ssot/queryv2` | | [Query batch data V1](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-V1-&-V2/paths/~1ssot~1queryv2~1%7BnextBatchId%7D/get) | `GET /ssot/queryv2/{nextBatchId}` | ### Query (Current) Connect REST API endpoints for Data 360 query SQL: | Operation | Path | | --- | --- | | [Submit SQL query](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-\(Current\)/paths/~1ssot~1query-sql/post) | `POST /ssot/query-sql` | | [Cancel SQL query](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-\(Current\)/paths/~1ssot~1query-sql~1%7BqueryId%7D/delete) | `DELETE /ssot/query-sql/{queryId}` | | [Get SQL query status](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-\(Current\)/paths/~1ssot~1query-sql~1%7BqueryId%7D/get) | `GET /ssot/query-sql/{queryId}` | | [Get SQL query rows](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Query-\(Current\)/paths/~1ssot~1query-sql~1%7BqueryId%7D~1rows/get) | `GET /ssot/query-sql/{queryId}/rows` | ### Search Index Connect REST API endpoints for Data 360 search index: | Operation | Path | | --- | --- | | [Get semantic search definition details](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index/get) | `GET /ssot/search-index` | | [Create semantic search](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index/post) | `POST /ssot/search-index` | | [Get semantic search configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index~1config/get) | `GET /ssot/search-index/config` | | [Delete semantic search](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index~1%7BsearchIndexApiNameOrId%7D/delete) | `DELETE /ssot/search-index/{searchIndexApiNameOrId}` | | [Get semantic search](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index~1%7BsearchIndexApiNameOrId%7D/get) | `GET /ssot/search-index/{searchIndexApiNameOrId}` | | [Update semantic search](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Search-Index/paths/~1ssot~1search-index~1%7BsearchIndexApiNameOrId%7D/patch) | `PATCH /ssot/search-index/{searchIndexApiNameOrId}` | ### Segments Connect REST API endpoints for Data 360 segments: | Operation | Path | | --- | --- | | [Get segments](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments/get) | `GET /ssot/segments` | | [Create segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments/post) | `POST /ssot/segments` | | [Get segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiNameOrId%7D/get) | `GET /ssot/segments/{segmentApiNameOrId}` | | [Delete segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiName%7D/delete) | `DELETE /ssot/segments/{segmentApiName}` | | [Update segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiName%7D/patch) | `PATCH /ssot/segments/{segmentApiName}` | | [Count segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiName%7D~1actions~1count/post) | `POST /ssot/segments/{segmentApiName}/actions/count` | | [Deactivate segment by name](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiName%7D~1actions~1deactivate/post) | `POST /ssot/segments/{segmentApiName}/actions/deactivate` | | [Get segment members](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentApiName%7D~1members/get) | `GET /ssot/segments/{segmentApiName}/members` | | [Deactivate segment by ID](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentId%7D~1actions~1deactivate/post) | `POST /ssot/segments/{segmentId}/actions/deactivate` | | [Publish segment](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Segments/paths/~1ssot~1segments~1%7BsegmentId%7D~1actions~1publish/post) | `POST /ssot/segments/{segmentId}/actions/publish` | ### Universal ID Lookup Connect REST API endpoint for Data 360 universal ID lookup: | Operation | Path | | --- | --- | | [Lookup universal ID](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Universal-ID-Lookup/paths/~1ssot~1universalIdLookup~1%7BentityName%7D~1%7BdataSourceId%7D~1%7BdataSourceObjectId%7D~1%7BsourceRecordId%7D/get) | `GET /ssot/universalIdLookup/{entityName}/{dataSourceId}/{dataSourceObjectId}/{sourceRecordId}` | ## Operations ### GET Get activation external platforms `GET /ssot/activation-external-platforms` Tags: Activation External Platforms. Get a paginated list of activation external platforms. **Available Version:** 64.0 #### Parameters * `batchSize` (query, integer) Number of external platforms to return. Values are from `1` through `20`. If unspecified, the default value is `20`. **Available Version:** 64.0 * `limit` (query, integer) Maximum number of external platforms to return. If unspecified, the default value is `20`. **Available Version:** 64.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be greater than or equal to `0`. If unspecified, no rows are skipped. **Available Version:** 64.0 * `orderBy` (query, string) Order in which to sort the results based on the `createdDate` field. Specify the field name followed by `asc` for ascending order or `desc` for descending order. If you specify only the field name or omit the parameter, results are sorted in ascending order. For example, `createdDate asc` and `createdDate` yield the same results. **Available Version:** 64.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationExternalPlatformCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "/services/data/v64.0/ssot/activation-external-platforms?batchSize=10&offset=0", "platforms": [ { "attributeConfig": { "attributes": [ { "destinationName": "EmailAddress", "displayName": "EmailAddress" }, { "destinationName": "phone", "displayName": "phone" } ] }, "createdDate": "2025-07-30T20:06:08.000Z", "keyPrefixName": "cdpactvstrgptnr", "label": "Amazon Platform", "lastModifiedDate": "2025-08-19T05:12:16.000Z", "name": "AmazonPlatform", "privacyType": "THIRDPARTY", "status": "ACTIVE", "type": "ADVERTISING" }, { "attributeConfig": { "attributes": [] }, "createdDate": "2025-08-12T07:20:26.000Z", "creationType": "MANUAL", "keyPrefixName": "EcoSystem1", "label": "advertising platform", "lastModifiedDate": "2025-08-12T07:20:33.000Z", "name": "advertising_platform", "status": "ACTIVE", "type": "ADVERTISING" }, { "attributeConfig": { "attributes": [ { "destinationName": "fName", "displayName": "First Name" }, { "destinationName": "lname", "displayName": "Last Name" } ] }, "createdDate": "2025-08-12T07:20:26.000Z", "creationType": "JSON", "keyPrefixName": "EcoSystem1", "label": "test_group_by_seg", "lastModifiedDate": "2025-08-12T07:20:32.000Z", "name": "test_group_by_seg", "status": "ACTIVE", "type": "PUBLISHING" } ], "totalSize": 3 } ``` ### GET Get activation external platform `GET /ssot/activation-external-platforms/{idOrName}` Tags: Activation External Platforms. Get a specific activation external platform. **Available Version:** 67.0 #### Parameters * `actionSource` (query, string) Action source used, together with `eventName`, to scope the returned attribute configuration. **Available Version:** 67.0 * `eventName` (query, string) Standard event name used, together with `actionSource`, to scope the returned attribute configuration. For example, the platform's standard event. **Available Version:** 67.0 * `idOrName` (path, string, required) Unique identifier of a specific activation external platform, such as the ID or developer name. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationExternalPlatformRepresentation`. _Example: Example_ ``` { "attributeConfig": { "attributes": [ { "destinationName": "action_source", "displayName": "Action Source", "valueSource": "CONSTANT", "values": [ "website" ] }, { "destinationName": "event_id", "displayName": "Event Id", "valueSource": "MAPPED" }, { "destinationName": "event_name", "displayName": "Event Name", "valueSource": "CONSTANT", "values": [ "AddToCart" ] }, { "destinationName": "event_time", "displayName": "Event Time", "valueSource": "MAPPED" }, { "destinationName": "event_source_url", "displayName": "Event Source URL", "valueSource": "MAPPED" }, { "destinationName": "custom__content_name", "displayName": "Content Name", "valueSource": "MAPPED" }, { "destinationName": "opt_out", "displayName": "Ads Delivery Opt-out", "valueSource": "MAPPED" }, { "destinationName": "custom__value", "displayName": "Value", "valueSource": "MAPPED" }, { "destinationName": "custom__contents", "displayName": "Contents", "valueSource": "MAPPED" }, { "destinationName": "fb_login_id", "displayName": "Facebook Login ID", "valueSource": "MAPPED" }, { "destinationName": "fbc", "displayName": "Click ID", "valueSource": "MAPPED" }, { "destinationName": "custom__content_ids", "displayName": "Content Ids", "valueSource": "MAPPED" }, { "destinationName": "external_id", "displayName": "External Id", "valueSource": "MAPPED" }, { "destinationName": "custom__currency", "displayName": "Currency", "valueSource": "MAPPED" }, { "destinationName": "custom__predicted_ltv", "displayName": "Predicted lifetime value", "valueSource": "MAPPED" }, { "destinationName": "data_processing_options_state", "displayName": "Data Processing Options State", "valueSource": "MAPPED" }, { "destinationName": "fbp", "displayName": "Facebook Browser ID", "valueSource": "MAPPED" }, { "destinationName": "custom__content_category", "displayName": "Content Category", "valueSource": "MAPPED" }, { "destinationName": "custom__quantity", "displayName": "Quantity", "valueSource": "MAPPED" }, { "destinationName": "data_processing_options_country", "displayName": "Data Processing Options Country", "valueSource": "MAPPED" }, { "destinationName": "data_processing_options", "displayName": "Data Processing Options", "valueSource": "MAPPED" }, { "destinationName": "referrer_url", "displayName": "Referrer url", "valueSource": "MAPPED" }, { "destinationName": "gen", "displayName": "Gender", "valueSource": "MAPPED" }, { "destinationName": "ct", "displayName": "City", "valueSource": "MAPPED" }, { "destinationName": "st", "displayName": "State", "valueSource": "MAPPED" }, { "destinationName": "country", "displayName": "Country", "valueSource": "MAPPED" }, { "destinationName": "ln", "displayName": "Last Name", "valueSource": "MAPPED" }, { "destinationName": "zp", "displayName": "Zip Code", "valueSource": "MAPPED" }, { "destinationName": "client_user_agent", "displayName": "Client User Agent", "valueSource": "MAPPED" }, { "destinationName": "em", "displayName": "Email Address", "valueSource": "MAPPED" }, { "destinationName": "ph", "displayName": "Phone Number", "valueSource": "MAPPED" }, { "destinationName": "fn", "displayName": "First Name", "valueSource": "MAPPED" }, { "destinationName": "client_ip_address", "displayName": "Client IP Address", "valueSource": "MAPPED" }, { "destinationName": "db", "displayName": "Date of Birth", "valueSource": "MAPPED" } ] }, "createdDate": "2026-05-15T01:56:57.000Z", "id": "1sqxx0000000087AAA", "keyPrefixName": "cdpactvstrgptnr", "label": "Meta Conversions API", "lastModifiedDate": "2026-06-29T22:59:44.000Z", "name": "Meta_Conversions_API", "status": "ACTIVE", "type": "ADVERTISING" } ``` ### GET Get activation platforms `GET /ssot/activation-platforms` Tags: Activation Platforms. Returns a paginated list of activation platforms. **Available Version:** 67.0 #### Parameters * `activationPlatformView` (query, string) Set of platforms to return. If unspecified, the default value is `All`. **Available Version:** 67.0 Allowed values: `All`, `Developer`, `Subscriber`. * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression in the form ` `. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPlatformsCollectionRepresentation`. _Example: example1_ ``` { "activationPlatforms": [ { "activationPlatformCreationType": null, "canPublishNow": false, "enabled": true, "id": "1sqxx00000001ybAAA", "label": "Google Ads Platform", "name": "PremiumPartnerGoogle", "platformProcessingType": "Batch", "platformType": "Advertising", "status": "Error" }, { "activationPlatformCreationType": null, "canPublishNow": false, "enabled": true, "id": "1sqxx000000021pAAA", "label": "Google Ads Platform v2", "name": "PremiumPartnerGoogle_v2", "platformProcessingType": "Batch", "platformType": "Advertising", "status": "Error" }, { "activationPlatformCreationType": null, "canPublishNow": false, "enabled": true, "id": "1sqxx0000000253AAA", "label": "Meta (Facebook)", "name": "PremiumPartnerMeta", "platformProcessingType": "Batch", "platformType": "Advertising", "status": "Active" }, { "activationPlatformCreationType": null, "canPublishNow": false, "enabled": true, "id": "1sqxx000000028HAAQ", "label": "LinkedIn Advertising", "name": "LinkedIn_Advertising", "platformProcessingType": "Batch", "platformType": "Advertising", "status": "Active" }, { "activationPlatformCreationType": "Json", "canPublishNow": false, "enabled": false, "id": "1sqxx000000029tAAA", "label": "abc-user-identifiers", "name": "abc_user_identifiers", "platformProcessingType": "Batch", "platformType": "Advertising", "status": "Processing" } ], "batchSize": 5, "offset": 0, "totalSize": 5 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Create activation platform `POST /ssot/activation-platforms` Tags: Activation Platforms. Creates an activation platform. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ActivationPlatformCreateInputRepresentation`. _Example: example1_ ``` { "name": "abc_user_identifiers", "label": "abc-user-identifiers", "description": "Activation platform to activate only user identifiers", "platformType": "Advertising", "outputFormat": "Csv", "outputGrouping": "PerAccount", "refreshSettings": { "mode": "Full", "frequency": "TwentyFourHours" }, "connector": { "bucketName": "example-uswest2-cdp001-sample-data", "exportDirectory": "datacloud-activations" }, "activationPlatformAttributes": [ { "name": "EmailAddress", "label": "Hashed Email", "destinationName": "EmailAddress", "objectName": "ContactPointEmail", "fieldName": "Email", "isRequired": true, "applyHash": true, "isIdentifier": true }, { "name": "PhoneNumber", "label": "Hashed Phone", "destinationName": "PhoneNumber", "objectName": "ContactPointPhone", "fieldName": "E164FormattedPhoneNumber", "isRequired": true, "applyHash": true, "isIdentifier": true }, { "name": "DigitalIdValue", "label": "Hashed Digital id value", "destinationName": "DigitalIdValue", "objectName": "ContactPointDigitalId", "fieldName": "DigitalIdValue", "isRequired": true, "applyHash": true, "isIdentifier": true } ], "fields": [ { "name": "AccountId", "helpText": "", "isRequired": true, "isHidden": false, "type": "Text" }, { "name": "AccountName", "helpText": "", "isRequired": false, "isHidden": true, "type": "Text", "values": [ { "isDefault": true, "value": "Name of your account" } ] } ], "customMetadata": { "connectorType": "S3", "accessKey": "DUMMY1234EXAMPLE5678KEY", "secretKey": "dUmMySeCrEtKeY12345EXAMPLE67890" }, "additionalMetadata": { "hashMethod": "SHA256", "outputProperties": { "outputFormat": "Csv", "compression": "Gzip", "maxFileSizeInMB": 128, "maxRecordsPerFile": 1000000, "minRecordsPerFile": 10000, "outputPartitions": 20, "delimiter": "Comma" }, "partnerSupportedIds": [ { "destinationName": "DigitalIdValue", "supportedIdTypes": [ "Google", "Facebook", "Trade desk", "Instagram" ] } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPlatformRepresentation`. _Example: example1_ ``` { "activationFlowType": null, "activationPlatformAttributes": [ { "activationPlatformId": "1sqxx000000029tAAA", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "EmailAddress", "fieldName": "Email", "id": "9xuxx00000000o1AAA", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Email", "name": "abc_user_identifiers1786035439839", "objectName": "ContactPointEmail" }, { "activationPlatformId": "1sqxx000000029tAAA", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "PhoneNumber", "fieldName": "E164FormattedPhoneNumber", "id": "9xuxx00000000o2AAA", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Phone", "name": "abc_user_identifiers1786035440239", "objectName": "ContactPointPhone" }, { "activationPlatformId": "1sqxx000000029tAAA", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "DigitalIdValue", "fieldName": "DigitalIdValue", "id": "9xuxx00000000o3AAA", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Digital id value", "name": "abc_user_identifiers1786035440613", "objectName": "ContactPointDigitalId" } ], "activationPlatformCreationType": "Json", "additionalMetadata": { "activationPlatformEventMetadata": null, "customAttributePrefix": null, "customerFileSources": [], "hashMethod": "SHA256", "mappingSchemas": [], "outputProperties": { "compression": "Gzip", "delimiter": "Comma", "maxFileSizeInMB": 128, "maxRecordsPerFile": 1000000, "minRecordsPerFile": 10000, "outputFormat": "Csv", "outputPartitions": 20 }, "partnerSupportedIds": [ { "destinationName": "DigitalIdValue", "supportedIdTypes": [ "Google", "Facebook", "Trade desk", "Instagram" ] } ] }, "canPublishNow": false, "connector": { "bucketName": "example-uswest2-cdp001-sample-data", "id": "9u8xx00000000HlAAI", "exportDirectory": "datacloud-activations" }, "connectorType": null, "createdBy": null, "createdDate": "2026-08-06T16:57:18.000Z", "customerIdTypeMapping": null, "description": "Activation platform to activate only user identifiers", "enabled": false, "errorCode": null, "eventParameterHierarchyMap": {}, "eventParameters": [], "externalProvider": null, "fields": [ { "activationPlatformId": "1sqxx000000029tAAA", "activationPlatformName": "abc_user_identifiers", "helpText": null, "id": "8q9xx00000001IfAAI", "isHidden": false, "isRequired": true, "label": "AccountId", "name": "abc_user_identifiers1786035438237", "type": "Text", "values": [ { "activationPlatformFieldId": "8q9xx00000001IfAAI", "id": "5q9xx00000001IgAAI", "isDefault": true, "value": null } ] }, { "activationPlatformId": "1sqxx000000029tAAA", "activationPlatformName": "abc_user_identifiers", "helpText": null, "id": "8q9xx00000001IhAAI", "isHidden": true, "isRequired": false, "label": "AccountName", "name": "abc_user_identifiers1786035439059", "type": "Text", "values": [ { "activationPlatformFieldId": "8q9xx00000001IhAAI", "id": "5q9xx00000001IiAAI", "isDefault": true, "value": "Name of your account" } ] } ], "id": "1sqxx000000029tAAA", "identifiers": [], "includeSegmentNames": false, "isStrategicPartner": false, "label": "abc-user-identifiers", "lastModifiedBy": null, "lastModifiedDate": "2026-08-06T16:57:18.000Z", "logoUrl": null, "name": "abc_user_identifiers", "namespace": null, "notes": null, "outputFormat": "Csv", "outputGrouping": "PerAccount", "platformProcessingType": "Batch", "platformType": "Advertising", "privacyType": null, "refreshSettings": { "frequency": "TwentyFourHours", "mode": "Full", "periodicFullRefresh": null }, "showEventSourceAnnotations": false, "status": "Processing", "supportedEventTypes": [] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation platform `GET /ssot/activation-platforms/{idOrName}` Tags: Activation Platforms. Returns an activation platform by record ID or API name. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) Record ID (18-character) or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPlatformRepresentation`. _Example example1: same as POST /ssot/activation-platforms 200 response._ * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### DELETE Delete activation platform `DELETE /ssot/activation-platforms/{idOrName}` Tags: Activation Platforms. Deletes an activation platform. Returns a 412 error if the platform is referenced by activation targets or market segment activations. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) Record ID (18-character) or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### PATCH Update activation platform `PATCH /ssot/activation-platforms/{idOrName}` Tags: Activation Platforms. Updates an activation platform by record ID or API name. Only the fields you provide are modified. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) Record ID (18-character) or API name of the activation platform. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ActivationPlatformInputRepresentation`. _Example: example1_ ``` { "label": "abc-user-identifiers", "description": "Activation platform to activate only user identifiers", "platformProcessingType": "Batch", "outputFormat": "Csv", "outputGrouping": "PerAccount", "refreshSettings": { "mode": "Full", "frequency": "TwentyFourHours" }, "connector": { "bucketName": "example-uswest2-cdp001-sample-data", "exportDirectory": "datacloud-activations" }, "activationPlatformAttributes": [ { "name": "abc_user_identifiers1786055100289", "label": "Hashed Email", "destinationName": "EmailAddress", "objectName": "ContactPointEmail", "fieldName": "Email", "isRequired": true, "applyHash": true, "isIdentifier": true }, { "name": "abc_user_identifiers1786055100347", "label": "Hashed Phone", "destinationName": "PhoneNumber", "objectName": "ContactPointPhone", "fieldName": "E164FormattedPhoneNumber", "isRequired": true, "applyHash": true, "isIdentifier": true }, { "name": "abc_user_identifiers1786055100399", "label": "Hashed Digital id value", "destinationName": "DigitalIdValue", "objectName": "ContactPointDigitalId", "fieldName": "DigitalIdValue", "isRequired": true, "applyHash": true, "isIdentifier": true } ], "fields": [ { "name": "abc_user_identifiers1786055100029", "label": "AccountId", "isRequired": true, "isHidden": false, "type": "Text" }, { "name": "abc_user_identifiers1786055100166", "label": "AccountName", "isRequired": false, "isHidden": true, "type": "Text" } ], "additionalMetadata": { "hashMethod": "SHA256", "outputProperties": { "outputFormat": "Csv", "compression": "Gzip", "maxFileSizeInMB": 128, "maxRecordsPerFile": 1000000, "minRecordsPerFile": 10000, "outputPartitions": 20, "delimiter": "Comma" }, "partnerSupportedIds": [ { "destinationName": "DigitalIdValue", "supportedIdTypes": [ "Google", "Facebook", "Trade desk", "Instagram" ] } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPlatformRepresentation`. _Example: example1_ ``` { "activationFlowType": null, "activationPlatformAttributes": [ { "activationPlatformId": "1sqVF000000FRRJYA4", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "EmailAddress", "fieldName": "Email", "id": "9xuVF000000HojZYAS", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Email", "name": "abc_user_identifiers1786055100289", "objectName": "ContactPointEmail" }, { "activationPlatformId": "1sqVF000000FRRJYA4", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "PhoneNumber", "fieldName": "E164FormattedPhoneNumber", "id": "9xuVF000000HojaYAC", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Phone", "name": "abc_user_identifiers1786055100347", "objectName": "ContactPointPhone" }, { "activationPlatformId": "1sqVF000000FRRJYA4", "activationPlatformName": "abc_user_identifiers", "applyHash": true, "destinationName": "DigitalIdValue", "fieldName": "DigitalIdValue", "id": "9xuVF000000HojbYAC", "identifier": null, "isConstant": false, "isFromSourceObject": false, "isIdentifier": true, "isRequired": true, "label": "Hashed Digital id value", "name": "abc_user_identifiers1786055100399", "objectName": "ContactPointDigitalId" } ], "activationPlatformCreationType": "Json", "additionalMetadata": { "activationPlatformEventMetadata": null, "customAttributePrefix": null, "customerFileSources": [], "hashMethod": "SHA256", "mappingSchemas": [], "outputProperties": { "compression": "Gzip", "delimiter": "Comma", "maxFileSizeInMB": 128, "maxRecordsPerFile": 1000000, "minRecordsPerFile": 10000, "outputFormat": "Csv", "outputPartitions": 20 }, "partnerSupportedIds": [ { "destinationName": "DigitalIdValue", "supportedIdTypes": [ "Google", "Facebook", "Trade desk", "Instagram" ] } ] }, "canPublishNow": false, "connector": { "bucketName": "example-uswest2-cdp001-sample-data", "id": "9u8VF00000004jZYAQ", "exportDirectory": "datacloud-activations" }, "connectorType": null, "createdBy": null, "createdDate": "2026-08-06T22:25:00.000Z", "customerIdTypeMapping": null, "description": "Activation platform to activate only user identifiers", "enabled": false, "errorCode": null, "eventParameterHierarchyMap": {}, "eventParameters": [], "externalProvider": null, "fields": [ { "activationPlatformId": "1sqVF000000FRRJYA4", "activationPlatformName": "abc_user_identifiers", "helpText": null, "id": "8q9VF000000DieLYAS", "isHidden": false, "isRequired": true, "label": "AccountId", "name": "abc_user_identifiers1786055100029", "type": "Text", "values": [ { "activationPlatformFieldId": "8q9VF000000DieLYAS", "id": "5q9VF000000DieMYAS", "isDefault": true, "value": null } ] }, { "activationPlatformId": "1sqVF000000FRRJYA4", "activationPlatformName": "abc_user_identifiers", "helpText": null, "id": "8q9VF000000DieNYAS", "isHidden": true, "isRequired": false, "label": "AccountName", "name": "abc_user_identifiers1786055100166", "type": "Text", "values": [ { "activationPlatformFieldId": "8q9VF000000DieNYAS", "id": "5q9VF000000DieOYAS", "isDefault": true, "value": "Name of your account" } ] } ], "id": "1sqVF000000FRRJYA4", "identifiers": [], "includeSegmentNames": false, "isStrategicPartner": false, "label": "abc-user-identifiers", "lastModifiedBy": null, "lastModifiedDate": "2026-08-06T22:30:25.000Z", "logoUrl": null, "name": "abc_user_identifiers", "namespace": null, "notes": null, "outputFormat": "Csv", "outputGrouping": "PerAccount", "platformProcessingType": "Batch", "platformType": "Advertising", "privacyType": null, "refreshSettings": { "frequency": "TwentyFourHours", "mode": "Full", "periodicFullRefresh": null }, "showEventSourceAnnotations": false, "status": "Processing", "supportedEventTypes": [] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Disable activation platform `POST /ssot/activation-platforms/{idOrName}/actions/disable` Tags: Activation Platforms. Disables an activation platform. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Enable activation platform `POST /ssot/activation-platforms/{idOrName}/actions/enable` Tags: Activation Platforms. Enables an activation platform. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Publish activation platform `POST /ssot/activation-platforms/{idOrName}/actions/publish` Tags: Activation Platforms. Publishes an activation platform and sets its status to active. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) Record ID (18-character) or API name of the activation platform to publish. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Retry activation platform sync `POST /ssot/activation-platforms/{idOrName}/actions/retry-sync` Tags: Activation Platforms. Retries the sync operation for an activation platform that previously failed. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **202** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Set activation platform privacy type `POST /ssot/activation-platforms/{idOrName}/actions/set-privacy-type` Tags: Activation Platforms. Sets the privacy type classification for an activation platform. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `SetPrivacyTypeInputRepresentation`. _Example: example1_ ``` { "privacyType": "NotApplicable" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get action sources for an event `GET /ssot/activation-platforms/{idOrName}/metadata/action-sources` Tags: Activation Platforms. Returns the action sources valid for the specified event on the activation platform, such as Website, App, or Offline. **Available Version:** 67.0 #### Parameters * `eventName` (query, string, required) Name of the event whose action sources to return. **Available Version:** 67.0 * `pageSize` (query, integer) Maximum number of action sources to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `idOrName` (path, string, required) 15- or 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionSourceCollectionRepresentation`. _Example: example1_ ``` { "actionSources": [ { "name": "Business Messaging - WhatsApp" }, { "name": "Phone Call" }, { "name": "Physical Store" }, { "name": "Website" } ], "currentPageUrl": "/services/data/v67.0/ssot/activation-platforms/cdpactvstrgptnr__Meta_Conversions_API/metadata/action-sources?eventName=Purchase&offset=0&pageSize=20", "nextPageUrl": null, "totalSize": 4 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get events for an activation platform `GET /ssot/activation-platforms/{idOrName}/metadata/events` Tags: Activation Platforms. Returns the standard event names configured for the activation platform's streaming metadata, such as Purchase or AddToCart. **Available Version:** 67.0 #### Parameters * `pageSize` (query, integer) Maximum number of events to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `idOrName` (path, string, required) 15- or 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `EventCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v67.0/ssot/activation-platforms/cdpactvstrgptnr__Meta_Conversions_API/metadata/events?offset=0&pageSize=20", "events": [ { "name": "Add Payment Info" }, { "name": "Add to Cart" }, { "name": "Add to Wishlist" }, { "name": "CRM - Lead Record Change Events" }, { "name": "Cart Abandoned" }, { "name": "Complete Registration" }, { "name": "Contact" }, { "name": "Customize Product" }, { "name": "Donate" }, { "name": "Find Location" }, { "name": "Initiate Checkout" }, { "name": "Lead" }, { "name": "Lead Submitted" }, { "name": "Order Canceled" }, { "name": "Order Created" }, { "name": "Order Delivered" }, { "name": "Order Returned" }, { "name": "Order Shipped" }, { "name": "Purchase" }, { "name": "Qualified Lead" } ], "nextPageUrl": "/services/data/v67.0/ssot/activation-platforms/cdpactvstrgptnr__Meta_Conversions_API/metadata/events?offset=20&pageSize=20", "totalSize": 23 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get partner-object types for an activation platform `GET /ssot/activation-platforms/{idOrName}/metadata/partner-object-types` Tags: Activation Platforms. Returns the partner-object types valid for the activation platform, such as Pixel, App, or ConversionRule, each with a display label. **Available Version:** 67.0 #### Parameters * `pageSize` (query, integer) Maximum number of partner-object types to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `idOrName` (path, string, required) 15- or 18-character ID or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `PartnerObjectTypeCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v67.0/ssot/activation-platforms/cdpactvstrgptnr__LinkedInPlatform/metadata/partner-object-types?offset=0&pageSize=20", "nextPageUrl": null, "partnerObjectTypes": [ { "label": "Conversion Rule", "type": "ConversionRule" } ], "totalSize": 1 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation targets `GET /ssot/activation-targets` Tags: Activation Targets. Get a list of activation targets with selected filters. **Available Version:** 60.0 #### Parameters * `batchSize` (query, integer) Number of results to return. Values are from `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be greater than or equal to `0`. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set by `createdDate`. If unspecified, items are returned by ID in ascending order. **Available Version:** 60.0 * `filters` (query, string) Filter the result set to a more narrow scope or specific type. These filters are supported: * masterLabel (field name: name; type: string; description: name of the activation target) * targetStatus (field name: status; type: enum; description: status of the activation target, which accepts only the values listed in the `status` response field) * connectionType (field name: platformType; type: enum; description: platform type of the activation target, which accepts only the values listed in the `platformType` response field) * platformName (field name: platformName; type: string; description: platform name of the activation target). **Example requests with filters:** * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?filters = MasterLabel in Target002`. * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?filters = targetStatus in active`. * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?filters = platformname in Customer Data Platform`. * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?filters = targetStatus in active AND platformName in Amazon S3`. * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?filters = targetStatus in active AND platformName in Amazon S3&orderBy = createddate desc&offset=1&batchsize=4`. * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activation-targets?batchSize=2&orderBy=CreatedDate asc`. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationTargetCollectionRepresentation`. _Example: Example_ ``` { "activationTargets": [ { "createdBy": { "id": "005VF000001rRj4YAE" }, "createdDate": "2024-11-15T05:29:50.000Z", "dataSpaceName": "default", "description": "Amazon S3 target", "id": "85UVF000000Dr4v2AC", "lastModifiedBy": { "id": "005VF000001rRj5YAE" }, "lastModifiedDate": "2024-11-15T05:29:50.000Z", "name": "s3_target", "platformName": "Amazon S3", "platformType": "AMAZONS3", "status": "ACTIVE" } ], "batchSize": 1, "offset": 1, "orderByExpression": "[createddate desc]" } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### POST Create activation target `POST /ssot/activation-targets` Tags: Activation Targets. Create an activation target. **Available Version:** 60.0 If you are using a Marketing Cloud connector, use these endpoints to retrieve your connector details: * [Get connection](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnection) * [Get connections](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnectionCollection) #### Request body (required) Media type: `application/json`. Schema: `ActivationTargetInputRepresentation`. _Example: Amazon S3 connector request_ ``` { "dataSpaceName": "default", "name": "s3_target2", "connector": { "name": "s3_conn_1", "outputFormat": "CSV", "bucketName": "", "folderName": "folderName", "accessKey": "", "secretKey": "" }, "platformType": "AmazonS3" } ``` _Example: Marketing Cloud connector request_ ``` { "dataSpaceName": "default", "name": "mc-target", "description": "MC target payload", "platformType": "SalesforceMarketingCloud", "connector": { "targetSubType": "DE", "name": "MCE_Connector", "businessUnitConfig": { "businessUnits": [ "524000668", "524000673" ] } } } ``` _Example: File-based connectors request_ ``` { "name": "sftp-connect-api", "description": "description", "platformType": "SFTP", "dataSpaceName": "default", "isCappingEnabled": false, "connector": { "name": "sftpTargetConnector" }, "egressProperties": { "childFolder": "", "isSubfolderCreationEnabled": false, "predeterminedFilename": "SEGMENT_ACTIVATION", "filenameDateSuffixFormat": "yyyy-MM-dd-HH-mm-ss", "outputDelimiter": "COMMA", "outputCompressionFormat": "GZIP", "outputMaxFileSizeMegaBytes": 500, "outputFormat": "CSV" } } ``` _Example: Data Cloud activation target request_ ``` { "name": "dc-connect-api", "description": "Activation target for Data 360", "platformType": "DataCloud", "dataSpaceName": "default", "isCappingEnabled": false, "connector": {} } ``` _Example: Ecosystem external platform request_ ``` { "name": "advertising-platform-target", "description": "activation platform target description", "platformType": "ExternalPlatform", "dataSpaceName": "default", "isCappingEnabled": false, "connector": { "name": "advertising_platform", "keyPrefixName": "EcoSystem1", "fieldConfig": { "fields": [ { "name": "AccountId", "value": "account id" }, { "name": "test field 1", "value": "hello world 1" } ] } } } ``` _Example: Strategic partner request_ ``` { "name": "google-ads-platform-target", "description": "description", "platformType": "ExternalPlatform", "dataSpaceName": "default", "isCappingEnabled": false, "connector": { "name": "PremiumPartnerGoogle", "keyPrefixName": "cdpactvstrgptnr" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationTargetRepresentation`. _Example: Amazon S3 connector response_ ``` { "connector": { "bucketName": "", "folderName": "folderName", "name": "S3_1731648590493", "outputFormat": "CSV" }, "createdBy": { "id": "005VF000001rRj4YAE" }, "createdDate": "2024-11-15T05:29:50.000Z", "dataSpaceName": "default", "description": "", "historyAudienceDmoApiName": "name__dlm", "historyAudienceDmoLabel": "label", "id": "85UVF000000Dr4v2AC", "isCappingEnabled": false, "isEnabled": true, "platformPrivacyType": "", "organizationId": "", "lastModifiedBy": { "id": "005VF000001rRj5YAE" }, "lastModifiedDate": "2024-11-15T05:29:50.000Z", "name": "s3_target", "platformType": "AMAZONS3", "platformName": "AmazonS3", "status": "ACTIVE" } ``` _Example: Marketing Cloud connector response_ ``` { "connector": { "businessUnits": [ "524000673", "524000668" ], "name": "Salesforce_Marketing_Cloud_NA1", "outputFormat": "JSON", "targetSubType": "DE" }, "createdBy": { "id": "005VW000000bg3VYAQ" }, "createdDate": "2024-11-18T08:06:39.000Z", "dataSpaceName": "default", "description": "", "historyAudienceDmoApiName": "name__dlm", "historyAudienceDmoLabel": "label", "id": "85UVW0000006Xfd2AE", "isCappingEnabled": false, "isEnabled": true, "platformPrivacyType": "", "organizationId": "", "lastModifiedBy": { "id": "005VW000000bg57YAA" }, "lastModifiedDate": "2024-11-18T08:06:40.000Z", "name": "mc-target", "platformType": "SALESFORCEMARKETINGCLOUD", "platformName": "SalesforceMarketingCloud", "status": "ACTIVE" } ``` _Example: File-based connectors response_ ``` { "connector": { "name": "sftpTargetConnector" }, "platformType": "Sftp (or GoogleCloudStorage or AzureBlob)", "createdBy": { "id": "005SB00000MhbyvYAB" }, "createdDate": "2025-06-02T11:53:25.000Z", "dataSpaceName": "default", "description": "description", "egressProperties": { "fileNameType": "PREDETERMINED", "filenameDateSuffixFormat": "yyyy-MM-dd-HH-mm-ss", "isSubfolderCreationEnabled": false, "outputCompressionFormat": "GZIP", "outputDelimiter": "COMMA", "outputFormat": "CSV", "outputMaxFileSizeMegaBytes": 500, "predeterminedFilename": "SEGMENT_ACTIVATION" }, "id": "85USB000004ADXx2AO", "isCappingEnabled": false, "lastModifiedBy": { "id": "005SB00000MhcYPYAZ" }, "lastModifiedDate": "2025-06-02T11:53:29.000Z", "name": "sftp-connect-api", "status": "ACTIVE" } ``` _Example: Data Cloud activation target response_ ``` { "createdBy": { "id": "005SB00000NucF3YAJ" }, "createdDate": "2025-07-08T05:54:10.000Z", "dataSpaceName": "default", "description": "Activation target for Data 360", "id": "85USB000004LBZF2A4", "isCappingEnabled": false, "lastModifiedBy": { "id": "005SB00000NucF3YAJ" }, "lastModifiedDate": "2025-07-08T05:54:10.000Z", "name": "dc-connect-api", "platformName": "DataCloud", "platformType": "DataCloud", "status": "PROCESSING" } ``` _Example: Ecosystem external platform response_ ``` { "connector": { "fieldConfig": { "fields": [ { "name": "AccountId", "value": "account id" }, { "name": "test field 1", "value": "hello world 1" } ] }, "name": "advertising platform" }, "platformType": "ExternalPlatform", "createdBy": { "id": "005VF000002Yd2bYAC" }, "createdDate": "2025-08-19T04:45:48.000Z", "dataSpaceName": "default", "description": "activation platform target description", "id": "85UVF000000NaQz2AK", "isCappingEnabled": false, "lastModifiedBy": { "id": "005VF000002YcWNYA0" }, "lastModifiedDate": "2025-08-19T14:17:59.000Z", "name": "advertising-platform-target", "platformName": "advertising platform", "status": "ACTIVE" } ``` _Example: Strategic partner response_ ``` { "attributeConfig": { "attributes": [ { "destinationName": "EmailAddress", "displayName": "EmailAddress" }, { "destinationName": "hashedPhoneNumber", "displayName": "hashedPhoneNumber" }, { "destinationName": "AdPersonalizationConsentStatus", "displayName": "AdPersonalizationConsentStatus" }, { "destinationName": "AdUserDataConsentStatus", "displayName": "AdUserDataConsentStatus" }, { "destinationName": "thirdPartyUserId", "displayName": "thirdPartyUserId" } ] }, "createdDate": "2025-07-24T12:48:08.000Z", "keyPrefixName": "cdpactvstrgptnr", "label": "Google Ads Platform", "lastModifiedDate": "2025-07-24T12:48:22.000Z", "name": "PremiumPartnerGoogle", "status": "ACTIVE", "type": "ADVERTISING" } ``` * **400** Bad request. For example: * The server could not process the request as the parameters or payload are incorrect. * The `maxFileSize` property value must be between 1 and 500 (MB). * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### POST Assign ad account `POST /ssot/activation-targets/actions/{activationTargetId}/assign-ad-account` Tags: Activation Targets. Assigns the specified ad account to the activation target. **Available Version:** 67.0 #### Parameters * `activationTargetId` (path, string, required) Record ID (15- or 18-character) of the activation target. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `AssignAdAccountInputRepresentation`. _Example: example1_ ``` { "accountNumber": "6586160339", "managerAccountId": "6586160339", "dataSpace": "default" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Disable activation target `POST /ssot/activation-targets/actions/{activationTargetId}/disable` Tags: Activation Targets. Disables an activation target. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string) Name of the data space to use as context for the request. **Available Version:** 67.0 * `activationTargetId` (path, string, required) Record ID (18-character) of the activation target to disable. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Enable activation target `POST /ssot/activation-targets/actions/{activationTargetId}/enable` Tags: Activation Targets. Enables an activation target. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string) Name of the data space to use as context for the request. **Available Version:** 67.0 * `activationTargetId` (path, string, required) Record ID (18-character) of the activation target to enable. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Retry activation target sync `POST /ssot/activation-targets/actions/{activationTargetId}/retry-sync` Tags: Activation Targets. Retries the sync for an activation target. **Available Version:** 67.0 #### Parameters * `activationTargetId` (path, string, required) Record ID (15- or 18-character) of the activation target. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation platform metadata `GET /ssot/activation-targets/metadata/activation-platforms` Tags: Activation Targets. Returns a paginated list of activation platform metadata, with optional filtering by platform type and name. **Available Version:** 67.0 #### Parameters * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `dataSpace` (query, string) Name of the data space to scope the lookup. If unspecified, the request's data space context is used. **Available Version:** 67.0 * `filters` (query, string) Filter expression used to narrow results, such as `field eq value AND name contains foo`. Supported operators are `eq`, `!=`, `contains`, `in`, `>`, `<`, `>=`, and `<=`. **Available Version:** 67.0 * `name` (query, string) Filter results by activation platform name. Must be an exact match. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression in the form `field [asc|desc][, field [asc|desc]]*`. **Available Version:** 67.0 * `platformType` (query, string) Filter results by platform type, such as `Sfmc`, `Sftp`, `External`, or `Strategic`. **Available Version:** 67.0 Allowed values: `AzureBlob`, `DataCloud`, `External`, `GoogleCloudStorage`, `InteractionStudio`, `S3`, `S3V2`, `SfApp`, `Sfcc`, `Sfmc`, `Sftp`, `Strategic`, `StreamingFlow`. #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationTargetPlatformsCollectionRepresentation`. _Example: example1_ ``` { "activationTargetPlatforms": [ { "apiName": "cdpactvstrgptnr__AmazonPlatform", "category": "Advertising", "description": "Create activation targets using a connected Amazon account.", "externalProvider": "Amazon", "name": "Amazon Platform", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__LinkedInPlatform", "category": "Advertising", "description": "Create activation targets using a connected LinkedIn account.", "externalProvider": "LinkedIn", "name": "LinkedIn Platform", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__Meta_Conversions_API", "category": "Advertising", "description": "Activate customer engagement and CRM Lead event data to Meta’s Conversion API via server-side integration for campaign optimization and measurement.", "externalProvider": null, "name": "Meta Conversions API", "platformType": "Strategic", "processingType": "Streaming", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__PremiumPartnerGoogle", "category": "Advertising", "description": "Create activation targets using a connected Google Ads account.", "externalProvider": "Google", "name": "Google Ads Platform", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__PremiumPartnerMeta", "category": "Advertising", "description": "Create activation targets using a connected Meta account.", "externalProvider": "Facebook", "name": "Meta (Facebook)", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__SnapchatPlatform", "category": "Advertising", "description": "Create activation targets using a connected Snapchat Ads account.", "externalProvider": "Snapchat", "name": "Snapchat", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__dv360Platform", "category": "Advertising", "description": "Create activation targets using a connected Google DV360 account.", "externalProvider": "Dv360", "name": "Google Display & Video 360", "platformType": "Strategic", "processingType": "Batch", "sortOrder": null }, { "apiName": "isvcp__ISVPlatform1", "category": "Advertising", "description": "ISVPlatform1", "externalProvider": null, "name": "ISVPlatform1", "platformType": "External", "processingType": "Batch", "sortOrder": null }, { "apiName": "isvcp__ISVWithEmailOnly", "category": "Advertising", "description": "EmailOnly", "externalProvider": null, "name": "ISVWithEmailOnly", "platformType": "External", "processingType": "Batch", "sortOrder": null }, { "apiName": "cdpactvstrgptnr__LinkedIn_Conversions_API", "category": "Advertising", "description": "Activate customer engagement and CRM Lead event data to LinkedIn's Conversion API.", "externalProvider": null, "name": "LinkedIn Conversions API", "platformType": "Strategic", "processingType": "Streaming", "sortOrder": null }, { "apiName": "S3", "category": null, "description": "(Legacy) Export files to Amazon S3 with fixed folders and default file names.", "externalProvider": null, "name": "S3", "platformType": "S3", "processingType": "Batch", "sortOrder": null }, { "apiName": "Marketing Cloud Engagement", "category": null, "description": "Create activation targets to publish data to Marketing Cloud Engagement.", "externalProvider": null, "name": "Marketing Cloud Engagement", "platformType": "Sfmc", "processingType": "Batch", "sortOrder": null }, { "apiName": "Commerce Cloud", "category": null, "description": "Create activation targets to publish data to Commerce Cloud.", "externalProvider": null, "name": "Commerce Cloud", "platformType": "Sfcc", "processingType": "Batch", "sortOrder": null }, { "apiName": "Marketing Cloud Personalization", "category": null, "description": "Create activation targets to publish data to Marketing Cloud Personalization.", "externalProvider": null, "name": "Marketing Cloud Personalization", "platformType": "InteractionStudio", "processingType": "Batch", "sortOrder": null }, { "apiName": "Data Cloud (Loyalty)", "category": null, "description": "Create an activation target to access data for use with Loyalty Cloud.", "externalProvider": null, "name": "Data Cloud (Loyalty)", "platformType": "SfApp", "processingType": "Batch", "sortOrder": null } ], "currentPageUrl": null, "nextPageUrl": "/services/data/v67.0/ssot/activation-targets/metadata/activation-platforms?batchSize=20&offset=20", "totalSize": 23 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get communication capping data spaces `GET /ssot/activation-targets/metadata/communication-capping-data-spaces` Tags: Activation Targets. Returns all data spaces with communication capping definitions linked to activation targets. **Available Version:** 67.0 #### Parameters * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `filters` (query, string) Filter expression used to narrow results, such as `field eq value AND name contains foo`. Supported operators are `eq`, `!=`, `contains`, `in`, `>`, `<`, `>=`, and `<=`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression in the form `field [asc|desc][, field [asc|desc]]*`. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingDataSpacesCollectionRepresentation`. _Example: example1_ ``` { "dataSpaces": [ { "dataCommunicationCapDefId": "0lU000000000abcEAA", "dataSpace": "default" }, { "dataCommunicationCapDefId": "0lU000000000abdEAA", "dataSpace": "cdp_marketing_eu" }, { "dataCommunicationCapDefId": "0lU000000000abeEAA", "dataSpace": "cdp_marketing_apac" } ], "totalSize": 3, "nextPageUrl": null } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Validate data space account for target `GET /ssot/activation-targets/metadata/dataspace-account-validation` Tags: Activation Targets. Indicates whether an ad account is available to assign to an activation target. Returns `true` when the account isn't already assigned. **Available Version:** 67.0 #### Parameters * `accountId` (query, string, required) Identifier of the ad account on the partner platform. **Available Version:** 67.0 * `dataSpace` (query, string, required) Name of the data space to check against. **Available Version:** 67.0 * `platformIdOrName` (query, string, required) Record ID (15- or 18-character) or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataspaceAccountValidationRepresentation`. _Example: example1_ ``` { "available": false } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get Marketing Cloud enterprises `GET /ssot/activation-targets/metadata/mc-enterprises` Tags: Activation Targets. Returns Marketing Cloud enterprises and their business units. **Available Version:** 67.0 #### Parameters * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `McEnterprisesCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": null, "enterprises": [ { "businessUnits": [ { "id": "3khVF0000000MQLYA2", "name": "DC Activation Q2_524001509 - default" } ], "connectorId": "7M4VF0000000Esb0AE", "enterpriseId": "524001509", "enterpriseName": "Q2 MC" } ], "nextPageUrl": null, "totalSize": 1 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation target platform fields `GET /ssot/activation-targets/metadata/target-platform-fields` Tags: Activation Targets. Returns the target-level configuration fields for an activation platform. **Available Version:** 67.0 #### Parameters * `platformIdOrName` (query, string, required) Record ID (15- or 18-character) or API name of the activation platform. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPlatformFieldsRepresentation`. _Example: example1_ ``` { "platformFields": [ { "activationPlatformId": "1sqVF0000005nJSYAY", "activationPlatformName": null, "helpText": null, "id": "8q9VF00000043XCYAY", "isHidden": false, "isRequired": true, "label": "AccountId", "name": "ISVWithEmailOnly1707182166910", "type": "Text", "values": [ { "activationPlatformFieldId": "8q9VF00000043XCYAY", "id": "5q9VF00000043XEYAY", "isDefault": null, "value": null } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation target `GET /ssot/activation-targets/{activationTargetId}` Tags: Activation Targets. Get an activation target by ID or developer name. **Available Version:** 60.0 #### Parameters * `activationTargetId` (path, string, required) Unique identifier of a specific activation target, such as the ID or developer name. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationTargetRepresentation`. _Example Amazon S3 connector response: same as POST /ssot/activation-targets 200 response._ _Example Marketing Cloud connector response: same as POST /ssot/activation-targets 200 response._ _Example File-based connectors response: same as POST /ssot/activation-targets 200 response._ _Example Data Cloud activation target response: same as POST /ssot/activation-targets 200 response._ _Example Ecosystem external platform response: same as POST /ssot/activation-targets 200 response._ _Example Strategic partner response: same as POST /ssot/activation-targets 200 response._ * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### DELETE Delete activation target `DELETE /ssot/activation-targets/{activationTargetId}` Tags: Activation Targets. Delete an activation target by ID or developer name. **Available Version:** 60.0 #### Parameters * `activationTargetId` (path, string, required) Unique identifier of a specific activation target, such as the ID or developer name. **Available Version:** 60.0 #### Responses * **200** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### PATCH Update activation target `PATCH /ssot/activation-targets/{activationTargetId}` Tags: Activation Targets. Update a specific activation target by ID or developer name. **Available Version:** 60.0 #### Parameters * `activationTargetId` (path, string, required) Unique identifier of a specific activation target, such as the ID or developer name. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `ActivationTargetInputRepresentation`. _Example: Example_ ``` { "dataSpaceName": "default", "name": "s3_target2_changed" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationTargetRepresentation`. _Example Amazon S3 connector response: same as POST /ssot/activation-targets 200 response._ _Example Marketing Cloud connector response: same as POST /ssot/activation-targets 200 response._ _Example File-based connectors response: same as POST /ssot/activation-targets 200 response._ _Example Data Cloud activation target response: same as POST /ssot/activation-targets 200 response._ _Example Ecosystem external platform response: same as POST /ssot/activation-targets 200 response._ _Example Strategic partner response: same as POST /ssot/activation-targets 200 response._ * **400** Bad request. For example: * The server could not process the request as the parameters or payload are incorrect. * The `maxFileSize` property value must be between 1 and 500 (MB). * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### GET Get available ad accounts `GET /ssot/activation-targets/{activationTargetId}/available-ad-accounts` Tags: Activation Targets. Returns the ad accounts that aren't already assigned in the specified data space. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string, required) Name of the data space used to filter out already-assigned accounts. **Available Version:** 67.0 * `platformIdOrName` (query, string, required) Record ID (15- or 18-character) or API name of the activation platform. **Available Version:** 67.0 * `activationTargetId` (path, string, required) Record ID (15- or 18-character) of the activation target. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AdAccountsRepresentation`. _Example: example1_ ``` { "adAccounts": [ { "accountName": "Eric Jones Winter 2020", "accountNumber": "1027162390971686", "active": true, "errors": [], "hasError": false, "managerAccountId": "" }, { "accountName": "Northern Trail Outfitters", "accountNumber": "3219451248364309", "active": true, "errors": [], "hasError": false, "managerAccountId": "" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get partner objects `GET /ssot/activation-targets/{activationTargetId}/partner-objects` Tags: Activation Targets. Returns partner-platform objects of the specified type. Results are cursor-paginated: follow `nextPageUrl` to retrieve each subsequent page instead of supplying an offset. **Available Version:** 67.0 #### Parameters * `pageToken` (query, string) Cursor for the next page of results. Omit this value on the first request. The response's `nextPageUrl` includes the `pageToken` to fetch the next page, so follow `nextPageUrl` rather than constructing this value. **Available Version:** 67.0 * `partnerObjectType` (query, string, required) Type of partner object to retrieve. **Available Version:** 67.0 Allowed values: `App`, `ConversionRule`, `CrmEventSet`, `MobileApp`, `OfflineEventSet`, `Pixel`. * `activationTargetId` (path, string, required) Record ID (15- or 18-character) of the activation target. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `PartnerObjectsCollectionRepresentation`. _Example: example1_ ``` { "partnerObjects": [ { "name": "LinkedIn Conversion rule for ADD_BILLING_INFO (ADD_BILLING_INFO)", "partnerObjectId": "li-conversion-rule-ADD_BILLING_INFO", "status": null, "type": "ConversionRule" }, { "name": "LinkedIn Conversion rule for ADD_TO_CART (ADD_TO_CART)", "partnerObjectId": "li-conversion-rule-ADD_TO_CART", "status": null, "type": "ConversionRule" }, { "name": "LinkedIn Conversion rule for ADD_TO_LIST (ADD_TO_LIST)", "partnerObjectId": "li-conversion-rule-ADD_TO_LIST", "status": null, "type": "ConversionRule" }, { "name": "LinkedIn Conversion rule for AD_CLICK (AD_CLICK)", "partnerObjectId": "li-conversion-rule-AD_CLICK", "status": null, "type": "ConversionRule" }, { "name": "LinkedIn Conversion rule for AD_VIEW (AD_VIEW)", "partnerObjectId": "li-conversion-rule-AD_VIEW", "status": null, "type": "ConversionRule" } ], "totalSize": 5 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activations `GET /ssot/activations` Tags: Activations. Get a list of activations with selected filters. **Available Version:** 60.0 #### Parameters * `batchSize` (query, integer) Number of results to return. Values are from `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be greater than or equal to `0`. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set by `createdDate`. If unspecified, items are returned by ID in ascending order. **Available Version:** 60.0 * `filters` (query, string) Filter the result set to a more narrow scope or specific type. These filters are supported: * name (field name: name; description: name of the activation) * marketSegmentId (field name: segmentId; description: segment ID of the activation) * activationTargetId (field name: activationTarget.id; description: activation target ID of the activation) * activationRefreshType (field name: refreshType; description: refresh type of the activation; example: incremental) * activationStatus (field name: status; description: status of the activation, which accepts only the values in the `status` response field; example: active). **Example requests with filters:** * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activations?filters = name in Activation001` * GET `https://{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activations?filters = marketsegmentid in 00sgxx0001AAA` * GET `https//{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activations?filters = activationRefreshType in incremental` * GET `https//{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activations?filters = activationrefreshtype in incremental AND activationstatus in active` * GET `https//{dne_cdpInstanceUrl}/services/data/v60.0/ssot/activations?filters = activationtargetid in 85Uxx0000004CKKEA2 AND activationstatus in active&orderby = createddate desc&offset=0&batchsize=20` **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationCollectionRepresentation`. _Example: Example_ ``` { "activations": [ { "activationTarget": { "id": "85UVF000000Dr4v2AC", "name": "s3_target" }, "activationTargetId": "85UVF000000Dr4v2AC", "activationTargetName": "s3_target", "createdBy": { "id": "005VF000001rRj4YAE" }, "createdDate": "2024-12-05T04:20:15.000Z", "dataSpaceName": "default", "description": "Test activation", "developerName": "act1733372413210", "id": "85RVF000000CEf72AG", "lastModifiedBy": { "id": "005VF000001rRj5YAE" }, "lastModifiedDate": "2024-12-05T04:20:20.000Z", "lastPublishStatus": "SUCCESS", "marketSegmentId": "1sgVF000000LfbFYAS", "name": "act", "refreshType": "INCREMENTAL", "segmentApiName": "seg", "segmentId": "1sgVF000000LfbFYAS", "status": "ACTIVE" } ], "batchSize": 1, "offset": 1, "orderByExpression": "[createddate desc]" } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### POST Create activation `POST /ssot/activations` Tags: Activations. Create an activation. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `ActivationDefinitionInputRepresentation`. _Example: S3 activation request_ ``` { "activationTargetName": "S3_activation_target_test1", "activationTargetSubjectConfig": { "developerName": "ssot__Individual__dlm" }, "attributesConfig": { "attributes": [ { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Individual Id", "preferredName": "attribute individual id", "name": "ssot__Id__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Gender", "name": "ssot__GenderId__c", "preferredName": "attribute gender", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "GenderId", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "First Name", "name": "ssot__FirstName__c", "preferredName": "attribute first name", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "FirstName", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Last Name", "name": "ssot__LastName__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "LastName", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Account Name", "name": "ssot__Name__c", "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] }, "referenceAttributeName": "Name", "source": "RELATED", "type": "MODELRELATED" }, { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Data Source", "name": "ssot__DataSourceId__c", "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] }, "referenceAttributeName": "DataSourceId", "source": "RELATED", "type": "MODELRELATED" } ] }, "contactPointsConfig": { "contactPoints": [ { "entityName": "ssot__ContactPointEmail__dlm", "attributesConfig": { "attributes": [ { "label": "Email Address", "name": "ssot__EmailAddress__c" } ] }, "filterExpression": { "contactPointDmoFilters": [ { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filtersConfig": { "filters": [] }, "operator": "not contains", "selfReference": false, "subject": { "fieldName": "ssot__EmailAddress__c", "objectName": "ssot__ContactPointEmail__dlm" }, "filterConfig": { "values": [ "gmail" ] } }, "type": "TextComparison", "filtersConfig": { "filters": [] }, "objectName": "ssot__ContactPointEmail__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__ContactPointEmail__dlm", "filterLimit": { "attributeName": "ssot__Id__c", "maxNumberOfValues": 1, "order": "ASC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__ContactPointEmail__dlm" } ] } } ] } } ] }, "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" }, { "fieldLabel": "Party", "fieldName": "ssot__PartyId__c", "objectLabel": "Contact Point Email", "objectName": "ssot__ContactPointEmail__dlm" } ] } } ] }, "sourcesConfig": { "contactPointSources": [ { "dataSourcePreference": "ANY", "dataSourcePriority": 1, "name": "Any" } ] }, "type": "EMAIL" } ] }, "dataSpaceName": "default", "description": "Activation test", "directDmoFiltersConfig": { "filters": [ { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filtersConfig": { "filters": [] }, "operator": "equal", "selfReference": false, "subject": { "fieldName": "ssot__GenderId__c", "objectName": "ssot__Individual__dlm" }, "filterConfig": { "values": [ "Male" ] } }, "type": "TextComparison", "filtersConfig": { "filters": [] }, "objectName": "ssot__Individual__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Individual__dlm" }, { "entityFilter": { "attributeSource": "RELATED", "condition": { "filterConfig": { "values": [ "M" ] }, "operator": "contains", "selfReference": false, "subject": { "fieldName": "ssot__Name__c", "objectName": "ssot__Account__dlm" } }, "type": "TextComparison", "filtersConfig": { "filters": [] }, "objectName": "ssot__Account__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Account__dlm", "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] } } ] }, "name": "test_1234", "refreshType": "FULL_REFRESH", "relatedDmoFiltersConfig": { "filters": [ { "entityName": "ssot__Account__dlm", "filterLimit": { "attributeName": "ssot__Name__c", "maxNumberOfValues": 1, "order": "DESC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] } } ] }, "segmentApiName": "seg_test", "shouldExcludeDeletes": false, "shouldExcludeUpdates": false, "staticDataConfig": { "staticData": [ { "name": "Test", "value": "TestValue" } ] } } ``` _Example: External platform activation request_ ``` { "activationMappingSchema": "PII", "activationTargetName": "Google Ads", "activationTargetSubjectConfig": { "developerName": "ssot__Individual__dlm" }, "attributesConfig": { "attributes": [ { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "externalPlatformAttributeName": "EmailAddress", "label": "Party", "name": "ssot__PartyId__c", "preferredName": "EmailAddress", "referenceAttributeName": "PartyId", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Individual Id", "name": "ssot__Id__c", "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" } ] }, "dataSpaceName": "default", "name": "GAP Activation", "refreshType": "INCREMENTAL", "segmentApiName": "seg_indi_1" } ``` _Example: Batch DMO activation request_ ``` { "activationTargetName": "dc_target", "activationTargetSubjectConfig": { "developerName": "ssot__Account__dlm", "queryPathConfig": { "configs": [] } }, "activationType": "DMO", "attributeLimitingExpressionConfig": { "attributeLimitingExpressions": [ { "attributeName": "ssot__FirstName__c", "entityName": "ssot__Individual__dlm", "order": "DESC", "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" }, { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } ] } } ] }, "type": "MODEL" }, { "attributeName": "ssot__Id__c", "entityName": "ssot__Account__dlm", "order": "ASC", "type": "MODEL", "queryPathConfig": { "configs": [] } } ] }, "attributesConfig": { "attributes": [ { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Account Id", "name": "ssot__Id__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Data Source", "name": "ssot__DataSourceId__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "DataSourceId", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "First Name", "name": "ssot__FirstName__c", "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" }, { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } ] } } ] }, "referenceAttributeName": "FirstName", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Number", "entityName": "ssot__Individual__dlm", "label": "Children Count", "name": "ssot__ChildrenCount__c", "queryPathConfig": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" }, { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } ] } } ] }, "referenceAttributeName": "ChildrenCount", "source": "DIRECT", "type": "MODEL" } ] }, "dataSpaceName": "default", "directDmoFiltersConfig": { "filters": [ { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filtersConfig": { "filters": [] }, "operator": "has value", "selfReference": false, "subject": { "fieldName": "ssot__DataSourceId__c", "objectName": "ssot__Account__dlm" }, "filterConfig": { "values": [] } }, "type": "TextComparison", "filtersConfig": { "filters": [] }, "objectName": "ssot__Account__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Account__dlm" }, { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filtersConfig": { "filters": [] }, "operator": "contains", "selfReference": false, "subject": { "fieldName": "ssot__GenderId__c", "objectName": "ssot__Individual__dlm" }, "filterConfig": { "values": [ "Male" ] } }, "type": "TextComparison", "filtersConfig": { "filters": [] }, "objectName": "ssot__Individual__dlm", "queryPathConfigFromActivateOnToEntity": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] } }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Individual__dlm", "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" }, { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } ] } } ] } } ] }, "limitValue": 10, "name": "Batch DMO Activation Example", "processingType": "Batch", "refreshType": "INCREMENTAL", "shouldExcludeDeletes": true, "shouldExcludeUpdates": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationRepresentation`. _Example: S3 activation response_ ``` { "activationDefinitionId": "17pxx0000004DzY", "activationTarget": { "description": "test act", "id": "85Uxx0000004DqOEAU", "lastModifiedDate": "2025-03-28T04:56:09.000Z", "name": "S3_activation_target_test", "platformName": "AmazonS3", "platformType": "AMAZONS3", "status": "ACTIVE" }, "activationTargetId": "85Uxx0000004DqOEAU", "activationTargetName": "S3_activation_target_test", "activationTargetSubjectConfig": { "developerName": "ssot__Individual__dlm", "id": "0gjxx00000000BuAAI", "masterLabel": "Individual", "queryPathConfig": { "configs": [] } }, "attributesConfig": { "attributes": [ { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Individual Id", "name": "ssot__Id__c", "preferredName": "attribute individual id", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Gender", "name": "ssot__GenderId__c", "preferredName": "attribute gender", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "GenderId", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "First Name", "name": "ssot__FirstName__c", "preferredName": "attribute first name", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "FirstName", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Last Name", "name": "ssot__LastName__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "LastName", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Account Name", "name": "ssot__Name__c", "queryPathConfig": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } ] }, "referenceAttributeName": "Name", "source": "RELATED", "type": "MODELRELATED" }, { "dataSourceType": "Text", "entityName": "ssot__Account__dlm", "label": "Data Source", "name": "ssot__DataSourceId__c", "queryPathConfig": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } ] }, "referenceAttributeName": "DataSourceId", "source": "RELATED", "type": "MODELRELATED" } ] }, "contactPointsConfig": { "contactPoints": [ { "contactPointEntityId": "0gjxx000000008FAAQ", "contactPointEntityName": "ssot__ContactPointEmail__dlm", "contactPointPath": "[[{"fieldApiLabel":"Individual Id","fieldApiName":"ssot__Id__c","objectApiName":"ssot__Individual__dlm","objectApiLabel":"Individual"},{"fieldApiLabel":"Party","fieldApiName":"ssot__PartyId__c","objectApiName":"ssot__ContactPointEmail__dlm","objectApiLabel":"Contact Point Email"}]]", "fieldConfig": { "contactPointFields": [ { "attributeId": "0gYxx00000001LWEAY", "id": "0nXxx00000000xhEAA", "label": "Email Address", "name": "ssot__EmailAddress__c" } ] }, "filterExpression": { "contactPointDmoFilters": [ { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filters": [], "operator": "not contains", "selfReference": false, "subject": { "fieldName": "ssot__EmailAddress__c", "objectName": "ssot__ContactPointEmail__dlm" }, "values": [ "gmail" ] }, "type": "TextComparison", "filters": [], "objectName": "ssot__ContactPointEmail__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__ContactPointEmail__dlm", "filterLimit": { "attributeName": "ssot__Id__c", "maxNumberOfValues": 1, "order": "ASC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__ContactPointEmail__dlm" } ] } ] } } ] }, "id": "85Txx0000004D6iEAE", "queryPathConfig": { "configs": [ { "queryPath": [ { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" }, { "fieldLabel": "Party", "fieldName": "ssot__PartyId__c", "objectLabel": "Contact Point Email", "objectName": "ssot__ContactPointEmail__dlm" } ] } ] }, "sourceConfig": { "contactPointSources": [ { "dataSourceId": "Any", "dataSourcePreference": "ANY", "dataSourcePriority": 1, "id": "0nWxx00000000rFEAQ", "name": "Any" } ] }, "type": "EMAIL" } ] }, "createdBy": { "id": "005xx000001X7p3AAC" }, "createdDate": "2025-03-28T04:41:26.000Z", "curatedEntity": {}, "dataSourcesConfig": { "dataSources": [] }, "dataSpaceName": "default", "description": "Activation test", "developerName": "test_complex_activation", "directDmoFiltersConfig": { "filters": [ { "entityFilter": { "attributeSource": "DIRECT", "condition": { "filters": [], "operator": "equal", "selfReference": false, "subject": { "fieldName": "ssot__GenderId__c", "objectName": "ssot__Individual__dlm" }, "values": [ "Male" ] }, "type": "TextComparison", "filters": [], "objectName": "ssot__Individual__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Individual__dlm" }, { "entityFilter": { "attributeSource": "RELATED", "condition": { "filters": [], "operator": "contains", "selfReference": false, "subject": { "fieldName": "ssot__Name__c", "objectName": "ssot__Account__dlm" }, "values": [ "M" ] }, "type": "TextComparison", "filters": [], "objectName": "ssot__Account__dlm" }, "entityFilterType": "EntityScopedGroup", "entityName": "ssot__Account__dlm", "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } ] } } ] }, "historyAudienceDmoApiName": "AA_S3_85Uxx0000004DqOEAU__dlm", "historyAudienceDmoLabel": "Activation Audience - S3_activation_target_test", "id": "85Rxx0000004Dl2EAE", "isEnabled": true, "enabled": true, "lastModifiedBy": { "id": "005xx000001X7p3AAC" }, "lastModifiedDate": "2025-03-28T04:56:09.000Z", "lastPublishStatus": "SUCCESS", "marketSegmentId": "1sgxx00000000Mb", "membershipName": "Individual", "name": "test_complex_activation", "queryPathConfig": { "configs": [] }, "refreshType": "FULL_REFRESH", "relatedDmoFiltersConfig": { "filters": [ { "entityName": "ssot__Account__dlm", "filterLimit": { "attributeName": "ssot__Name__c", "maxNumberOfValues": 1, "order": "DESC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } ] } } ] }, "segmentApiName": "seg_test", "segmentId": "1sgxx00000000Mb", "waterfallSelectedChildSegmentsConfig": { "childSegmentsConfig": { "childSegments": [ "testSeg1", "testSeg2" ] }, "selectedAllSegments": false }, "shouldExcludeDeletes": false, "shouldExcludeUpdates": false, "staticDataConfig": { "staticData": [ { "name": "Test", "value": "TestValue" } ] }, "status": "ACTIVE" } ``` _Example: External platform activation response_ ``` { "activationDefinitionId": "17pxx0000004DRg", "activationMappingSchema": "PII", "activationRecordSchema": "{\n "type" : "object",\n "EmailAddress" : {\n "type" : "string",\n "nullable" : true,\n "dataCloudDataType" : "Text",\n "label" : "Party",\n "fieldApiName" : "ssot__PartyId__c",\n "objectApiName" : "ssot__Individual__dlm"\n },\n "Id" : {\n "type" : "string",\n "nullable" : true,\n "dataCloudDataType" : "Text",\n "label" : "Individual Id",\n "fieldApiName" : "ssot__Id__c",\n "objectApiName" : "ssot__Individual__dlm"\n }\n}", "activationTarget": { "id": "85Uxx0000004DEmEAM", "lastModifiedDate": "2025-10-07T11:16:58.000Z", "name": "Google Ads", "platformName": "Google Ads Platform", "platformType": "ExternalPlatform", "status": "ACTIVE" }, "activationTargetId": "85Uxx0000004DEm", "activationTargetName": "Google Ads", "activationTargetSubjectConfig": { "developerName": "ssot__Individual__dlm", "id": "0gjxx000000009TAAQ", "masterLabel": "Individual", "queryPathConfig": { "configs": [] } }, "attributesConfig": { "attributes": [ { "activationPlatformAttrId": "9xuxx000000005lAAA", "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "externalPlatformAttributeName": "EmailAddress", "label": "Party", "name": "ssot__PartyId__c", "preferredName": "EmailAddress", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "PartyId", "source": "DIRECT", "type": "MODEL" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Individual Id", "name": "ssot__Id__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" } ] }, "contactPointsConfig": { "contactPoints": [] }, "createdBy": { "id": "005xx000001X7wbAAC" }, "createdDate": "2025-10-07T11:16:55.000Z", "curatedEntity": {}, "dataSourcesConfig": { "dataSources": [] }, "dataSpaceName": "default", "developerName": "GAP_Activation1759835814928", "enabled": true, "historyAudienceDmoApiName": "AA_Google_Ads_Platfor_85Uxx0000004DEmE__dlm", "historyAudienceDmoLabel": "Activation Audience - Google Ads", "id": "85Rxx0000004DGOEA2", "isEnabled": true, "lastModifiedBy": { "id": "005xx000001X7yDAAS" }, "lastModifiedDate": "2025-10-07T11:16:58.000Z", "lastPublishStatus": "SUCCESS", "marketSegmentId": "1sgxx0000000001", "membershipName": "Individual", "name": "GAP Activation", "queryPathConfig": { "configs": [] }, "refreshType": "INCREMENTAL", "segmentApiName": "seg_indi_1", "segmentId": "1sgxx0000000001", "shouldExcludeDeletes": false, "shouldExcludeUpdates": false, "staticDataConfig": { "staticData": [] }, "status": "PROCESSING" } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### POST Disable activation `POST /ssot/activations/actions/{activationId}/disable` Tags: Activations. Disables a market segment activation. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string) Name of the data space to use as context for the request. **Available Version:** 67.0 * `activationId` (path, string, required) Record ID (18-character) of the activation to disable. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Enable activation `POST /ssot/activations/actions/{activationId}/enable` Tags: Activations. Enables a market segment activation. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string) Name of the data space to use as context for the request. **Available Version:** 67.0 * `activationId` (path, string, required) Record ID (18-character) of the activation to enable. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Trigger activation full refresh `POST /ssot/activations/actions/{activationId}/full-refresh` Tags: Activations. Triggers a full-refresh publish for an activation. **Available Version:** 67.0 #### Parameters * `activationId` (path, string, required) Record ID (15- or 18-character) of the market segment activation. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Retry activation sync `POST /ssot/activations/actions/{activationId}/retry-sync` Tags: Activations. Retries the sync for an activation. **Available Version:** 67.0 #### Parameters * `activationId` (path, string, required) Record ID (15- or 18-character) of the market segment activation. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActionResultRepresentation`. _Example: example1_ ``` { "message": null, "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get data object categories available for activation `GET /ssot/activations/metadata/activatable-data-object-categories` Tags: Activations. Returns the data object category types that are available for activation, optionally scoped to a data space. **Available Version:** 67.0 #### Parameters * `dataSpace` (query, string) Name of the data space to scope the lookup. If unspecified, the request's data space context is used. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivatableDataObjectCategoriesRepresentation`. _Example: example1_ ``` { "categories": [ "Engagement", "Profile", "Related" ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get channel preferences `GET /ssot/activations/metadata/channel-preferences` Tags: Activations. Returns the channel preference options for a channel and data model object (DMO) pair, such as Primary phone or Secondary phone. **Available Version:** 67.0 #### Parameters * `channel` (query, string, required) Contact point channel, such as `Email`, `Phone`, `Push`, `Whatsapp`, or `DigitalId`. **Available Version:** 67.0 Allowed values: `DigitalId`, `Email`, `Phone`, `Push`, `Whatsapp`. * `dataModelObjectApiName` (query, string, required) API name of the contact point data model object (DMO). **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ChannelPreferencesRepresentation`. _Example: example1_ ``` { "preferences": [ { "label": "Any", "option": "ANY" }, { "label": "Personal", "option": "PERSONAL" }, { "label": "Business", "option": "BUSINESS" }, { "label": "Primary", "option": "PRIMARY" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get channels `GET /ssot/activations/metadata/channels` Tags: Activations. Returns the available activation channels for a data space. **Available Version:** 67.0 #### Parameters * `activateOn` (query, string, required) API name of the data model object (DMO) to activate on, such as `ssot__Individual__dlm`. The namespace prefix of the DMO resolves the contact point DMOs (Email, Phone, Push, and so on) for the data space. **Available Version:** 67.0 * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `dataSpace` (query, string, required) Name of the data space to scope channel mapping checks. **Available Version:** 67.0 * `filters` (query, string) Filter expression used to narrow results, such as `field eq value AND name contains foo`. Supported operators are `eq`, `!=`, `contains`, `in`, `>`, `<`, `>=`, and `<=`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression in the form `field [asc|desc][, field [asc|desc]]*`. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ChannelsCollectionRepresentation`. _Example: example1_ ``` { "channels": [ { "apiName": "ssot__ContactPointEmail__dlm", "channelType": "Email", "isMapped": true, "label": "Contact Point Email" }, { "apiName": "ssot__ContactPointPhone__dlm", "channelType": "Phone", "isMapped": true, "label": "Contact Point Phone" }, { "apiName": "ssot__ContactPointApp__dlm", "channelType": "Push", "isMapped": true, "label": "Contact Point App" }, { "apiName": "ssot__ContactPointOTTService__dlm", "channelType": "Whatsapp", "isMapped": false, "label": "Contact Point OTT Service" }, { "apiName": "ssot__ContactPointDigitalId__dlm", "channelType": "DigitalId", "isMapped": true, "label": "Contact Point Digital Id" } ], "currentPageUrl": null, "nextPageUrl": null, "totalSize": 5 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get consent data model objects `GET /ssot/activations/metadata/consent-data-model-objects` Tags: Activations. Returns the standard consent data model objects (DMOs) for a data space. **Available Version:** 67.0 #### Parameters * `activateOn` (query, string, required) API name of the data model object (DMO) to activate on, such as `ssot__Individual__dlm`. The namespace prefix of the DMO resolves the standard consent DMOs (ContactPointConsent, CommunicationSubscriptionConsent) for the data space. **Available Version:** 67.0 * `dataSpace` (query, string, required) Name of the data space to scope the consent data model object lookup. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConsentDataModelObjectsRepresentation`. _Example: example1_ ``` { "dataModelObjects": [ "ssot__ContactPointConsent__dlm", "ssot__CommunicationSubscriptionConsent__dlm" ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get data sources `GET /ssot/activations/metadata/data-sources` Tags: Activations. Returns the data sources for a data model object (DMO). When you provide a channel, results are filtered to data sources compatible with that channel. The data space context is derived from the DMO. **Available Version:** 67.0 #### Parameters * `batchSize` (query, integer) Maximum number of results to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `channel` (query, string) Contact point channel. If unspecified, data sources are returned for all channels compatible with the data model object (DMO). **Available Version:** 67.0 Allowed values: `DigitalId`, `Email`, `Phone`, `Push`, `Whatsapp`. * `dataModelObjectApiName` (query, string, required) API name of the data model object (DMO) used as the activation target. The data space context is derived from this value. **Available Version:** 67.0 * `filters` (query, string) Filter expression used to narrow results, such as `field eq value AND name contains foo`. Supported operators are `eq`, `!=`, `contains`, `in`, `>`, `<`, `>=`, and `<=`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression in the form `field [asc|desc][, field [asc|desc]]*`. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataSourcesCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": null, "dataSources": [ { "dataSourceObjects": [], "id": "3iPVF000000WL2v2AG", "name": "UploadedFiles" }, { "dataSourceObjects": [], "id": "3iPVF000000gQcP2AU", "name": "Salesforce_Home" }, { "dataSourceObjects": [], "id": "3iPVF000000WKzh2AG", "name": "SFMC524001509" }, { "dataSourceObjects": [], "id": "3iPVF000000apdV2AQ", "name": "Commerce_bjmp_prd" }, { "dataSourceObjects": [], "id": "3iPVF000000fyD72AI", "name": "AwsS3_S3" } ], "nextPageUrl": null, "totalSize": 5 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get related attribute activation quota `GET /ssot/activations/metadata/limits/related-attribute-activation-quota` Tags: Activations. Returns the related-attribute activation quota for the org. When you supply an activation ID, that activation is excluded from the current count, which supports edit flows. **Available Version:** 67.0 #### Parameters * `activationId` (query, string) Record ID of an activation to exclude from the current count. Used during edit flows so that the activation being edited doesn't count against itself. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `RelatedAttributeActivationQuotaRepresentation`. _Example: example1_ ``` { "currentActivations": 49, "hasMetLimit": false, "maxActivations": 20000 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get related attribute configuration limits `GET /ssot/activations/metadata/limits/related-attribute-configuration-limits` Tags: Activations. Returns the static configuration limits for related-attribute activations, such as maximum hops and attributes per activation. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `RelatedAttributeConfigurationLimitsRepresentation`. _Example: example1_ ``` { "attributesPerActivation": 300, "dataModelObjectsPerActivation": 8, "dataModelObjectsPerHop": 1, "maxHops": 5, "maxSegmentSize": 150000000, "valuesPerAttribute": 25 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get identity providers for match boost `GET /ssot/activations/metadata/match-boost-identity-providers` Tags: Activations. Returns the identity providers for an activation target and data model object (DMO). **Available Version:** 67.0 #### Parameters * `activateOn` (query, string, required) API name of the data model object (DMO), such as `ssot__Individual__dlm`. **Available Version:** 67.0 * `activationTargetId` (query, string, required) Record ID (15- or 18-character) of the activation target. **Available Version:** 67.0 * `dataSpace` (query, string, required) Name of the data space to scope the provider lookup. **Available Version:** 67.0 * `selectedProviderId` (query, string) Record ID of the previously saved identity provider. Used in edit mode only. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MatchBoostProvidersRepresentation`. _Example: example1_ ``` { "providers": [ { "providerId": "1TQVF0000047WAZ4A2", "providerName": "CustomerZeroMBProvider", "supportedContactPoints": [ "Email", "PhoneNumber" ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get streaming eligibility `GET /ssot/activations/metadata/streaming-eligibility` Tags: Activations. Indicates whether streaming activation is allowed for a data model object (DMO), and provides the reason when it isn't. **Available Version:** 67.0 #### Parameters * `dataModelObjectApiName` (query, string, required) API name of the data model object (DMO) to check streaming eligibility for. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `StreamingEligibilityRepresentation`. _Example: example1_ ``` { "allowed": true, "reason": null } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get activation `GET /ssot/activations/{activationId}` Tags: Activations. Get an activation by ID. **Available Version:** 60.0 #### Parameters * `activationId` (path, string, required) Unique identifier of a specific activation, such as the ID or developer name. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationRepresentation`. _Example S3 activation response: same as POST /ssot/activations 200 response._ _Example: External platform activation response_ ``` { "activationDefinitionId": "17pxx0000004DQ4", "activationMappingSchema": "PII", "activationRecordSchema": "{\"type\":\"object\",\"Version\":{\"type\":\"integer\",\"nullable\":false,\"dataCloudDataType\":null,\"label\":null,\"fieldApiName\":null,\"objectApiName\":null},\"Id\":{\"type\":\"string\",\"nullable\":true,\"dataCloudDataType\":\"Text\",\"label\":\"Individual Id\",\"fieldApiName\":\"ssot__Id__c\",\"objectApiName\":\"ssot__Individual__dlm\"},\"ContactPointEmail\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"objectApiName\":\"ssot__ContactPointEmail__dlm\",\"label\":\"Contact Point Email\",\"EmailAddress\":{\"type\":\"string\",\"nullable\":true,\"dataCloudDataType\":\"Text\",\"label\":\"Email Address\",\"fieldApiName\":\"ssot__EmailAddress__c\",\"objectApiName\":\"ssot__ContactPointEmail__dlm\"}}}}", "activationTarget": { "id": "85Uxx0000004DtcEAE", "lastModifiedDate": "2025-07-11T19:11:26.000Z", "name": "google target", "platformName": "Google Ads Platform", "platformType": "ExternalPlatform", "status": "ACTIVE" }, "activationTargetId": "85Uxx0000004Dtc", "activationTargetName": "google target", "activationTargetSubjectConfig": { "developerName": "ssot__Individual__dlm", "id": "0gjxx00000004pMAAQ", "masterLabel": "Individual", "queryPathConfig": { "configs": [] } }, "attributesConfig": { "attributes": [ { "activationPlatformAttrId": "9xuxx000000011pAAA", "dataSourceType": "Text", "entityName": "ssot__ContactPointEmail__dlm", "label": "Email Address", "name": "ssot__EmailAddress__c", "preferredName": "EmailAddress", "queryPathConfig": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__ContactPointEmail__dlm" } ] } ] }, "referenceAttributeName": "EmailAddress", "source": "RELATED", "type": "MODELRELATED" }, { "dataSourceType": "Text", "entityName": "ssot__Individual__dlm", "label": "Individual Id", "name": "ssot__Id__c", "queryPathConfig": { "configs": [] }, "referenceAttributeName": "Id", "source": "DIRECT", "type": "MODEL" } ] }, "contactPointsConfig": { "contactPoints": [] }, "createdBy": { "id": "005xx000001XBsfAAG" }, "createdDate": "2025-07-07T23:28:48.000Z", "curatedEntity": {}, "dataSourcesConfig": { "dataSources": [] }, "dataSpaceName": "default", "developerName": "google_activation_on_individual_07_07_20251751930927966", "directDmoFiltersConfig": { "filters": [] }, "enabled": true, "historyAudienceDmoApiName": "AA_Google_Ads_Platfor_85Uxx0000004DtcE__dlm", "historyAudienceDmoLabel": "Activation Audience - google target - 4329", "id": "85Rxx0000004D56EAE", "isEnabled": true, "lastModifiedBy": { "id": "005xx000001XBuHAAW" }, "lastModifiedDate": "2025-07-07T23:28:52.000Z", "lastPublishStatus": "SUCCESS", "marketSegmentId": "1sgxx000000010v", "membershipName": "Individual", "name": "google activation on individual 07/07/2025", "queryPathConfig": { "configs": [] }, "refreshType": "INCREMENTAL", "relatedDmoFiltersConfig": { "filters": [ { "entityName": "ssot__ContactPointEmail__dlm", "filterLimit": { "attributeName": "ssot__Id__c", "maxNumberOfValues": 1, "order": "ASC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__ContactPointEmail__dlm" } ] } ] } } ] }, "segmentApiName": "segment_on_individual", "segmentId": "1sgxx000000010v", "shouldExcludeDeletes": false, "shouldExcludeUpdates": false, "staticDataConfig": { "staticData": [] }, "status": "ACTIVE" } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### PUT Update activation `PUT /ssot/activations/{activationId}` Tags: Activations. Update a specific activation by ID. **Available Version:** 60.0 #### Parameters * `activationId` (path, string, required) Unique identifier of a specific activation, such as the ID or developer name. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `ActivationDefinitionInputRepresentation`. _Example: Example_ ``` { "refreshType": "INCREMENTAL", "relatedDmoFiltersConfig": { "filters": [ { "entityName": "ssot__Account__dlm", "filterLimit": { "attributeName": "ssot__Name__c", "maxNumberOfValues": 1, "order": "ASC" }, "queryPathConfigForActivateOnToContainer": { "configs": [ { "queryPaths": { "queryPath": [ { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" }, { "fieldName": "ssot__PartyId__c", "objectName": "ssot__Account__dlm" } ] } } ] } } ] }, "shouldExcludeDeletes": true, "shouldExcludeUpdates": true, "staticDataConfig": { "staticData": [ { "name": "Test_1", "value": "TestValue_1" }, { "name": "Test_2", "value": "TestValue_2" } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationRepresentation`. _Example Example: same as POST /ssot/activations 200 response._ * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### DELETE Delete activation `DELETE /ssot/activations/{activationId}` Tags: Activations. Delete an activation. Because there are no dependency checks, ensure that there are no downstream systems that expect data from this activation before deleting it. After you delete an activation, Data 360 stops sending data to any downstream systems that are associated with the deleted activation. To identify the downstream system (activation target) that is associated with the activation, use the [get activation](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getActivation) endpoint. The get activation endpoint provides the activation target details needed to evaluate the impact before deleting the activation. In the case of an invalid activation ID, the error message “Activation not found for Id: _activationId_” is returned. **Available Version:** 61.0 #### Parameters * `activationId` (path, string, required) Unique identifier of a specific activation, such as the ID or developer name. **Available Version:** 60.0 #### Responses * **200** Success ### POST Publish a Batch DMO activation `POST /ssot/activations/{activationId}/actions/publish` Tags: Activations. Initiate an on-demand publish job for a Batch data model object (DMO) activation. **Available Version:** 66.0 #### Parameters * `activationId` (path, string, required) Unique identifier of a specific activation, such as the market segment activation ID or developer name. **Available Version:** 66.0 #### Request body Media type: `application/json`. Schema: `ActivationPublishActionInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationPublishActionRepresentation`. _Example: Example_ ``` { "errors": [ {} ], "success": true, "publishStatus": "Publishing" } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### GET Get Audience DMO activation records `GET /ssot/activations/{activationId}/data` Tags: Activations. Query activation data. Get a list of all activation records from Audience data model objects (DMOs). **Available Version:** 61.0 #### Parameters * `activationId` (path, string, required) Unique identifier of a specific activation, such as the ID or developer name. **Available Version:** 61.0 * `X-Chatter-Entity-Encoding` (header, string, required) Required. Value must be `false`. * `batchSize` (query, integer) Number of results to return. Values are from `1` through `4999`. If unspecified, the default value is `10000`. **Available Version:** 61.0 * `filters` (query, string) Filter the result set to a more narrow scope or specific type. This filter is supported: * `delta_type__c` (field name: deltaType; type: string; description: delta type of activation records) **Example request with filter:** * GET `https://{dne_cdpInstanceUrl}/services/data/v61.0/ssot/activations/{activationId}/data?filters = delta_type__c in 'A'` **Available Version:** 61.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be greater than or equal to `0`. If unspecified, no rows are skipped. Maximum value is 10 million. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AudienceDMOCollectionRepresentation`. _Example: Example_ ``` { "batchSize": 2, "data": [ { "activatedOnId": "554520203", "activationRecord": "{\"Id\":\"554520203\",\"Version\":1}", "deltaType": "A", "id": "85Rxx0000004C92EAE", "publishDate": "2024-02-26T12:35:41.340Z", "segmentId": "1sgxx0000000001", "segmentOnId": "554520203", "segmentedEntityFqk": "5542", "activatedEntityFqk": "5545" }, { "activatedOnId": "563209729", "activationRecord": "{\"Id\":\"563209729\",\"Version\":1}", "deltaType": "A", "id": "85Rxx0000004C92EAE", "publishDate": "2024-02-26T12:35:41.340Z", "segmentId": "1sgxx0000000001", "segmentOnId": "563209729" } ], "offset": 2 } ``` * **400** The server could not process the request as the parameters or payload are incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested resource. Verify the URL is correct. ### GET Get activation history `GET /ssot/activations/{activationId}/history` Tags: Activations. Returns a paginated list of publish-history records. With a market segment activation ID, returns the history for that single activation. With a market segment ID, returns the history for all activations under that segment. Routing is determined automatically based on the record ID. For paginated results, set `offset` to `0` in the initial request, then follow the `nextPageUrl` value in each response to retrieve subsequent pages. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of history records to return. Values are `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 67.0 Default: `20`. * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort expression. If unspecified, the default value is `publishEndTime desc`. **Available Version:** 67.0 * `pageToken` (query, string) Snapshot anchor for consistent pagination. Omit this value on the first request. The response's `nextPageUrl` includes the `pageToken` for subsequent pages, which keeps the result set stable as new activations are published. Follow `nextPageUrl` rather than constructing this value. **Available Version:** 67.0 * `activationId` (path, string, required) Record ID (15- or 18-character) of a market segment activation or a market segment. Routing to single-activation or segment-wide history is determined automatically based on the record ID. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ActivationHistoryCollectionRepresentation`. _Example: Response_ ``` { "currentPageUrl": null, "nextPageUrl": null, "records": [ { "acceptedPopulation": 10, "activationJobId": "689ce76e-8fd1-4b0d-a227-e5a7d6282a4f", "activationName": "Sales Order Campaign", "activationPlatformName": "SFMC", "activationPopulation": 10, "activationTargetId": "85UVF000000NGwv", "activationTargetName": "MC - MA Legacy", "appendErrorCodeToMessage": null, "dataSource": "Data Cloud", "errorCode": null, "errorMessage": null, "errorTitle": null, "marketSegmentId": "1sgVF000000undx", "partnerValidationSummary": { "validationSummaryErrorCount": [] }, "publishEndTime": "2026-07-20T17:42:37.386Z", "publishStatus": "Completed", "publishType": "Manual", "rejectedPopulation": 0, "segmentPopulation": 12797, "targetSize": 10 } ], "totalPages": 1, "totalSize": 1 } ``` _Example: Paginated response_ ``` { "currentPageUrl": null, "nextPageUrl": "/services/data/v67.0/ssot/activations/85RVF000000dduL/history?offset=1&pageSize=1&pageToken=2026-07-23T22%3A33%3A24.530156", "records": [ { "acceptedPopulation": null, "activationJobId": "61e83650-0ea6-4fc5-ba22-951e16df4576", "activationName": "Sales Order Campaign", "activationPlatformName": "SFMC", "activationPopulation": 0, "activationTargetId": "85UVF000000NGwv", "activationTargetName": "MC - MA Legacy", "appendErrorCodeToMessage": null, "dataSource": "Data Cloud", "errorCode": null, "errorMessage": null, "errorTitle": null, "marketSegmentId": "1sgVF000000undx", "partnerValidationSummary": { "validationSummaryErrorCount": [] }, "publishEndTime": "2026-07-23T22:40:34.569Z", "publishStatus": "Completed", "publishType": "Manual", "rejectedPopulation": null, "segmentPopulation": 12797, "targetSize": null } ], "totalPages": 2, "totalSize": 1 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get agents `GET /ssot/agentic/agents` Tags: Agent Configuration. Returns a list of all registered agents. **Available Version:** 66.0 #### Parameters * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of values of the form `[field=value]`. **Available Version:** 66.0 * `limit` (query, integer) Maximum number of agents to return from `1` through `200`. **Available Version:** 66.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 66.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AgentCollectionRepresentation`. _Example: example1_ ``` { "limit": 20, "offset": 0, "agents": [ { "id": "1lWVF00000001If2AI", "dataspaceName": "default", "label": "Testing_agent", "name": "test_agent_1", "status": "Active", "createdBy": {}, "createdDate": "2026-06-15T15:05:07.000Z", "lastModifiedBy": {}, "lastModifiedDate": "2026-06-15T15:05:07.000Z" }, { "id": "1lWVF00000001Ig3BJ", "dataspaceName": "production", "label": "Customer Service Agent", "name": "customer_service_agent", "status": "Processing", "configuration": { "contextDataSources": { "dataGraphs": [ { "name": "customer_interaction_graph" } ] }, "profileDmos": [ { "name": "IndividualProfile" } ] }, "setupName": { "name": "production_setup" }, "createdBy": {}, "createdDate": "2026-07-01T10:30:22.000Z", "lastModifiedBy": {}, "lastModifiedDate": "2026-07-01T11:45:18.000Z" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create agent `POST /ssot/agentic/agent` Tags: Agent Configuration. Creates a new agent. **Available Version:** 66.0 #### Request body Media type: `application/json`. Schema: `AgentInputRepresentation`. _Example: example1_ ``` { "dataspaceName": "default", "label": "Testing_agent", "name": "test_agent_1", "configuration": { "profileDmos": [ { "name": "Individual_dlm", "associatedDataGraph": "AgenticUnifiedIndividual" } ], "contextDataSources": { "dataGraphs": [ { "name": "CustomerDG1" } ] } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `AgentRepresentation`. _Example: example1_ ``` { "id": "1lWVF00000001If2AI", "dataspaceName": "default", "label": "Testing_agent", "name": "test_agent_1", "setupName": {}, "status": "ACTIVE", "createdBy": {}, "createdDate": "2026-06-15T15:05:07.000Z", "lastModifiedBy": {}, "lastModifiedDate": "2026-06-15T15:05:07.000Z" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. * **409** Agent name already exists. ### GET Get agent `GET /ssot/agentic/agent/{agentIdOrApiName}` Tags: Agent Configuration. Get an existing agent. **Available Version:** 66.0 #### Parameters * `agentIdOrApiName` (path, string, required) ID or API name of the agent. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AgentRepresentation`. _Example: example1_ ``` { "id": "1lWVF00000001If2AI", "dataspaceName": "default", "label": "Testing_agent", "name": "test_agent_1", "status": "ACTIVE", "createdBy": {}, "createdDate": "2026-06-15T15:05:07.000Z", "lastModifiedBy": {}, "lastModifiedDate": "2026-06-15T15:05:07.000Z" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### DELETE Delete agent `DELETE /ssot/agentic/agent/{agentIdOrApiName}` Tags: Agent Configuration. Deletes an existing agent. **Available Version:** 66.0 #### Parameters * `agentIdOrApiName` (path, string, required) ID or API name of the agent. **Available Version:** 66.0 #### Responses * **200** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get calculated insights `GET /ssot/calculated-insights` Tags: Calculated Insights. Get calculated insights in Data 360. **Available Version:** 57.0 #### Parameters * `batchSize` (query, integer) Number of items to return. Values are from `1` through `200`. If unspecified, the default value is `25`. **Available Version:** 57.0 * `dataspace` (query, string) Name of the data space. **Available Version:** 57.0 * `definitionType` (query, string) Definition type of the calculated insight. Values are: * `CALCULATED_METRIC` * `EXTERNAL_METRIC` * `STREAMING_METRIC` **Available Version:** 57.0 * `offset` (query, integer, required) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 57.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c.ASC, Occupation__c.DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 57.0 * `pageToken` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as `currentPageToken` or `nextPageToken`. If unspecified, the first page is returned. **Available Version:** 57.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpCalculatedInsightCollectionRepresentation`. _Example: Example_ ``` { "collection": { "count": 2, "currentPageToken": "eyJvZiI6MCwiYnMiOjI1fQ==", "currentPageUrl": "/services/data/v63.0/ssot/calculated-insights?batchSize=25&offset=0&pageToken=abCdEfG1HIjkLmNo2qR3sT%4U%5V", "items": [ { "apiName": "Unified_Individual_Case_Counts__cio", "calculatedInsightStatus": "ACTIVE", "creationType": "Custom", "dataSpace": "default", "definitionStatus": "IN_USE", "definitionType": "CALCULATED_METRIC", "description": "This is an updated description for the calculated insight.", "dimensions": [ { "apiName": "unified_individual__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__IndividualId__c", "type": "DATA_MODEL" }, "dataType": "Text", "dateGranularity": null, "displayName": "Unified Individual", "fieldRole": "DIMENSION", "formula": "UnifiedIndividual__dlm.ssot__Id__c" } ], "displayName": "Unified Individual Case Counts 2025", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "isEnabled": true, "lastCalcInsightStatusDateTime": "2025-08-21T22:55:00.000Z", "lastCalcInsightStatusErrorCode": null, "lastRunDateTime": "2025-08-21T22:49:08.000Z", "lastRunStatus": "SUCCESS", "lastRunStatusDateTime": "2025-08-21T22:51:32.000Z", "lastRunStatusErrorCode": null, "measures": [ { "apiName": "count_case_id__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__IndividualId__c", "type": "DATA_MODEL" }, "dataType": "Number", "displayName": "Count Case ID", "fieldAggregationType": "AGGREGATABLE", "fieldRole": "MEASURE", "formula": "COUNT(ssot__Case__dlm.ssot__Id__c)" } ], "publishScheduleEndDate": null, "publishScheduleInterval": "NOT_SCHEDULED", "publishScheduleStartDateTime": null }, { "apiName": "unified_individual_case_counts_test__cio", "calculatedInsightStatus": "ACTIVE", "creationType": "Custom", "dataSpace": "default", "definitionStatus": "IN_USE", "definitionType": "CALCULATED_METRIC", "description": "Calculates the number of cases per unified individual.", "dimensions": [ { "apiName": "unified_individual__c", "creationType": "Custom", "dataSource": { "sourceApiName": "KQ_SourceRecordId__c", "type": "DATA_MODEL" }, "dataType": "Text", "dateGranularity": null, "displayName": "unified_individual", "fieldRole": "DIMENSION", "formula": "UnifiedIndividual__dlm.ssot__Id__c" } ], "displayName": "Unified Individual Case Counts Test", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "isEnabled": true, "lastCalcInsightStatusDateTime": "2025-08-21T23:09:55.000Z", "lastCalcInsightStatusErrorCode": null, "lastRunDateTime": null, "lastRunStatus": null, "lastRunStatusDateTime": null, "lastRunStatusErrorCode": null, "measures": [ { "apiName": "count_case_id__c", "creationType": "Custom", "dataSource": { "sourceApiName": "KQ_SourceRecordId__c", "type": "DATA_MODEL" }, "dataType": "Number", "displayName": "count_case_id", "fieldAggregationType": "AGGREGATABLE", "fieldRole": "MEASURE", "formula": "COUNT(ssot__Case__dlm.ssot__Id__c)" } ], "publishScheduleEndDate": null, "publishScheduleInterval": "SIX", "publishScheduleStartDateTime": "2025-12-11T12:00" } ], "nextPageToken": null, "nextPageUrl": null, "previousPageToken": null, "previousPageUrl": null, "total": 2 } } ``` * **400** Illegal character in query at index _index number_. ### POST Create calculated insights `POST /ssot/calculated-insights` Tags: Calculated Insights. Create a calculated insight in Data 360. **Available Version:** 57.0 **Root XML tag:** `` #### Request body (required) Media type: `application/json`. Schema: `CdpCalculatedInsightInputRepresentation`. _Example: Example_ ``` { "apiName": "unified_individual_case_counts_test", "displayName": "Unified Individual Case Counts Test", "definitionType": "CALCULATED_METRIC", "dataSpaceName": "default", "description": "Calculates the number of cases per unified individual.", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "publishScheduleInterval": "Six", "publishScheduleStartDateTime": "2025-12-11T12:00" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpCalculatedInsightRepresentation`. _Example: Example_ ``` { "apiName": "unified_individual_case_counts_test__cio", "calculatedInsightStatus": "PROCESSING", "creationType": "Custom", "dataSpace": "default", "definitionStatus": "IN_USE", "definitionType": "CALCULATED_METRIC", "description": "Calculates the number of cases per unified individual.", "dimensions": [ { "apiName": "unified_individual__c", "creationType": "Custom", "dataSource": { "sourceApiName": "KQ_SourceRecordId__c", "type": "DATA_MODEL" }, "dataType": "Text", "dateGranularity": null, "displayName": "unified_individual", "fieldRole": "DIMENSION", "formula": "UnifiedIndividual__dlm.ssot__Id__c" } ], "displayName": "Unified Individual Case Counts Test", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "isEnabled": true, "lastCalcInsightStatusDateTime": "2025-08-21T23:09:50.000Z", "lastCalcInsightStatusErrorCode": null, "lastRunDateTime": null, "lastRunStatus": null, "lastRunStatusDateTime": null, "lastRunStatusErrorCode": null, "measures": [ { "apiName": "count_case_id__c", "creationType": "Custom", "dataSource": { "sourceApiName": "KQ_SourceRecordId__c", "type": "DATA_MODEL" }, "dataType": "Number", "displayName": "count_case_id", "fieldAggregationType": "AGGREGATABLE", "fieldRole": "MEASURE", "formula": "COUNT(ssot__Case__dlm.ssot__Id__c)" } ], "publishScheduleEndDate": null, "publishScheduleInterval": "SIX", "publishScheduleStartDateTime": "2025-12-11T12:00" } ``` * **400** Required field missing or entity save error. For example: * Missing required field(s): _required field name_. * Calculated insight with the same name already exists, developerName = _apiName_. ### GET Get calculated insight `GET /ssot/calculated-insights/{apiName}` Tags: Calculated Insights. Get a calculated insight in Data 360. **Available Version:** 57.0 #### Parameters * `apiName` (path, string, required) API name of the calculated insight with suffix `__cio`. **Available Version:** 57.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpCalculatedInsightRepresentation`. _Example: Example_ ``` { "apiName": "Unified_Individual_Case_Counts__cio", "calculatedInsightStatus": "ACTIVE", "creationType": "Custom", "dataSpace": "default", "definitionStatus": "IN_USE", "definitionType": "CALCULATED_METRIC", "description": null, "dimensions": [ { "apiName": "unified_individual__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__IndividualId__c", "type": "DATA_MODEL" }, "dataType": "Text", "dateGranularity": null, "displayName": "Unified Individual", "fieldRole": "DIMENSION", "formula": "UnifiedIndividual__dlm.ssot__Id__c" } ], "displayName": "Unified Individual Case Counts", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "isEnabled": true, "lastCalcInsightStatusDateTime": "2025-08-20 T22:24:56.000Z", "lastCalcInsightStatusErrorCode": null, "lastRunDateTime": "2025-08-20 T22:26:23.000Z", "lastRunStatus": "SUCCESS", "lastRunStatusDateTime": "2025-08-20 T22:28:16.000Z", "lastRunStatusErrorCode": null, "measures": [ { "apiName": "count_case_id__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__IndividualId__c", "type": "DATA_MODEL" }, "dataType": "Number", "displayName": "Count Case ID", "fieldAggregationType": "AGGREGATABLE", "fieldRole": "MEASURE", "formula": "COUNT(ssot__Case__dlm.ssot__Id__c)" } ], "publishScheduleEndDate": null, "publishScheduleInterval": "NOT_SCHEDULED", "publishScheduleStartDateTime": null } ``` * **400** Calculated insight API name must end in \_\_cio. * **404** Calculated insight record not found. ### DELETE Delete calculated insight `DELETE /ssot/calculated-insights/{apiName}` Tags: Calculated Insights. Delete a calculated insight in Data 360. **Available Version:** 57.0 #### Parameters * `apiName` (path, string, required) API name of the calculated insight with suffix `__cio`. **Available Version:** 57.0 #### Responses * **204** Success * **400** * Calculated insight API name must end in \_\_cio. * Could not retrieve calculated insight with developer name, _apiName_. ### PATCH Update calculated insight `PATCH /ssot/calculated-insights/{apiName}` Tags: Calculated Insights. Update a calculated insight in Data 360. **Available Version:** 57.0 **Root XML tag:** `` #### Parameters * `apiName` (path, string, required) API name of the calculated insight with suffix `__cio`. **Available Version:** 57.0 #### Request body (required) Media type: `application/json`. Schema: `CdpCalculatedInsightInputRepresentation`. _Example: Example_ ``` { "displayName": "Unified Individual Case Counts 2025", "description": "This is an updated description for the calculated insight.", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "draft": false, "createdFromPackage": false, "dataSpaceName": "default", "publishScheduleInterval": "Six", "publishScheduleStartDateTime": "2025-10-20T22:00:00.000Z", "publishScheduleEndDate": "2025-11-20T22:00:00.000Z" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpCalculatedInsightRepresentation`. _Example: Example_ ``` { "apiName": "Unified_Individual_Case_Counts__cio", "calculatedInsightStatus": "PROCESSING", "creationType": "Custom", "dataSpace": "default", "definitionStatus": "IN_USE", "definitionType": "CALCULATED_METRIC", "description": "This is an updated description for the calculated insight.", "dimensions": [ { "apiName": "unified_individual__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__Id__c", "type": "DATA_MODEL" }, "dataType": "Text", "dateGranularity": null, "displayName": "Unified Individual", "fieldRole": "DIMENSION", "formula": "UnifiedIndividual__dlm.ssot__Id__c" } ], "displayName": "Unified Individual Case Counts 2025", "expression": "SELECT COUNT(ssot__Case__dlm.ssot__Id__c) AS count_case_id__c, UnifiedIndividual__dlm.ssot__Id__c AS unified_individual__c FROM UnifiedIndividual__dlm JOIN IndividualIdentityLink__dlm ON (UnifiedIndividual__dlm.ssot__Id__c = IndividualIdentityLink__dlm.UnifiedRecordId__c) JOIN ssot__Individual__dlm ON (IndividualIdentityLink__dlm.SourceRecordId__c = ssot__Individual__dlm.ssot__Id__c AND IndividualIdentityLink__dlm.KQ_SourceRecordId__c = ssot__Individual__dlm.KQ_Id__c) JOIN ssot__Case__dlm ON (ssot__Individual__dlm.ssot__Id__c = ssot__Case__dlm.ssot__IndividualId__c AND ssot__Individual__dlm.KQ_Id__c = ssot__Case__dlm.KQ_IndividualId__c) GROUP BY unified_individual__c", "isEnabled": true, "lastCalcInsightStatusDateTime": "2025-08-21T23:27:13.000Z", "lastCalcInsightStatusErrorCode": "CREATE_FAILED", "lastRunDateTime": "2025-08-21T22:49:08.000Z", "lastRunStatus": "SUCCESS", "lastRunStatusDateTime": "2025-08-21T22:51:32.000Z", "lastRunStatusErrorCode": null, "measures": [ { "apiName": "count_case_id__c", "creationType": "Custom", "dataSource": { "sourceApiName": "ssot__Id__c", "type": "DATA_MODEL" }, "dataType": "Number", "displayName": "Count Case ID", "fieldAggregationType": "AGGREGATABLE", "fieldRole": "MEASURE", "formula": "COUNT(ssot__Case__dlm.ssot__Id__c)" } ], "publishScheduleEndDate": "2025-11-20", "publishScheduleInterval": "SIX", "publishScheduleStartDateTime": "2025-10-20T22:00" } ``` * **400** Invalid input or entity save error. For example: * Cannot change the calculated insight developer name when status is ACTIVE. ### POST Run calculated insight `POST /ssot/calculated-insights/{apiName}/actions/run` Tags: Calculated Insights. Trigger a run on a calculated insight in Data 360. This `POST` endpoint doesn't accept request parameters or a request body. **Available Version:** 57.0 #### Parameters * `apiName` (path, string, required) API name of the calculated insight with suffix `__cio`. **Available Version:** 57.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpCalculatedInsightStandardActionResponseRepresentation`. * **400** Calculated insight API name must end in \_\_cio. * **404** Calculated insight record not found. ### POST Create communication capping configuration `POST /ssot/communication-capping` Tags: Communication Capping. Creates a communication capping configuration entity. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingEntityInputRepresentation`. _Example: example1_ ``` { "name": "Holiday Email Frequency Cap", "description": "Caps promotional emails per individual during the holiday season", "dataCommCapDataSpaces": { "dataCommCapDataSpaces": [ { "dataSpaceId": "0uuxx0000000001AAA" } ] }, "dataCommCapRelatedDims": { "dataCommCapRelatedDims": [ { "apiName": "Channel__c", "dataCommCapDimId": "1CDxx0000000001GAA" }, { "apiName": "Brand__c", "dataCommCapDimId": "1CDxx0000000002GAA" } ] } } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `CommunicationCappingEntityRepresentation`. _Example: example1_ ``` { "id": "0COxx0000000001GAA", "dataCommunicationCapDefId": "0COxx0000000001GAA", "dataCommunicationCapStatus": "PROCESSING", "description": "Caps promotional emails per individual during the holiday season", "name": "Holiday Email Frequency Cap", "dataCommCapDataSpaces": [ { "dataCommunicationCapDefId": "0COxx0000000001GAA", "dataSpaceId": "0uuxx0000000001AAA", "dataSpaceName": "default", "apiName": "HolidayEmailFrequencyCap_DS__c" } ], "dataCommCapRelatedDims": [ { "dataCommunicationCapDefId": "0COxx0000000001GAA", "apiName": "Channel__c", "dataCommCapDimId": "1CDxx0000000001GAA", "dataCommCapDimName": "Channel" }, { "dataCommunicationCapDefId": "0COxx0000000001GAA", "apiName": "Brand__c", "dataCommCapDimId": "1CDxx0000000002GAA", "dataCommCapDimName": "Brand" } ] } ``` * **400** Bad request. * **500** Internal server error. ### GET Get activation target dimension metadata `GET /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` Tags: Communication Capping. Gets activation target dimension metadata for a given activation target ID. **Available Version:** 67.0 #### Parameters * `activationTargetId` (path, string, required) Record ID of the activation target. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingActivationTargetCollectionRepresentation`. _Example: example1_ ``` { "“activationTargets”": [ { "“id”": "“1ATxx0000000001GAA”", "“activationTargetId”": "“0auxx0000000001AAA”", "“actvTargetName”": "“Marketing Cloud - Email Activation”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Map dimension metadata to activation target `POST /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` Tags: Communication Capping. Maps dimension metadata to a communication capping activation target. **Available Version:** 67.0 #### Parameters * `activationTargetId` (path, string, required) Record ID of the activation target. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingActivationTargetInputRepresentation`. _Example: example1_ ``` { "activationTargetName": "Marketing Cloud - Email Activation", "dataCommCapDimInfo": { "dataCommCapDimInfo": [ { "dataCommCapDimId": "1CDxx0000000001GAA", "dataCommCapDimValueId": "1CVxx0000000001GAA" }, { "dataCommCapDimId": "1CDxx0000000002GAA", "dataCommCapDimValueId": "1CVxx0000000003GAA" } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingActivationTargetCollectionRepresentation`. _Example: example1_ ``` { "“activationTargets”": [ { "“id”": "“1ATxx0000000001GAA”", "“activationTargetId”": "“0auxx0000000001AAA”", "“actvTargetName”": "“Marketing Cloud - Email Activation”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": { "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } }, { "“id”": "“1ATxx0000000002GAA”", "“activationTargetId”": "“0auxx0000000001AAA”", "“actvTargetName”": "“Marketing Cloud - Email Activation”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000002GAA”", "“name”": "“Brand”", "“functionType”": "“NON_FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__Brand__dlm”", "“hierarchyOrder”": 2, "“apiName”": "“Brand__c”" }, "“dataCommCapDimValue”": { "“id”": "“1CVxx0000000010GAA”", "“dataCommCapDimId”": "“1CDxx0000000002GAA”", "“value”": "“Acme”", "“apiName”": "“Acme__c”" } } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### DELETE Delete activation target metadata `DELETE /ssot/communication-capping/activation-target-capping-metadata/{activationTargetId}` Tags: Communication Capping. Deletes activation target dimension metadata for a given activation target ID. **Available Version:** 67.0 #### Parameters * `activationTargetId` (path, string, required) Record ID of the activation target. **Available Version:** 67.0 #### Responses * **204** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### GET Get communication capping dimensions `GET /ssot/communication-capping/dimensions` Tags: Communication Capping. Gets dimension information for a communication capping configuration by communication capping ID or data space ID. **Available Version:** 67.0 #### Parameters * `ccId` (query, string) Record ID of the communication capping configuration. **Available Version:** 67.0 * `dataSpaceId` (query, string) Record ID of the data space. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingDimCollectionRepresentation`. _Example: example1_ ``` { "dimensions": [ { "id": "1CDxx0000000001GAA", "name": "Channel", "functionType": "FUNCTIONAL_TYPE", "dimensionName": "ssot__CommunicationChannel__dlm", "hierarchyOrder": 1, "apiName": "Channel__c", "dimensionValues": [ { "id": "1CVxx0000000001GAA", "dataCommCapDimId": "1CDxx0000000001GAA", "value": "Email", "apiName": "Email__c" }, { "id": "1CVxx0000000002GAA", "dataCommCapDimId": "1CDxx0000000001GAA", "value": "SMS", "apiName": "SMS__c" } ] }, { "id": "1CDxx0000000002GAA", "name": "Brand", "functionType": "NON_FUNCTIONAL_TYPE", "dimensionName": "ssot__Brand__dlm", "hierarchyOrder": 2, "apiName": "Brand__c", "dimensionValues": [ { "id": "1CVxx0000000010GAA", "dataCommCapDimId": "1CDxx0000000002GAA", "value": "Acme", "apiName": "Acme__c" } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Create communication capping dimension `POST /ssot/communication-capping/dimensions` Tags: Communication Capping. Creates a communication capping dimension. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingDimInputRepresentation`. _Example: example1_ ``` { "“name”": "“Channel”", "“apiName”": "“Channel__c”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“dimensionValues”": { "“dimensionValues”": [ { "“value”": "“Email”", "“apiName”": "“Email__c”" }, { "“value”": "“SMS”", "“apiName”": "“SMS__c”" } ] } } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `CommunicationCappingDimRepresentation`. _Example: example1_ ``` { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”", "“dimensionValues”": [ { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" }, { "“id”": "“1CVxx0000000002GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“SMS”", "“apiName”": "“SMS__c”" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### PATCH Update communication capping dimension priority `PATCH /ssot/communication-capping/dimensions/actions/swap-priority` Tags: Communication Capping. Updates the priority order of communication capping dimensions. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingDimPriorityInputRepresentation`. _Example: example1_ ``` { "dimensions": { "dimensions": [ { "id": "1CDxx0000000002GAA", "hierarchyOrder": 1 }, { "id": "1CDxx0000000001GAA", "hierarchyOrder": 2 } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingDimCollectionRepresentation`. _Example: example1_ ``` { "dimensions": [ { "id": "1CDxx0000000002GAA", "name": "Brand", "functionType": "NON_FUNCTIONAL_TYPE", "dimensionName": "ssot__Brand__dlm", "hierarchyOrder": 1, "apiName": "Brand__c", "dimensionValues": [ { "id": "1CVxx0000000010GAA", "dataCommCapDimId": "1CDxx0000000002GAA", "value": "Acme", "apiName": "Acme__c" } ] }, { "id": "1CDxx0000000001GAA", "name": "Channel", "functionType": "FUNCTIONAL_TYPE", "dimensionName": "ssot__CommunicationChannel__dlm", "hierarchyOrder": 2, "apiName": "Channel__c", "dimensionValues": [ { "id": "1CVxx0000000001GAA", "dataCommCapDimId": "1CDxx0000000001GAA", "value": "Email", "apiName": "Email__c" } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### PATCH Update communication capping dimension `PATCH /ssot/communication-capping/dimensions/{dimensionId}` Tags: Communication Capping. Updates a communication capping dimension. **Available Version:** 67.0 #### Parameters * `dimensionId` (path, string, required) Record ID of the dimension. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingDimInputRepresentation`. _Example: example1_ ``` { "id": "1CDxx0000000001GAA", "name": "Channel (Renamed)", "apiName": "Channel__c", "functionType": "COUNT", "dimensionName": "ssot__CommunicationChannel__dlm", "hierarchyOrder": 2, "dimensionValues": { "dimensionValues": [ { "id": "1CVxx0000000001GAA", "value": "Email", "apiName": "Email__c", "dataCommCapDimId": "1CDxx0000000001GAA" } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingDimRepresentation`. _Example: example1_ ``` { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel (Renamed)”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 2, "“apiName”": "“Channel__c”", "“dimensionValues”": [ { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### DELETE Delete communication capping rule `DELETE /ssot/communication-capping/rules/{ruleIdOrName}` Tags: Communication Capping. Deletes a communication capping rule. **Available Version:** 67.0 #### Parameters * `ruleIdOrName` (path, string, required) Record ID or API name of the rule. **Available Version:** 67.0 #### Responses * **204** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### GET Get communication capping configuration `GET /ssot/communication-capping/{id}` Tags: Communication Capping. Returns a communication capping configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingRepresentation`. _Example: example1_ ``` { "id": "0COxx0000000001GAA", "name": "Holiday_Email_Frequency_Cap", "label": "Holiday Email Frequency Cap", "createdBy": { "id": "005xx000001Sv1AAAS", "name": "Integration User" }, "createdDate": "2026-09-22T18:04:11.000Z", "lastModifiedBy": { "id": "005xx000001Sv1AAAS", "name": "Integration User" }, "lastModifiedDate": "2026-09-22T18:06:52.000Z", "url": "/services/data/v62.0/ssot/communication-cappings/0COxx0000000001GAA", "description": "Caps promotional emails per individual during the holiday season", "status": "ACTIVE", "dataspacesInfo": [ { "id": "0uuxx0000000001AAA", "name": "default", "label": "default", "namespace": "" } ], "dimensions": [ { "id": "1CDxx0000000001GAA", "name": "Channel", "label": "Channel", "namespace": "", "type": "FUNCTIONAL", "hierarchyOrder": 1, "values": [ { "id": "1CVxx0000000001GAA", "name": "Email", "label": "Email", "namespace": "" } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### PATCH Update communication capping configuration `PATCH /ssot/communication-capping/{id}` Tags: Communication Capping. Updates a communication capping configuration entity. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingEntityInputRepresentation`. _Example: example1_ ``` { "“id”": "“0COxx0000000001GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“name”": "“Holiday Email Frequency Cap (Updated)”", "“description”": "“Updated caps for the extended holiday season”", "“dataCommCapDataSpaces”": { "“dataCommCapDataSpaces”": [ { "“dataSpaceId”": "“0uuxx0000000001AAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”" } ] }, "“dataCommCapRelatedDims”": { "“dataCommCapRelatedDims”": [ { "“apiName”": "“Channel__c”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”" } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingEntityRepresentation`. _Example: example1_ ``` { "“id”": "“0COxx0000000001GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“dataCommunicationCapStatus”": "“ACTIVE”", "“lastStatusDateTime”": "“2026-09-22T19:10:03.000Z”", "“description”": "“Updated caps for the extended holiday season”", "“name”": "“Holiday Email Frequency Cap (Updated)”", "“dataCommCapDataSpaces”": [ { "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“dataSpaceId”": "“0uuxx0000000001AAA”", "“dataSpaceName”": "“default”", "“apiName”": "“HolidayEmailFrequencyCap_DS__c”" } ], "“dataCommCapRelatedDims”": [ { "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“apiName”": "“Channel__c”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“dataCommCapDimName”": "“Channel”" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Disable communication capping `POST /ssot/communication-capping/{id}/actions/disable` Tags: Communication Capping. Disables a communication capping configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingActionResponseRepresentation`. _Example: example1_ ``` { "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Enable communication capping `POST /ssot/communication-capping/{id}/actions/enable` Tags: Communication Capping. Enables a communication capping configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingActionResponseRepresentation`. _Example: example1_ ``` { "success": true } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### GET Get communication capping activation targets `GET /ssot/communication-capping/{id}/activation-targets` Tags: Communication Capping. Returns a paginated list of activation targets for a communication capping configuration. **Available Version:** 67.0 #### Parameters * `orderByColumn` (query, string) Column to sort the results by. **Available Version:** 67.0 Allowed values: `Id`, `ActivationTargetId`, `Name`, `CreatedById`, `CreatedDate`, `LastModifiedById`, `LastModifiedDate`, `DataCommCapDimId`, `DataCommCapDimValueId`. Default: `Name`. * `orderByDirection` (query, string) Sort direction of the results. **Available Version:** 67.0 Allowed values: `ASC`, `DESC`. * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of activation targets to return. **Available Version:** 67.0 * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingActivationTargetCollectionRepresentation`. _Example: example1_ ``` { "“activationTargets”": [ { "“id”": "“1ATxx0000000001GAA”", "“activationTargetId”": "“0auxx0000000001AAA”", "“actvTargetName”": "“Marketing Cloud - Email Activation”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } }, { "“id”": "“1ATxx0000000003GAA”", "“activationTargetId”": "“0auxx0000000002AAA”", "“actvTargetName”": "“SMS Activation Target”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": { "“id”": "“1CVxx0000000002GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“SMS”", "“apiName”": "“SMS__c”" } } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### GET Get communication capping rules `GET /ssot/communication-capping/{id}/rules` Tags: Communication Capping. Returns a paginated list of rules for a communication capping configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 * `orderByColumn` (query, string) Column to sort the results by. **Available Version:** 67.0 Allowed values: `Id`, `DeveloperName`, `MasterLabel`, `StartDate`, `EndDate`, `Limits`, `Source`, `CreatedById`, `CreatedDate`, `LastModifiedById`, `LastModifiedDate`. Default: `EndDate`. * `orderByDirection` (query, string) Sort direction of the results. **Available Version:** 67.0 Allowed values: `ASC`, `DESC`. * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of rules to return. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingRuleCollectionRepresentation`. _Example: example1_ ``` { "“rules”": [ { "“id”": "“1CRxx0000000001GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“startDate”": "“2026-01-01T00:00:00.000Z”", "“endDate”": "“2026-03-31T23:59:59.000Z”", "“limits”": 5, "“apiName”": "“Holiday_Email_Rule_1__c”", "“source”": "“API”", "“dataCommCapRuleDim”": [ { "“id”": "“1RDxx0000000001GAA”", "“dataCommCapRuleId”": "“1CRxx0000000001GAA”", "“apiName”": "“Channel_RuleDim__c”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": [ { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } ] } ] }, { "“id”": "“1CRxx0000000002GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“startDate”": "“2026-04-01T00:00:00.000Z”", "“endDate”": "“2026-06-30T23:59:59.000Z”", "“limits”": 3, "“apiName”": "“Holiday_Email_Rule_2__c”", "“source”": "“UI”", "“dataCommCapRuleDim”": [] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Create communication capping rule `POST /ssot/communication-capping/{id}/rules` Tags: Communication Capping. Creates a communication capping rule for a configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingRuleInputRepresentation`. _Example: example1_ ``` { "startDate": "2026-01-01T00:00:00.000Z", "endDate": "2026-03-31T23:59:59.000Z", "limits": 5, "dataCommCapRuleDim": { "dataCommCapRuleDim": [ { "dimId": "1CDxx0000000001GAA", "dimValueIds": { "dimValueIds": [ "1CVxx0000000001GAA", "1CVxx0000000002GAA" ] } } ] } } ``` #### Responses * **201** Successfully created communication capping rule Media type: `application/json`. Schema: `CommunicationCappingRuleRepresentation`. _Example: example1_ ``` { "“id”": "“1CRxx0000000001GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“endDate”": "“2026-03-31T23:59:59.000Z”", "“limits”": 5, "“apiName”": "“Holiday_Email_Rule_1__c”", "“source”": "“API”", "“dataCommCapRuleDim”": [ { "“id”": "“1RDxx0000000001GAA”", "“dataCommCapRuleId”": "“1CRxx0000000001GAA”", "“apiName”": "“Channel_RuleDim__c”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": [ { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" }, { "“id”": "“1CVxx0000000002GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“SMS”", "“apiName”": "“SMS__c”" } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### PATCH Update communication capping rule `PATCH /ssot/communication-capping/{id}/rules/{ruleIdOrName}` Tags: Communication Capping. Updates a communication capping rule within a configuration. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) Record ID of the communication capping configuration. **Available Version:** 67.0 * `ruleIdOrName` (path, string, required) Record ID or API name of the rule. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `CommunicationCappingRuleInputRepresentation`. _Example: example1_ ``` { "startDate": "2026-01-01T00:00:00.000Z", "endDate": "2026-04-30T23:59:59.000Z", "limits": 3, "dataCommCapRuleDim": { "dataCommCapRuleDim": [ { "dimId": "1CDxx0000000001GAA", "dimValueIds": { "dimValueIds": [ "1CVxx0000000001GAA" ] } } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CommunicationCappingRuleRepresentation`. _Example: example1_ ``` { "“id”": "“1CRxx0000000001GAA”", "“dataCommunicationCapDefId”": "“0COxx0000000001GAA”", "“startDate”": "“2026-01-01T00:00:00.000Z”", "“endDate”": "“2026-04-30T23:59:59.000Z”", "“limits”": 3, "“source”": "“API”", "“dataCommCapRuleDim”": [ { "“id”": "“1RDxx0000000001GAA”", "“dataCommCapRuleId”": "“1CRxx0000000001GAA”", "“apiName”": "“Channel_RuleDim__c”", "“dataCommCapDim”": { "“id”": "“1CDxx0000000001GAA”", "“name”": "“Channel”", "“functionType”": "“FUNCTIONAL_TYPE”", "“dimensionName”": "“ssot__CommunicationChannel__dlm”", "“hierarchyOrder”": 1, "“apiName”": "“Channel__c”" }, "“dataCommCapDimValue”": [ { "“id”": "“1CVxx0000000001GAA”", "“dataCommCapDimId”": "“1CDxx0000000001GAA”", "“value”": "“Email”", "“apiName”": "“Email__c”" } ] } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### GET Get connections `GET /ssot/connections` Tags: Connections. Get a paginated list of Data 360 connections that exist in an org by connector type. **Available Version:** 60.0 #### Parameters * `connectorType` (query, string, required) Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. **Available Version:** 62.0 * `devName` (query, string) Developer name of the connector. **Available Version:** 62.0 * `label` (query, string) Label or public-facing name to filter on. **Available Version:** 62.0 * `limit` (query, integer) Maximum number of connections to return. **Available Version:** 62.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be greater than or equal to `0`. If unspecified, no rows are skipped. **Available Version:** 62.0 * `orderBy` (query, string) Sort connectors by field names. Supported field names are `label`, `createdDate`, and `lastModifiedDate`. **Available Version:** 62.0 * `organizationId` (query, string) Organization ID to filter on. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionCollectionRepresentation`. _Example: SalesforceMarketingCloud connection request_ ``` { "connections": [ { "activationBusinessUnits": [ { "id": "3khX400000001vNIAQ", "label": "whatsapp dreamforce QA3_524000406", "mid": "524000406", "name": "sfmc_524000406" }, { "id": "3khX400000001wzIAA", "label": "WhatsApp BU_524000846", "mid": "524000846", "name": "sfmc_524000846" } ], "connectorType": "SalesforceMarketingCloud", "eid": "524000406", "id": "1WMX40000000IeTOAU", "ingestionBusinessUnits": [ { "id": "3khX400000001vNIAQ", "label": "whatsapp dreamforce QA3_524000406", "mid": "524000406", "name": "sfmc_524000406" }, { "id": "3khX400000001wzIAA", "label": "WhatsApp BU_524000846", "mid": "524000846", "name": "sfmc_524000846" } ], "businessUnitsToDataSpaces": [ { "label": "WhatsApp_BU_524000846_service", "name": "WhatsApp_BU_524000846_service", "internalOrgName": "WhatsApp BU_524000846", "internalOrgId": "3khxx000000009hAAA", "mid": "524000846", "dataspaceId": "0wSxx00000000BJEAY", "dataspaceName": "Service" } ], "createProfileBuMappings": "true", "label": "524000406", "name": "X524000406" }, { "activationBusinessUnits": [ { "id": "3khX4000000021pIAA", "label": "Data Cloud MC Connector_524000668", "mid": "524000668", "name": "sfmc_524000668" } ], "connectorType": "SalesforceMarketingCloud", "eid": "524000668", "id": "1WMX40000000IkvOAE", "ingestionBusinessUnits": [ { "id": "3khX4000000021pIAA", "label": "Data Cloud MC Connector_524000668", "mid": "524000668", "name": "sfmc_524000668" } ], "businessUnitsToDataSpaces": [ { "label": "Data_Cloud_MC_Connector_524000668_default", "name": "Data_Cloud_MC_Connector_524000668_default", "internalOrgName": "Data Cloud MC Connector_524000668", "internalOrgId": "9kkxx000000009hAAA", "mid": "524000668", "dataspaceId": "0wRtu00000000BBJEY", "dataspaceName": "default" } ], "createProfileBuMappings": "true", "label": "524000668", "name": "X524000668" } ], "currentPageUrl": "/services/data/v63.0/ssot/connections?connectorType=SalesforceMarketingCloud&limit=50&offset=0", "totalSize": 2 } ``` _Example: SalesforceDotCom connection request_ ``` { "connections": [ { "alias": "Home", "connectionStatus": "Connected", "connectorType": "SalesforceDotCom", "createdDate": "2024-11-18T01:02:11.000Z", "id": "0hMX40000002A6XMAU", "label": "Salesforce Connector Home", "name": "SalesforceDotCom_Home", "organizationId": "00DX40000019beX" } ], "totalSize": 1 } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### POST Create connection `POST /ssot/connections` Tags: Connections. Create a Data 360 connector. **Available Version:** 64.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionInputRepresentation`. #### Responses * **201** Success Media type: `application/json`. Schema: `ConnectionRepresentation`. * **400** The request could not be understood, usually because the ID is not valid for the particular resource. For example, the request passed a userId where a groupId is required. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### GET Get connection `GET /ssot/connections/{connectionId}` Tags: Connections. Get information about a Data 360 connection. Different connector types return different response payloads. For example, the response for a `StreamingApp` connector is different from the response for a `SalesforceMarketingCloud` connector. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionRepresentation`. _Example: Example_ ``` { "activationBusinessUnits": [ { "id": "3khX400000001tmIAA", "label": "Data 360 MC Connector BU01_524000673", "mid": "524000673", "name": "sfmc_524000673" } ], "connectorType": "SalesforceMarketingCloud", "eid": "524000668", "id": "1WMX40000000IZdOAM", "ingestionBusinessUnits": [ { "id": "3khX400000001tlIAA", "label": "Data 360 MC Connector_524000668", "mid": "524000668", "name": "sfmc_524000668" }, { "id": "3khX400000001tmIAA", "label": "Data 360 MC Connector BU01_524000673", "mid": "524000673", "name": "sfmc_524000673" } ], "label": "Salesforce Marketing Cloud NA1", "name": "Salesforce_Marketing_Cloud_NA1" } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### PUT Replace connection `PUT /ssot/connections/{connectionId}` Tags: Connections. Update a Data 360 connector, completely replacing all existing data for the connector with the data passed in the request. **Available Version:** 61.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionInputRepresentation`. #### Responses * **204** Success Media type: `application/json`. Schema: `ConnectionRepresentation`. * **400** The request could not be understood, usually because the ID is not valid for the particular resource. For example, the request passed a userId where a groupId is required. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### DELETE Delete connection `DELETE /ssot/connections/{connectionId}` Tags: Connections. Delete a Data 360 connector. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Responses * **204** Success * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### PATCH Update connection `PATCH /ssot/connections/{connectionId}` Tags: Connections. Update a Data 360 connector, replacing only the data passed in the request. **Available Version:** 63.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionPatchInputRepresentation`. _Example: SalesforceMarketingCloud connection request_ ``` { "connectorType": "SalesforceMarketingCloud", "addIngestionBusinessUnits": [ "524002279" ], "removeIngestionBusinessUnits": [ "524002280" ], "addActivationBusinessUnits": [ "524002279" ], "removeActivationBusinessUnits": [ "524002280" ], "addBusinessUnitsToDataSpaces": [ { "dataspaceName": "default", "mid": "524000406" } ], "removeBusinessUnitsToDataSpaces": [ { "dataspaceName": "dataspace1", "mid": "524004881" } ], "createProfileBuMappings": "true" } ``` #### Responses * **204** Success Media type: `application/json`. Schema: `ConnectionRepresentation`. _Example: SalesforceMarketingCloud connection response_ ``` { "activationBusinessUnits": [ { "id": "3khX400000001vNIAQ", "label": "whatsapp dreamforce QA3_524000406", "mid": "524000406", "name": "sfmc_524000406" }, { "id": "3khX400000001wzIAA", "label": "WhatsApp BU_524000846", "mid": "524000846", "name": "sfmc_524000846" } ], "connectorType": "SalesforceMarketingCloud", "eid": "524000406", "id": "1WMX40000000IeTOAU", "ingestionBusinessUnits": [ { "id": "3khX400000001vNIAQ", "label": "whatsapp dreamforce QA3_524000406", "mid": "524000406", "name": "sfmc_524000406" }, { "id": "3khX400000001wzIAA", "label": "WhatsApp BU_524000846", "mid": "524000846", "name": "sfmc_524000846" } ], "businessUnitsToDataSpaces": [ { "label": "WhatsApp_BU_524000846_service", "name": "WhatsApp_BU_524000846_service", "internalOrgName": "WhatsApp BU_524000846", "internalOrgId": "3khxx000000009hAAA", "mid": "524000846", "dataspaceId": "0wSxx00000000BJEAY", "dataspaceName": "Service" }, { "label": "whatsapp_dreamforce_QA3_524000406_marketing", "name": "whatsapp_dreamforce_QA3_524000406_marketing", "internalOrgName": "whatsapp dreamforce QA3_524000406", "internalOrgId": "7rhxx000000009hAAA", "mid": "524000406", "dataspaceId": "0wSxx00000000BLDVY", "dataspaceName": "Marketing" } ], "createProfileBuMappings": "true", "label": "524000406", "name": "X524000406" } ``` * **400** The request could not be understood, usually because the ID is not valid for the particular resource. For example, the request passed a userId where a groupId is required. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### POST Get connection database schemas `POST /ssot/connections/{connectionId}/database-schemas` Tags: Connections. Get a list of database schema names for a connection. **Available Version:** 63.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Request body Media type: `application/json`. Schema: `ConnectionDbSchemaCollectionInputRepresentation`. _Example: Example_ ``` { "advancedAttributes": { "databaseName": "testdb" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionDbSchemaCollectionRepresentation`. _Example: Example_ ``` { "schemas": [ "testSchema", "testSchema2" ] } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Get connection databases `POST /ssot/connections/{connectionId}/databases` Tags: Connections. Get a list of databases for a connection. This `POST` endpoint doesn't accept a request body. **Available Version:** 63.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionDatabaseCollectionRepresentation`. _Example: Example_ ``` { "databases": [ "main", "samples", "hive_metadata" ] } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### GET Get connection endpoints `GET /ssot/connections/{connectionId}/endpoints` Tags: Connections. Get the endpoints of an Ingestion API connector as a binary stream. The stream contains a YAML file that includes the OpenAPI definitions of the endpoints for the connector. You can push the returned data to a data lake object (DLO). **Available Version:** 61.0 #### Parameters * `connectionId` (path, string, required) The ID for the connection. **Available Version:** 61.0 #### Responses * **200** Success * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### POST Get connection fields `POST /ssot/connections/{connectionId}/objects/{resourceName}/fields` Tags: Connections. Get a list of fields for a connection object. **Available Version:** 62.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 * `resourceName` (path, string, required) * Use `files` for file-based connectors. The actual file name or wildcard expression of the folder is part of the request body. * Use the object name for object, blob, or app-based connectors. * Use the table name or view name for database connectors. * Use the custom object ID for data extension source objects. * Use the data stream name for Standard Marketing Cloud bundle streams. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionFieldCollectionInputRepresentation`. _Example: Data extension source object request_ ``` { "advancedAttributes": {}, "filters": { "filtersByProperty": [ { "name": "subType", "filterOperator": "EqualsOp", "values": [ "SalesforceMarketingCloudDataExtension" ] }, { "name": "mid", "filterOperator": "EqualsOp", "values": [ "524000862" ] } ] } } ``` _Example: Standard Marketing Cloud bundle stream request_ ``` { "advancedAttributes": {}, "filters": { "filtersByProperty": [ { "name": "subType", "filterOperator": "EqualsOp", "values": [ "SalesforceMarketingCloudStandard" ] }, { "name": "mid", "filterOperator": "EqualsOp", "values": [ "524000862" ] } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionFieldCollectionRepresentation`. _Example: Example_ ``` { "advancedAttributes": {}, "fields": [ { "name": "Id", "originalType": "TEXT", "type": "Text", "isRequired": false, "label": "Id", "creationType": "Standard", "isCalculatedField": false } ], "incrementalExtractAttributes": {}, "primaryKeys": [ "Id" ] } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Get connection objects `POST /ssot/connections/{connectionId}/objects` Tags: Connections. Get a list of source objects for a connection. **Available Version:** 62.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionObjectCollectionInputRepresentation`. _Example: Data extension source object request_ ``` { "filters": { "filtersByProperty": [ { "name": "subType", "filterOperator": "EqualsOp", "values": [ "SalesforceMarketingCloudDataExtension" ] }, { "name": "name", "filterOperator": "LikeOp", "values": [ "API_Test" ] }, { "name": "mid", "filterOperator": "EqualsOp", "values": [ "524000862" ] } ] } } ``` _Example: Marketing Cloud data extension request_ ``` { "advancedAttributes": { "includeDataExtensionSize": "true" }, "filters": { "filtersByProperty": [ { "name": "subType", "operator": "EqualsOp", "values": [ "SalesforceMarketingCloudDataExtension" ] }, { "name": "mid", "operator": "EqualsOp", "values": [ "12345678" ] }, { "name": "name", "operator": "SubstrOp", "values": [ "Shoes" ] } ] } } ``` _Example: Standard Marketing Cloud bundle stream request_ ``` { "filters": { "filtersByProperty": [ { "name": "subType", "filterOperator": "EqualsOp", "values": [ "SalesforceMarketingCloudStandard" ] }, { "filterOperator": "EqualsOp", "values": [ "524000862" ] } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionObjectCollectionRepresentation`. _Example: Connection object response_ ``` { "objects": [ { "name": "Deals", "attributes": { "type": "TABLE", "schema": "HubSpotV3", "catalog": "CData" } }, { "name": "EmailProperties", "attributes": { "type": "TABLE", "schema": "HubSpotV3", "catalog": "CData" } }, { "name": "Files", "attributes": { "type": "VIEW", "schema": "HubSpotV3", "catalog": "CData" } } ] } ``` _Example: Marketing Cloud data extension response_ ``` { "objects": [ { "name": "Shoes US West", "customObjectId": "0ab0b0b6-02ef-e211-afcb-463500000031", "description": "Shoes from the US West branch", "rowCount": 1500, "externalKey": "shoes-us-west-key", "modifiedDate": "2026-07-20T12:34:56.000", "ownerId": "12345", "dataExtensionStorageSize": "768.81 MB" }, { "name": "Shoes US East", "customObjectId": "1ab0b0b6-02ef-e211-afcb-463500000031", "description": "Shoes from the US East branch", "rowCount": 2300, "externalKey": "shoes-us-east-key", "modifiedDate": "2026-07-18T09:10:11.000", "ownerId": "12345", "dataExtensionStorageSize": "1.024 GB" }, { "name": "Shoes Europe", "customObjectId": "2ab0b0b6-02ef-e211-afcb-463500000031", "description": "Shoes from the Europe branch", "rowCount": 800, "externalKey": "shoes-europe-key", "modifiedDate": "2026-07-15T14:20:30.000", "ownerId": "67890", "dataExtensionStorageSize": "512.00 MB" } ] } ``` _Example: Standard Marketing Cloud bundle stream response_ ``` { "objects": [ { "bundleName": "MOBILE_CONNECT", "name": "ContactPointPhone" }, { "bundleName": "MOBILE_CONNECT", "name": "SmsMt" } ] } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Get connection preview `POST /ssot/connections/{connectionId}/objects/{resourceName}/preview` Tags: Connections. Get a preview of the data in an object and pass it through parser settings. **Available Version:** 62.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 * `resourceName` (path, string, required) Resource name for the connection: * Use `files` for file-based connectors. The actual file name or wildcard expression of the folder is part of the request body. * Use the object name for object, blob, or app-based connectors. * Use the table name or view name for database connectors. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionPreviewInputRepresentation`. _Example: Example_ ``` { "advancedAttributes": {}, "fields": [ "Id", "column_boolean" ], "limit": 100 } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionPreviewRepresentation`. _Example: Example_ ``` { "advancedAttributes": {}, "records": [ { "record": { "Id": 1, "column_boolean": true } }, { "record": { "Id": 2, "column_boolean": false } } ] } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### GET Get connection schema `GET /ssot/connections/{connectionId}/schema` Tags: Connections. Get the schema model for a connection. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) The ID for the connection. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionSchemaCollectionRepresentation`. _Example: Example_ ``` { "schemas": [ { "label": "schemaName", "name": "schemaName", "schemaType": "StreamingApp", "fields": [ { "name": "schemaFieldOne", "label": "schemaFieldOne", "dataType": "Number" }, { "name": "schemaFieldTwo", "label": "schemaFieldTwo", "dataType": "Text" } ] } ] } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### PUT Upsert connection schema `PUT /ssot/connections/{connectionId}/schema` Tags: Connections. Create or update a schema model for a connection. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) The ID for the connection. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionSchemaCollectionInputRepresentation`. _Example Example: same as GET /ssot/connections/{connectionId}/schema 200 response._ #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionSchemaCollectionRepresentation`. _Example Example: same as GET /ssot/connections/{connectionId}/schema 200 response._ * **400** The request could not be understood, usually because the ID is not valid for the particular resource. For example, the request passed a userId where a groupId is required. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### GET Get connection site map `GET /ssot/connections/{connectionId}/sitemap` Tags: Connections. Get the sitemap for a Streaming App connection. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) The ID for the connection. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionSitemapRepresentation`. _Example: Example_ ``` { "sitemap": "Contents of the sitemap file", "sitemapPath": "A string with a URL of the sitemap" } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### PUT Upsert connection site map `PUT /ssot/connections/{connectionId}/sitemap` Tags: Connections. Create or update the sitemap for a Streaming App connection. **Available Version:** 60.0 #### Parameters * `connectionId` (path, string, required) The ID for the connection. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `ConnectionSitemapInputRepresentation`. _Example: Example_ ``` { "sitemap": "Contents of the sitemap file" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionSitemapRepresentation`. _Example: Example_ ``` { "sitemap": "Contents of the sitemap file", "sitemapPath": "A string with a URL of the sitemap" } ``` * **400** The request could not be understood, usually because the ID is not valid for the particular resource. For example, the request passed a userId where a groupId is required. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Test connection action `POST /ssot/connections/actions/test` Tags: Connections. Test a connection without creating it. **Available Version:** 62.0 #### Request body Media type: `application/json`. Schema: `ConnectionTestInputRepresentation`. _Example: Example_ ``` { "connectorType": "AwsRdsPostgres", "method": "Ingress", "credentials": { "attributes": [ { "name": "username", "value": "test" }, { "name": "password", "value": "pass123" } ], "parameters": { "attributes": [ { "name": "connection_url", "value": "https://abcd.123.com:443" } ] } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionTestActionRepresentation`. _Example: Example_ ``` { "errors": [ { "errorCode": "", "message": "" } ], "success": true } ``` * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Run connection action `POST /ssot/connections/actions/{command}` Tags: Connections. Run a command on a connection without creating the connection. **Available Version:** 64.0 #### Parameters * `command` (path, string, required) Name of the command to run, for example, `GET_SCHEMAS`. **Available Version:** 64.0 #### Request body Media type: `application/json`. Schema: `ConnectionCommandActionInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionCommandActionRepresentation`. * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Test existing connection action `POST /ssot/connections/{connectionId}/actions/test` Tags: Connections. Test an existing connection and update its status based on the test result. **Available Version:** 62.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionTestActionRepresentation`. * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Run existing connection action `POST /ssot/connections/{connectionId}/actions/{command}` Tags: Connections. Run a command on an existing connection. **Available Version:** 64.0 #### Parameters * `command` (path, string, required) Name of the command to run, for example, `GET_SCHEMAS`. **Available Version:** 64.0 * `connectionId` (path, string, required) ID of the connection. **Available Version:** 64.0 #### Request body Media type: `application/json`. Schema: `ConnectionCommandExistingActionInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionCommandActionRepresentation`. * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### POST Test existing connection schema action `POST /ssot/connections/{connectionId}/schema/actions/test` Tags: Connections. Test a schema for an existing connection. **Available Version:** 62.0 #### Parameters * `connectionId` (path, string, required) ID of the connection. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectionSchemaActionResponseRepresentation`. * **400** The request could not be understood. * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. * **422** The request exceeded the maximum number of connections. ### GET Get connectors `GET /ssot/connectors` Tags: Connections, Connectors. Get a paginated list of Data 360 connectors, including high-level information and attributes for each connector. **Available Version:** 62.0 #### Parameters * `fieldGroup` (query, string) Number of fields to include in the results. Specify one of these values: * `SMALL` returns the fewest number of fields, including `name`, `label`, and a few others. * `MEDIUM` returns a greater number of fields. * `BIG` returns all fields. The default is `SMALL`. **Available Version:** 62.0 * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of values of the form `field=value`. For example, `name=AwsRdsPostgres` returns connectors whose name matches `AwsRdsPostgres`. By default, no filter is applied. **Available Version:** 62.0 * `orderBy` (query, string) Sort order for the results. You can order results by the field name `label` or `name`; by default, results are ordered by name. You can also list results in ascending (`ASC`) or descending (`DESC`) order; by default, results are listed in ascending order. For example, specify `label` or `label ASC` to list results by the `label` field and in ascending order. Omit both a field name and sort order to list results by connector name and in ascending order by default. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectorInfoCollectionRepresentation`. _Example: Example_ ``` { "connectorInfoList": [ { "name": "AwsRdsSqlServer", "label": "AWS RDS SQL Server", "description": "Ingest data from a SQL Server database on AWS RDS", "iconUrl": "/cdp/images/connectors/AwsRdsSqlServer.svg", "features": [ { "featureType": "Ingress" }, { "featureType": "ObjectBased" }, { "featureType": "IncrementalUpdate", "config": { "deleteSupport": "true" } }, { "featureType": "Batch" } ] }, { "name": "hubspot", "label": "HubSpot", "description": "Ingest data from Hubspot", "iconUrl": "/cdp/images/connectors/hubspot.svg", "features": [ { "featureType": "Ingress" }, { "featureType": "ObjectBased" }, { "featureType": "IncrementalUpdate", "config": { "deleteSupport": "true" } }, { "featureType": "Batch" } ] } ] } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### GET Get connector metadata `GET /ssot/connectors/{connectorType}` Tags: Connections, Connectors, Metadata. Get metadata about a Data 360 connector. **Available Version:** 59.0 #### Parameters * `connectorType` (path, string, required) Type of the connector for which to return metadata. For example, possible connector types are `AccountEngagement`, `AwsRdsPostgres`, `Databricks`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `StreamingApp`, and so forth. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ConnectorMetadataRepresentation`. _Example: Example_ ``` { "name": "AwsRdsSqlServer", "label": "AWS RDS SQL Server", "ingressDescription": "Ingest data from a SQL Server database on AWS RDS", "iconUrl": "/cdp/images/connectors/AwsRdsSqlServer.svg", "releaseLevel": "BETA", "features": [ { "featureType": "Ingress" }, { "featureType": "ObjectBased" }, { "featureType": "IncrementalUpdate", "config": { "deleteSupport": "true" } }, { "featureType": "Batch" } ], "connectionAttributes": [ { "name": "username", "label": "Username", "placeholder": "Enter username...", "type": "username", "dataType": "text", "secure": true, "ingress": true, "editable": true, "required": true, "minLength": 1, "maxLength": 100 }, { "name": "password", "label": "Password", "placeholder": "Enter password...", "type": "password", "dataType": "password", "secure": true, "ingress": true, "editable": true, "required": true, "minLength": 1, "maxLength": 128 }, { "name": "jdbc_connection_url", "label": "Connection URL", "type": "jdbcConnectionUrl", "dataType": "text", "ingress": true, "editable": true, "required": true, "pattern": "[a-z0-9-]{1,30}\\.[a-z0-9]{1,20}\\.[a-z0-9-]{1,20}\\.rds\\.amazonaws\\.com(:[0-9]{4,5})?" }, { "name": "SCHEMA", "label": "Schema", "type": "jdbcSchema", "dataType": "text", "ingress": true, "required": true, "maxLength": 100 }, { "name": "DATABASE", "label": "Database", "type": "jdbcDatabase", "dataType": "text", "ingress": true, "editable": true, "required": true, "pattern": "^[a-zA-Z0-9-_]+$", "maxLength": 128 } ], "advancedAttributes": [ { "name": "objectName", "label": "Object Name", "type": "objectBasedObjectName", "dataType": "text", "readonly": true, "required": true }, { "name": "incrementalColumn", "label": "Incremental Column", "type": "objectBasedIncrementalColumn", "dataType": "text", "editable": true, "required": true }, { "name": "deleteColumn", "label": "Delete Column", "type": "objectBasedDeleteColumn", "dataType": "text", "editable": true }, { "name": "FILTER", "label": "Filter", "type": "jdbcFilter", "dataType": "text", "editable": true } ], "customErrorLabels": { "INVALID_CREDENTIALS": "User credentials are invalid", "INVALID_CONNECTION": "Could not connect to the URL provided", "AWS_RDS_SQL_INTERNAL": "A general error occurred while trying to connect with SQL Server database on AWS RDS" } } ``` * **401** The session ID or OAuth token is expired or invalid, or, if a guest user made the request, the resource isn’t accessible to guest users. * **404** The server can't find the requested resource. ### GET Get data action targets `GET /ssot/data-action-targets` Tags: Data Action Targets. Get a paginated list of data action targets. **Available Version:** 58.0 #### Parameters * `batchSize` (query, integer) Number of items returned. **Available Version:** 58.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 58.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 58.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataActionTargetCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": null, "dataActionTargets": [ { "apiName": "Another_Data_Action_Target", "config": { "targetEndpoint": "https://webhook.site/77c949c-27" }, "label": "Another Data Action Target", "status": "ACTIVE", "type": "WEBHOOK" }, { "apiName": "MyDataActionTarget", "config": { "label": "MyCompany Org", "orgId": "00DX2000001ZUi5" }, "label": "MyDataActionTarget", "status": "ACTIVE", "type": "CORE" } ], "nextPageUrl": null } ``` ### POST Create data action target `POST /ssot/data-action-targets` Tags: Data Action Targets. Create a new data action target. **Available Version:** 58.0 #### Request body (required) Media type: `application/json`. Schema: `CdpDataActionTargetInputRepresentation`. _Example: Web hook data action target request_ ``` { "type": "WebHook", "label": "webhook_from_api", "apiName": "webhook_from_api", "config": { "targetEndpoint": "https://webhook.site/4a6d3817-2aab-4926-a92a-26814205b046" } } ``` _Example: Core data action target request_ ``` { "type": "Core", "label": "My core data action target", "apiName": "my_core_data_action_target", "config": { "orgLabel": "MyCompany Org", "orgId": "00DX2000001ZUi5" } } ``` _Example: Marketing Cloud data action target request_ ``` { "apiName": "Marketing_Target", "label": "MarketingTarget", "type": "MarketingCloud", "config": { "dataActionDestinationType": "API_EVENT", "contentKey": "APIEvent-2d3822c2-d973-7ff2-93b5-119d04948f47", "contentTemplate": "API Event Name", "targetEndpoint": "https://mc9pr6qjkhjx11c-ktdfw-7x6k84.rest-qa3.marketingcloudqaapis.com/interaction/v1/events" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataActionTargetOutputRepresentation`. _Example: Web hook data action target response_ ``` { "apiName": "webhook_from_api", "config": { "targetEndpoint": "https://webhook.site/4a6d3816-2aab-4126-a92a-26814205b046" }, "label": "webhook_from_api", "status": "PROCESSING", "type": "WEBHOOK" } ``` _Example: Core data action target response_ ``` { "apiName": "my_core_data_action_target", "config": { "label": "MyCompany Org", "orgId": "00DX2000001ZUi5" }, "label": "My core data action target", "status": "PROCESSING", "type": "CORE" } ``` ### GET Get data action target `GET /ssot/data-action-targets/{apiName}` Tags: Data Action Targets. Get a data action target. **Available Version:** 58.0 #### Parameters * `apiName` (path, string, required) Developer name of the data action target. **Available Version:** 58.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataActionTargetOutputRepresentation`. _Example Web hook data action target response: same as POST /ssot/data-action-targets 200 response._ _Example Core data action target response: same as POST /ssot/data-action-targets 200 response._ ### DELETE Delete data action target `DELETE /ssot/data-action-targets/{apiName}` Tags: Data Action Targets. Delete a data action target. **Available Version:** 58.0 #### Parameters * `apiName` (path, string, required) Developer name of the data action target. **Available Version:** 58.0 #### Responses * **200** Success ### POST Generate data action target signing key `POST /ssot/data-action-targets/{apiName}/signing-key` Tags: Data Action Targets. Generate the signing key for a data action target. **Available Version:** 62.0 #### Parameters * `apiName` (path, string, required) Developer name of the data action target. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataActionTargetSigningKeyOutputRepresentation`. _Example: Example_ ``` { "signingAlgorithm": "HMACSHA256", "signingKey": "b+uouYjFtl6+1kLH3EVl+Pitm64fl5gO6TREnWltEBzfqjTk5vARLumZ7BR6hWirNawxhz5s+Mv3SzyETNBxPg==" } ``` ### GET Get data actions `GET /ssot/data-actions` Tags: Data Actions. Get a paginated list of data actions in the org. **Available Version:** 58.0 #### Parameters * `batchSize` (query, integer) Number of items returned. **Available Version:** 62.0 * `dataspace` (query, string) The Data 360 data space from which to return data actions. **Available Version:** 62.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 62.0 * `orderby` (query, string) Name of the field to order the results by. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataActionCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": null, "dataActions": [ { "actionConditionExpression": "(1)", "actionConditions": [ { "fieldName": "TenantId__c", "objectName": "IndividualGDPRState__dlm", "operator": "Equal", "order": "1", "value": "1234ABC" } ], "dataActionEnrichmentProperties": [], "dataActionName": "IndividualGDRP_action", "dataActionProjectedFields": [], "dataActionSources": [ { "objectDevName": "IndividualGDPRState__dlm", "objectId": "0gjX2000000DD5tIAG", "objectType": "DataModelEntity", "subscriptionModes": [ "CREATE", "UPDATE" ] } ], "dataActionStatus": "ERROR", "dataActionTargets": [ "my_core_data_action_target" ], "dataSpaceDevName": "default", "developerName": "IndividualGDRP_action", "isRealTimeAction": false, "lastActionStatusDateTime": "2025-02-13T21:37:00.000Z", "lastActionStatusErrorCode": "CREATE_FAILED", "masterLabel": "IndividualGDRP_action", "shouldTriggerEventOnlyFirstTime": false }, { "actionConditionExpression": "(1 AND 2)", "actionConditions": [ { "fieldName": "RateDenominatorNumber__c", "objectName": "StaticCurrencyRates_Home__dlm", "operator": "GreaterThan", "order": "1", "value": "0.3" }, { "fieldName": "RateNumeratorNumber__c", "objectName": "StaticCurrencyRates_Home__dlm", "operator": "LessThanOrEqualTo", "order": "2", "value": "100" } ], "dataActionEnrichmentProperties": [], "dataActionName": "Test Data Action 2", "dataActionProjectedFields": [], "dataActionSources": [ { "objectDevName": "StaticCurrencyRates_Home__dlm", "objectId": "0gjX2000000DDp3IAG", "objectType": "DataModelEntity", "subscriptionModes": [ "DELETE" ] } ], "dataActionStatus": "ACTIVE", "dataActionTargets": [ "webhook_from_api" ], "dataSpaceDevName": "default", "developerName": "Test_Data_Action_2", "isRealTimeAction": false, "lastActionStatusDateTime": "2025-02-13T21:40:20.000Z", "masterLabel": "Test Data Action 2", "shouldTriggerEventOnlyFirstTime": false } ], "nextPageUrl": null } ``` ### POST Create data action `POST /ssot/data-actions` Tags: Data Actions. Create a new data action. **Available Version:** 58.0 #### Parameters * `dataspace` (query, string) The Data 360 data space fromm which to return the data action. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `CdpDataActionInputRepresentation`. _Example: Example_ ``` { "dataActionTargetNames": [ "webhook_from_api" ], "dataspace": "default", "dataActionName": "new_action_from_api", "developerName": "new_action_from_api", "description": "created from API without delay", "masterLabel": "new_action5", "dataActionSources": [ { "sourceName": "ssot__Account__dlm", "sourceType": "DataModelEntity", "sourceCdcSubscriptions": [ "CREATE", "UPDATE", "DELETE" ] } ], "actionConditionExpression": "", "actionConditions": [], "dataActionEnrichmentProperties": [], "dataActionProjectedFields": [] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `CdpDataActionOutputRepresentation`. _Example: Example_ ``` { "dataActionStatus": "PROCESSING", "dataActionTargets": [ "webhook_from_api" ], "dataSpaceDevName": "default", "description": "created from API without delay", "developerName": "new_action_from_api", "actionConditions": [], "dataActionEnrichmentProperties": [], "dataActionName": "new_action_from_api", "dataActionProjectedFields": [], "dataActionSources": [ { "objectDevName": "ssot__Account__dlm", "objectId": "0gjSB000002kRykYAE", "objectType": "DataModelEntity", "subscriptionModes": [ "CREATE", "UPDATE", "DELETE" ] } ], "lastActionStatusDateTime": "2024-08-29T04:07:45.000Z", "masterLabel": "new_action5", "shouldTriggerEventOnlyFirstTime": false } ``` ### GET Get custom code deployments `GET /ssot/data-custom-code` Tags: Data Custom Code. Returns a paginated list of custom code deployments. **Available Version:** 63.0 #### Parameters * `codeType` (query, string) Filters results by code type. **Available Version:** 63.0 Allowed values: `Function`, `Script`. * `deploymentStatus` (query, string) Filters results by deployment status. **Available Version:** 63.0 Allowed values: `Deployed`, `Disabled`, `Error`, `Initializing`, `Pending`, `Scanning`. * `label` (query, string) Filters results by label. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of custom code deployments to return. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 63.0 Allowed values: `CodeTypeAsc`, `CodeTypeDesc`, `DeployedByAsc`, `DeployedByDesc`, `DeployedOnAsc`, `DeployedOnDesc`, `DeploymentStatusAsc`, `DeploymentStatusDesc`, `NameAsc`, `NameDesc`, `VersionDesc`. #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeDeploymentCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v67.0/ssot/data-custom-code?limit=20&offset=0&orderBy=Name%20DESC", "nextPageUrl": null, "totalSize": 2, "customCodeDeployments": [ { "codeType": "Script", "computeType": "CPU_L", "createdBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "createdDate": "2026-09-22T09:25:39.000Z", "deploymentFailureCode": -1, "deploymentStatus": "Deployed", "description": "Cleans, deduplicates, filters, and reshapes raw source records, then writes them out as structured rows.", "fileUploadUrl": "https:////", "id": "1LXKd0000008OKaOAM", "invokeOptions": [ "BatchTransform" ], "isRemote": false, "label": "Custom Record Transformer", "lastModifiedBy": { "id": "005Kd000006Ag4hIAC", "name": "Automated Process", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-09-22T09:31:02.000Z", "name": "Custom_Record_Transformer", "parameters": { "extractedParams": { "dataSpace": "default", "dataObjects": [], "parameterType": "ScriptExtractedParameters", "read": [ { "name": "Raw_Records__dll", "type": "DLO" } ], "write": [ { "name": "Structured_Records__dll", "type": "DLO" } ] } }, "status": "Active", "url": "/services/data/v67.0/ssot/data-custom-code/Custom_Record_Transformer", "version": "1.0.0" }, { "codeType": "Function", "computeType": "CPU_M", "createdBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "createdDate": "2026-06-08T09:05:46.000Z", "deploymentFailureCode": -1, "deploymentStatus": "Deployed", "description": "1. Python splits the document into named sections (heading-aware).\n 2. LLM Gateway summarizes each section (semantic, fact-preserving).\n 3. Each summary becomes one chunk, prefixed with its section title.", "fileUploadUrl": "https:////", "id": "1LXKd0000008OIeOAM", "invokeOptions": [ "SearchIndexChunking" ], "isRemote": false, "label": "Summarise_sections_chunking", "lastModifiedBy": { "id": "005Kd000006Ag4hIAC", "name": "Automated Process", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-08T09:10:26.000Z", "name": "Summarise_sections_chunking", "parameters": { "extractedParams": { "parameterType": "FunctionExtractedParameters", "moduleName": "entrypoint.py" } }, "status": "Active", "url": "/services/data/v67.0/ssot/data-custom-code/Summarise_sections_chunking", "version": "1.0" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### POST Create custom code deployment `POST /ssot/data-custom-code` Tags: Data Custom Code. Creates a custom code deployment. The deployment record isn't complete until you upload the code package, so completing a deployment is a three-step process: 1. Send this request with the deployment metadata. The response includes a short-lived, pre-signed `fileUploadUrl`. 2. Upload the code package ZIP (up to 5 GB) as a PUT request to `fileUploadUrl` with `Content-Type: application/zip` or `application/x-zip-compressed`. The upload goes directly to storage, outside the Connect API, so use the URL promptly. 3. Poll `GET /ssot/data-custom-code/{customCodeNameOrId}` until `deploymentStatus` is `Deployed`. If `deploymentStatus` is `Failed`, check `deploymentFailureCode` and `deploymentFailureReason` for the cause. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `CustomCodeDeploymentInputRepresentation`. _Example: example1_ ``` { "name": "Custom_Record_Transformer", "label": "Custom Record Transformer", "description": "Cleans, deduplicates, filters, and reshapes raw source records, then writes them out as structured rows.", "version": "1.0.0", "codeType": "Script", "computeType": "CPU_L", "invokeOptions": [ "BatchTransform" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeDeploymentRepresentation`. _Example: example1_ ``` { "codeType": "Script", "computeType": "CPU_L", "createdBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "createdDate": "2026-09-22T09:25:39.000Z", "deploymentStatus": "Initializing", "description": "Cleans, deduplicates, filters, and reshapes raw source records, then writes them out as structured rows.", "fileUploadUrl": "https:////", "id": "1LXKd0000008OKaOAM", "invokeOptions": [ "BatchTransform" ], "isRemote": false, "label": "Custom Record Transformer1", "lastModifiedBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-09-22T09:25:40.000Z", "name": "Custom_Record_Transformer1", "parameters": {}, "status": "Active", "url": "/services/data/v67.0/ssot/data-custom-code/Custom_Record_Transformer1", "version": "1.0.0" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get custom code deployment `GET /ssot/data-custom-code/{customCodeNameOrId}` Tags: Data Custom Code. Returns a custom code deployment. Poll the endpoint to check deployment readiness. The deployment is ready when `deploymentStatus` is `Deployed` and `status` is `Active`, and failed when `deploymentStatus` or `status` is `Error`. Any other combination means the deployment is still in progress. **Available Version:** 63.0 #### Parameters * `customCodeNameOrId` (path, string, required) API name or 18-character record ID of the custom code deployment. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeDeploymentRepresentation`. _Example: example1_ ``` { "computeType": "CPU_M", "createdBy": { "id": "005xx000001X7qfAAC", "name": "Admin User", "profilePhotoUrl": "https://dxx0000006gqxeae.file.force-com.deepti-rajagopal-acr6w0ev94ko1.wb.crm.dev:6101/profilephoto/005/T" }, "createdDate": "2025-01-10T18:51:20.000Z", "status": "Active", "deploymentStatus": "Deployed", "description": "Complex logic specific to our business. We are transforming Account records in a way that is not supported with built-in features.", "id": "1LXxx0000004DoGGAU", "label": "Custom Transformation", "lastModifiedBy": { "id": "005xx000001X7qfAAC", "name": "Admin User", "profilePhotoUrl": "https://dxx0000006gqxeae.file.force-com.deepti-rajagopal-acr6w0ev94ko1.wb.crm.dev:6101/profilephoto/005/T" }, "lastModifiedDate": "2025-01-10T18:51:20.000Z", "name": "markdlv113", "parameters": { "customParam1": "customValue1" }, "version": "1.0.2", "url": "/services/data/v62.0/ssot/data-custom-code/deployments", "codeType": "Function", "extractedConfig": { "inputs": "[{\"name\":\"flag\",\"type\":\"Boolean\",},{\"name\":\"name\",\"type\":\"String\",},],", "outputs": "[{\"name\":\"flag\",\"type\":\"Boolean\",},{\"name\":\"name\",\"type\":\"String\",},]" } } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### DELETE Delete custom code deployment `DELETE /ssot/data-custom-code/{customCodeNameOrId}` Tags: Data Custom Code. Deletes a custom code deployment. **Available Version:** 63.0 #### Parameters * `customCodeNameOrId` (path, string, required) API name or 18-character record ID of the custom code deployment. **Available Version:** 63.0 #### Responses * **200** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### PATCH Update custom code deployment `PATCH /ssot/data-custom-code/{customCodeNameOrId}` Tags: Data Custom Code. Updates a custom code deployment. **Available Version:** 63.0 #### Parameters * `customCodeNameOrId` (path, string, required) API name or 18-character record ID of the custom code deployment. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `CustomCodePatchInputRepresentation`. _Example: example1_ ``` { "description": "Cleans, deduplicates, filters, and reshapes raw source records, then writes them out as structured rows. Now also trims leading and trailing whitespace from text fields before writing." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeDeploymentRepresentation`. _Example: example1_ ``` { "codeType": "Script", "computeType": "CPU_L", "createdBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "createdDate": "2026-09-22T09:25:39.000Z", "deploymentFailureCode": -1, "deploymentStatus": "Deployed", "description": "Cleans, deduplicates, filters, and reshapes raw source records, then writes them out as structured rows. Now also trims leading and trailing whitespace from text fields before writing.", "fileUploadUrl": "https:////", "id": "1LXKd0000008OKaOAM", "invokeOptions": [ "BatchTransform" ], "isRemote": false, "label": "Custom Record Transformer1", "lastModifiedBy": { "id": "005Kd000005nMECIA2", "name": "Test User", "profilePhotoUrl": "https://demo.file.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-09-22T09:46:31.000Z", "name": "Custom_Record_Transformer1", "parameters": {}, "status": "Active", "url": "/services/data/v67.0/ssot/data-custom-code/Custom_Record_Transformer1", "version": "1.0.0" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get custom code executions `GET /ssot/data-custom-code/{customCodeNameOrId}/executions` Tags: Data Custom Code. Returns a paginated list of executions for a custom code deployment. **Available Version:** 63.0 #### Parameters * `limit` (query, integer) Maximum number of executions to return. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `customCodeNameOrId` (path, string, required) Record ID or API name of the custom code deployment. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeExecutionCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v67.0/ssot/data-custom-code/Custom_Record_Transformer/executions?limit=20&offset=0", "executions": [ { "computeType": "CPU_M", "durationInSeconds": 372, "endTime": "2026-09-08T09:41:18.000Z", "id": "b7c04e21-5f8a-4d3c-9a1e-2c6b90f4d5e7", "invokeOption": "BatchTransform", "rowsRead": 30, "rowsWritten": 30, "startTime": "2026-09-08T09:35:06.000Z", "status": "SUCCESS", "submittedTime": "2026-09-08T09:35:06.284Z" }, { "computeType": "CPU_M", "durationInSeconds": 456, "endTime": "2026-09-07T11:13:41.000Z", "id": "dd3fb595-90af-4a36-b3e5-7e09d9904c70", "invokeOption": "BatchTransform", "rowsRead": 30, "rowsWritten": 0, "startTime": "2026-09-07T11:03:06.000Z", "status": "FAILURE", "submittedTime": "2026-09-07T11:03:06.961Z" } ], "totalSize": 2 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get custom code execution `GET /ssot/data-custom-code/{customCodeNameOrId}/executions/{customCodeExecutionId}` Tags: Data Custom Code. Returns a single execution for a custom code deployment. **Available Version:** 64.0 #### Parameters * `customCodeExecutionId` (path, string, required) ID of the custom code execution. **Available Version:** 64.0 * `customCodeNameOrId` (path, string, required) API name or 18-character record ID of the custom code deployment. **Available Version:** 64.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CustomCodeExecutionBaseRepresentation`. _Example: example1_ ``` { "computeType": "CPU_M", "durationInSeconds": 372, "endTime": "2026-09-08T09:41:18.000Z", "id": "b7c04e21-5f8a-4d3c-9a1e-2c6b90f4d5e7", "invokeOption": "BatchTransform", "rowsRead": 30, "rowsWritten": 30, "startTime": "2026-09-08T09:35:06.000Z", "status": "SUCCESS", "submittedTime": "2026-09-08T09:35:06.284Z" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not found. ### GET Get collaborations `GET /ssot/data-clean-room/collaborations` Tags: Clean Rooms. Get a list of clean room collaborations. **Available Version:** 63.0 #### Parameters * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room collaborations to return from `1` through `20`. By default, `20` collaborations are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomCollaborationCollectionRepresentation`. _Example: Example_ ``` { "collaborations": [ { "createdBy": { "name": "Platform Integration User" }, "createdDate": "2025-12-02T06:08:08.000Z", "id": "1TLSB0000000muH4AQ", "label": "collab21", "lastModifiedBy": { "name": "Platform Integration User" }, "lastModifiedDate": "2025-12-02T06:08:08.000Z", "members": [ { "invitationId": "1TOSB000000COGH4A4", "invitationStatus": "RECEIVED", "memberId": "1TPSB0000000WuL4AU", "memberOrgId": "00DSB00000eLeZh2AK", "memberStatus": "INACTIVE", "memberType": "PROVIDER", "providerId": "1TQSB00000rVBtV4AW" }, { "invitationId": "1TOSB000000COGI4A4", "invitationStatus": "SENT", "memberId": "1TPSB0000000WuM4AU", "memberOrgId": "00DSB00000eMue32AC", "memberStatus": "ACTIVE", "memberType": "CONSUMER", "providerId": "1TQSB00000rVBtV4AW" } ], "name": "collab21_00DSB00000eMue3", "status": "INACTIVE", "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentId", "description": "Segment ID", "id": "SegmentId", "label": "SegmentId", "queryOptions": {}, "required": true }, { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "CONSUMER" }, { "attributeConfigs": [ { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "Category", "description": "Category of the segment.", "id": "Category", "label": "Category", "queryOptions": {}, "required": true }, { "alias": "ParentCategory", "description": "Parent Category of the segment.", "id": "ParentCategory", "label": "ParentCategory", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "MemberId", "description": "Member ID, only aggregation or joins is allowed.", "id": "MemberId", "label": "MemberId", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "PROVIDER" } ] }, "description": "Query to calculate the overlap between consumers and providers.", "id": "1TTSB000002Uq9h4AC", "name": "QueryOverlap", "queryTemplate": { "template": "SELECT Consumer.SegmentId AS Segment_Id__c, Consumer.SegmentName AS Segment_Name__c, Provider.SegmentName AS Provider_Segment_Name__c, Provider.Category AS Provider_Segment_Category__c, Provider.ParentCategory AS Provider_Segment_Parent_Category__c, Provider.SegmentSize AS Provider_Segment_Size__c, Consumer.SegmentSize AS Segment_Size__c, COUNT(DISTINCT Provider.MemberId) AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.HashedEmailAddress = Provider.HashedEmailAddress GROUP BY Consumer.SegmentId, Consumer.SegmentName, Provider.SegmentName, Provider.Category, Provider.ParentCategory, Provider.SegmentSize, Consumer.SegmentSize HAVING COUNT(DISTINCT Provider.MemberId) >= :threshold_count", "useCaseType": "Overlap", "queryParameters": "[{"name":"threshold_count","description":"threshold_count","type":"INTEGER"}]", "name": "QueryOverlap", "description": "Query to calculate the overlap between consumers and providers.", "queryTemplateType": "SQL" } } }, { "createdBy": { "name": "Platform Integration User" }, "createdDate": "2025-11-20T05:19:09.000Z", "dataSpaceName": "default", "description": "Collab Khyati", "id": "1TLSB0000000mfl4AA", "label": "KhyatiCollab", "lastModifiedBy": { "name": "Platform Integration User" }, "lastModifiedDate": "2025-11-20T05:24:56.000Z", "members": [ { "invitationId": "1TOSB000000C49V4AS", "invitationStatus": "ACCEPTED", "memberId": "1TPSB0000000VYT4A2", "memberOrgId": "00DSB00000eLeZh2AK", "memberStatus": "ACTIVE", "memberType": "PROVIDER", "providerId": "1TQSB00000sOLvR4AW", "specificationId": "1TISB00000072pt4AA" }, { "invitationId": "1TOSB000000C49W4AS", "invitationStatus": "ACCEPTED", "memberId": "1TPSB0000000VYU4A2", "memberOrgId": "00DSB00000eMue32AC", "memberStatus": "ACTIVE", "memberType": "CONSUMER", "providerId": "1TQSB00000sOLvR4AW" } ], "name": "KhyatiCollab_00DSB00000eMue3", "status": "ACTIVE", "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentSize", "description": "Captures the Segment Size", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "Category", "description": "Captures the Category", "id": "Category", "label": "Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "ParentCategory", "description": "Captures the Parent Category", "id": "ParentCategory", "label": "Parent Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [ "COUNT" ], "threshold": 100000 }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "PROVIDER" }, { "attributeConfigs": [ { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentSize", "description": "Captures the Segment size to compute overlap", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": false, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "CONSUMER" } ] }, "description": "Overlap Report", "id": "1TTSB000002W6yn4AC", "name": "Overlap", "queryTemplate": { "template": "SELECT Consumer."SegmentId" AS Segment_Id__c, Consumer."SegmentName" AS Segment_Name__c, Provider."SegmentName" AS Provider_Segment_Name__c, Provider."Category" AS Provider_Segment_Category__c, Provider."ParentCategory" AS Provider_Segment_Parent_Category__c, Provider."SegmentSize" AS Provider_Segment_Size__c, Consumer."SegmentSize" AS Segment_Size__c, COUNT(DISTINCT Provider."MemberId") AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer."HashedEmailAddress" = Provider."HashedEmailAddress" GROUP BY Consumer."SegmentId", Consumer."SegmentName", Provider."SegmentName", Provider."Category", Provider."ParentCategory", Provider."SegmentSize", Consumer."SegmentSize" HAVING COUNT(DISTINCT Provider."MemberId") >= 100", "frequencyCapping": [ { "frequency": "DAILY", "count": 9999 }, { "frequency": "MONTHLY", "count": 999999 } ], "name": "report" } } } ], "limit": 2, "offset": 0 } ``` * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Create a collaboration `POST /ssot/data-clean-room/collaborations` Tags: Clean Rooms. Create a new clean room collaboration. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomCollaborationInputRepresentation`. _Example: Example_ ``` { "label": "collab21", "providerDevName": "X00Dxx00nZbkbQyW_TestProviderName1746172733791", "templateVersionId": "00Dxx00nZbkbBjk8ef", "templateName": "OVERLAP", "specificationDevName": "X00Dxx00MhXCjA7M_null1746504015424", "dataCloudOrgId": "00Dxx00nZbkbQgmEIE" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomCollaborationRepresentation`. _Example: Example_ ``` { "createdBy": { "name": "Platform Integration User" }, "createdDate": "2025-12-02T06:08:08.000Z", "id": "1TLSB0000000muH4AQ", "label": "collab21", "lastModifiedBy": { "name": "Platform Integration User" }, "lastModifiedDate": "2025-12-02T06:08:08.000Z", "members": [ { "invitationId": "1TOSB000000COGH4A4", "invitationStatus": "RECEIVED", "memberId": "1TPSB0000000WuL4AU", "memberOrgId": "00DSB00000eLeZh2AK", "memberStatus": "INACTIVE", "memberType": "PROVIDER", "providerId": "1TQSB00000rVBtV4AW" }, { "invitationId": "1TOSB000000COGI4A4", "invitationStatus": "SENT", "memberId": "1TPSB0000000WuM4AU", "memberOrgId": "00DSB00000eMue32AC", "memberStatus": "ACTIVE", "memberType": "CONSUMER", "providerId": "1TQSB00000rVBtV4AW" } ], "name": "collab21_00DSB00000eMue3", "status": "INACTIVE", "dataSpace": { "id": "0DWSB0000000123456", "name": "default", "label": "Default Data Space", "filter": { "conjunctiveOperator": "AndOperator", "conditions": [ { "fieldName": "Status", "filterValue": "Active", "operator": "EqualsOperator", "tableName": "Individual__dlm" } ] } }, "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentId", "description": "Segment ID", "id": "SegmentId", "label": "SegmentId", "queryOptions": {}, "required": true }, { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "CONSUMER" }, { "attributeConfigs": [ { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "Category", "description": "Category of the segment.", "id": "Category", "label": "Category", "queryOptions": {}, "required": true }, { "alias": "ParentCategory", "description": "Parent Category of the segment.", "id": "ParentCategory", "label": "ParentCategory", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "MemberId", "description": "Member ID, only aggregation or joins is allowed.", "id": "MemberId", "label": "MemberId", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "PROVIDER" } ] }, "description": "Query to calculate the overlap between consumers and providers.", "id": "1TTSB000002Uq9h4AC", "name": "QueryOverlap", "queryTemplate": { "template": "SELECT Consumer.SegmentId AS Segment_Id__c, Consumer.SegmentName AS Segment_Name__c, Provider.SegmentName AS Provider_Segment_Name__c, Provider.Category AS Provider_Segment_Category__c, Provider.ParentCategory AS Provider_Segment_Parent_Category__c, Provider.SegmentSize AS Provider_Segment_Size__c, Consumer.SegmentSize AS Segment_Size__c, COUNT(DISTINCT Provider.MemberId) AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.HashedEmailAddress = Provider.HashedEmailAddress GROUP BY Consumer.SegmentId, Consumer.SegmentName, Provider.SegmentName, Provider.Category, Provider.ParentCategory, Provider.SegmentSize, Consumer.SegmentSize HAVING COUNT(DISTINCT Provider.MemberId) >= :threshold_count", "useCaseType": "Overlap", "queryParameters": "[{"name":"threshold_count","description":"threshold_count","type":"INTEGER"}]", "name": "QueryOverlap", "description": "Query to calculate the overlap between consumers and providers.", "queryTemplateType": "SQL" } } } ``` * **400** JSON parser error or invalid API input. For example: * Unrecognized field "_fieldName_" at \[line: _lineNumber_, column: _columnNumber_\] * Data clean room collaboration label cannot be empty. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** Internal error. For example: * Multiple records found for the given providerDevName, _providerDevName_. ### POST Accept a collaboration invitation `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/accept-invitation` Tags: Clean Rooms. Accept an invitation for a clean room collaboration. **Available Version:** 63.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomAcceptInvitationInputRepresentation`. _Example: Simple request_ ``` { "invitationId": "1TOxx0000004D3UGAU", "specificationId": "1TIxx0000004CIiGAM" } ``` _Example: Snowflake connector request_ ``` { "invitationId": "1TOxx0000004CQoGAM", "specificationId": "1TIxx0000004CH6GAM", "outputConfiguration": { "outputDestinationType": "EXTERNAL_CONNECTOR", "externalId": "ext12345678", "connectionAttributes": { "connectorType": "CleanroomSnowflake", "accountUrl": "https://your-account.snowflakecomputing.com/", "warehouseName": "COMPUTE_WH", "databaseName": "TEST_DB", "schemaName": "TEST_SCHEMA", "serviceUser": "CLEAN_ROOM_USER" } } } ``` _Example: AWS S3 connector request_ ``` { "invitationId": "1TOxx0000004CQoGAM", "specificationId": "1TIxx0000004CH6GAM", "outputConfiguration": { "outputDestinationType": "EXTERNAL_CONNECTOR", "externalId": "ext12345678", "connectionAttributes": { "connectorType": "CleanroomAwsS3", "roleArn": "string", "s3Url": "string" } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomMemberRepresentation`. _Example: Example_ ``` { "invitationId": "1TOxx0000004D3UGAU", "invitationStatus": "ACCEPT_INITIATED", "memberId": "1TPSB0000000WuL4AU", "memberOrgId": "00DSB00000eLeZh2AK", "memberStatus": "ACTIVE", "memberType": "PROVIDER", "providerId": "1TQSB00000rVBtV4AW" } ``` * **400** Invalid API input. For example: * Failed to find Clean Room definition with idOrDevName, _collaborationIdOrApiNameValue_. * Data clean room invitation ID cannot be empty. * Data clean room member invitation is not in a valid state to accept. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Disable a collaboration `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/disable` Tags: Clean Rooms. Disable a clean room collaboration. **Available Version:** 66.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomCollaborationRepresentation`. _Example: example1_ ``` { "name": "Example Data Clean Room", "id": "DCR-001", "description": "This is an example clean room for secure collaboration.", "dataSpace": "ExampleDataSpace", "status": "DISABLED" } ``` * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### PUT Refresh collaboration metadata `PUT /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/refresh-metadata` Tags: Clean Rooms. Refresh metadata for a clean room collaboration. **Available Version:** 66.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomGenericResponseRepresentation`. _Example: example1_ ``` { "errors": [ { "errorCode": "", "message": "" } ], "success": true } ``` * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Reject a collaboration invitation `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/reject-invitation` Tags: Clean Rooms. Reject an invitation for a clean room collaboration. **Available Version:** 63.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomRejectInvitationInputRepresentation`. _Example: Example_ ``` { "invitationId": "1TOxx0000004D3UGAU" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomMemberRepresentation`. _Example: Example_ ``` { "invitationId": "1TOxx0000004D3UGAU", "invitationStatus": "REJECT_INITIATED", "memberId": "1TPSB0000000WuL4AU", "memberOrgId": "00DSB00000eLeZh2AK", "memberStatus": "INACTIVE", "memberType": "PROVIDER", "providerId": "1TQSB00000rVBtV4AW" } ``` * **400** Invalid API input. For example: * Failed to find Clean Room definition with idOrDevName, _collaborationIdOrApiNameValue_. * Data clean room invitation ID cannot be empty. * Data clean room member invitation is not in a valid state to accept. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Run a query `POST /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/run` Tags: Clean Rooms. Run a query job on a clean room. You can start a query run only if the collaboration status is `ACTIVE`. **Available Version:** 63.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomQueryJobInputRepresentation`. _Example: AWS flow request_ ``` { "queryExecutionName": "rawtalks1", "queryParameters": { "threshold_count": "4" } } ``` _Example: Native flow request_ ``` { "queryExecutionName": "queryJob2", "segmentIds": [ "1sgRO00000000FB", "1sgRO00000000EI" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomQueryJobRepresentation`. _Example: AWS flow response_ ``` { "id": "a1fef7e9-cfdd-48b4-9d2a-c6e21d77fc58", "label": "rawtalks1", "segmentNames": [], "status": "CREATED" } ``` _Example: Native flow response_ ``` { "id": "85dc54ca-f277-4851-b7fa-bdd1696cb0a9", "label": "queryJob2", "segmentNames": [], "status": "CREATED" } ``` * **400** Invalid API input. For example: * Failed to find clean room with idOrDevName, _collaborationIdOrApiNameValue_. * Data clean room member invitation is not in a valid state to execute query. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get query jobs `GET /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/jobs` Tags: Clean Rooms. Get a list of clean room query jobs. **Available Version:** 63.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 63.0 * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room query jobs to return from `1` through `20`. By default, `20` query jobs are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomQueryJobCollectionRepresentation`. _Example: Example_ ``` { "limit": 2, "offset": 0, "queryJobs": [ { "completedDate": "2025-12-08T23:58:24.779Z", "errorCode": "DCR_INVALID_STATE_ERROR", "errorMessage": "CONSUMER member 1TPSB0000000VYU has no specification ID", "id": "a1fef7e9-cfdd-48b4-9d2a-c6e21d77fc58", "label": "rawtalks1", "segmentNames": [], "status": "FAILED", "triggeredDate": "2025-12-08T23:58:21.510Z" }, { "completedDate": "2025-12-08T23:57:37.286Z", "errorCode": "DCR_INVALID_STATE_ERROR", "errorMessage": "CONSUMER member 1TPSB0000000VYU has no specification ID", "id": "85dc54ca-f277-4851-b7fa-bdd1696cb0a9", "label": "queryJob2", "segmentNames": [], "status": "FAILED", "triggeredDate": "2025-12-08T23:57:33.896Z" } ] } ``` * **400** Invalid API input or illegal query parameter value. For example: * Failed to find clean room with idOrDevName, _collaborationIdOrApiNameValue_. * Illegal value for query parameter `offset`: _queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** Internal error. For example: * Cannot invoke `cdp.api.datacleanroom.DataCleanRoom.getDataCleanRoomDefinition()` because `dataCleanRoom` is null. ### GET Get collaboration result objects `GET /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/result-data-objects` Tags: Clean Rooms. Retrieve a list of all data model objects (DMOs) created by a specific clean room collaboration. **Available Version:** 66.0 #### Parameters * `collaborationIdOrApiName` (path, string, required) ID or developer name of the clean room collaboration. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomCollaborationResultDataObjectCollectionRepresentation`. _Example: example1_ ``` { "collaborationResultDataObjects": [ { "id": "0gjQZ0000046j3NYAQ", "label": "INDV_BOOSTED1", "name": "INDV_BOOSTED1__dlm", "status": "active" }, { "id": "0gjQZ0000046j4zYAA", "label": "CONTACTEMAIL_BOOSTED1", "name": "CONTACTEMAIL_BOOSTED1__dlm", "status": "active" }, { "id": "0gjQZ0000046j6bYAA", "label": "SAMPLE_BRIDGE_TABLE1", "name": "SAMPLE_BRIDGE_TABLE1__dlm", "status": "active" } ] } ``` * **400** Invalid API input. For example: * Failed to find clean room with idOrDevName, _collaborationIdOrApiNameValue_. * Data clean room member invitation is not in a valid state to execute query. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get providers `GET /ssot/data-clean-room/providers` Tags: Clean Rooms. Get a list of clean room providers. **Available Version:** 63.0 #### Parameters * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room providers to return from `1` through `20`. By default, `20` providers are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomProviderCollectionRepresentation`. _Example: Example_ ``` { "limit": 2, "offset": 0, "providers": [ { "createdBy": { "name": "Platform Integration User" }, "createdDate": "2025-11-20T05:19:09.000Z", "dataCloudOrgId": "00DSB00000eLeZh2AK", "description": "Reports Package Description", "id": "1TQSB00000sOLvR4AW", "label": "ReportsPackage", "lastModifiedBy": { "name": "Platform Integration User" }, "lastModifiedDate": "2025-11-20T05:19:09.000Z", "name": "X00DSB00000eLeZh2AK_ReportsPackage1763536436462", "templateNames": [ "Overlap" ] }, { "createdBy": { "name": "Platform Integration User" }, "createdDate": "2025-11-06T09:17:08.000Z", "dataCloudOrgId": "00DSB00000eLeZh2AK", "description": "sdb_ext_test_nov_6", "id": "1TQSB00000rVBtV4AW", "label": "sdb_ext_test_nov_6", "lastModifiedBy": { "name": "Platform Integration User" }, "lastModifiedDate": "2025-11-06T09:17:08.000Z", "name": "X00DSB00000eLeZh2AK_sdb_ext_test_nov_61762414586398", "templateNames": [] } ], "totalSize": 2 } ``` * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Create a provider `POST /ssot/data-clean-room/providers` Tags: Clean Rooms. Create a new clean room provider. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomProviderInputRepresentation`. _Example: AWS request_ ``` { "label": "package_AWS", "description": "AWS", "source": "AWS", "templateJson": { "name": "Example1", "description": "Example of Clean Room Customized Templates", "tables": { "tableConfigs": [ { "name": "Provider", "description": "Provider table for overlap use-case.", "role": "Provider", "columns": [ { "name": "SegmentName", "description": "Name of the segment.", "type": "STRING" }, { "name": "Category", "description": "Category of the segment.", "type": "STRING" }, { "name": "ParentCategory", "description": "Parent Category of the segment.", "type": "STRING" }, { "name": "SegmentSize", "description": "Size of the segment.", "type": "INTEGER" }, { "name": "MemberId", "description": "Member ID, only aggregation or joins is allowed.", "type": "STRING" }, { "name": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "type": "HASHED_EMAIL" } ] }, { "name": "Consumer", "description": "Consumer table.", "role": "Consumer", "columns": [ { "name": "SegmentId", "description": "Segment ID", "type": "STRING" }, { "name": "SegmentName", "description": "Name of the segment.", "type": "STRING" }, { "name": "SegmentSize", "description": "Size of the segment.", "type": "NUMBER" }, { "name": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "type": "HASHED_EMAIL" } ] } ] }, "queries": { "queryConfigs": [ { "name": "QueryOverlap", "useCase": "Overlap", "description": "Query to calculate the overlap between consumers and providers.", "type": "SQL", "source": "SELECT Consumer.SegmentId AS Segment_Id__c, Consumer.SegmentName AS Segment_Name__c, Provider.SegmentName AS Provider_Segment_Name__c, Provider.Category AS Provider_Segment_Category__c, Provider.ParentCategory AS Provider_Segment_Parent_Category__c, Provider.SegmentSize AS Provider_Segment_Size__c, Consumer.SegmentSize AS Segment_Size__c, COUNT(DISTINCT Provider.MemberId) AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.HashedEmailAddress = Provider.HashedEmailAddress GROUP BY Consumer.SegmentId, Consumer.SegmentName, Provider.SegmentName, Provider.Category, Provider.ParentCategory, Provider.SegmentSize, Consumer.SegmentSize HAVING COUNT(DISTINCT Provider.MemberId) >= :threshold_count", "queryParameters": { "queryParamConfigs": [ { "name": "threshold_count", "type": "INTEGER", "description": "threshold_count" } ] }, "referencedTables": [ "Consumer", "Provider" ] } ] } }, "templateType": "CUSTOM", "providerName": "package_AWS", "sourceConfiguration": { "type": "AWS", "accountId": "041291292938", "supportedRegions": [ "us-east-1", "us-west-2", "ap-southeast-2", "ap-northeast-1" ] } } ``` _Example: Extensible request_ ``` { "label": "package_sf_custom", "description": "extensible ", "source": "DATA_CLOUD", "templateJson": { "name": "Example1", "description": "Example of Clean Room Customized Templates", "tables": { "tableConfigs": [ { "name": "Provider", "description": "Provider table for overlap use-case.", "role": "Provider", "columns": [ { "name": "SegmentName", "description": "Name of the segment.", "type": "STRING" }, { "name": "Category", "description": "Category of the segment.", "type": "STRING" }, { "name": "ParentCategory", "description": "Parent Category of the segment.", "type": "STRING" }, { "name": "SegmentSize", "description": "Size of the segment.", "type": "INTEGER" }, { "name": "MemberId", "description": "Member ID, only aggregation or joins is allowed.", "type": "STRING" }, { "name": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "type": "HASHED_EMAIL" } ] }, { "name": "Consumer", "description": "Consumer table.", "role": "Consumer", "columns": [ { "name": "SegmentId", "description": "Segment ID", "type": "STRING" }, { "name": "SegmentName", "description": "Name of the segment.", "type": "STRING" }, { "name": "SegmentSize", "description": "Size of the segment.", "type": "NUMBER" }, { "name": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "type": "HASHED_EMAIL" } ] } ] }, "queries": { "queryConfigs": [ { "name": "QueryOverlap", "useCase": "Overlap", "description": "Query to calculate the overlap between consumers and providers.", "type": "SQL", "source": "SELECT Consumer.SegmentId AS Segment_Id__c, Consumer.SegmentName AS Segment_Name__c, Provider.SegmentName AS Provider_Segment_Name__c, Provider.Category AS Provider_Segment_Category__c, Provider.ParentCategory AS Provider_Segment_Parent_Category__c, Provider.SegmentSize AS Provider_Segment_Size__c, Consumer.SegmentSize AS Segment_Size__c, COUNT(DISTINCT Provider.MemberId) AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.HashedEmailAddress = Provider.HashedEmailAddress GROUP BY Consumer.SegmentId, Consumer.SegmentName, Provider.SegmentName, Provider.Category, Provider.ParentCategory, Provider.SegmentSize, Consumer.SegmentSize HAVING COUNT(DISTINCT Provider.MemberId) >= :threshold_count", "queryParameters": { "queryParamConfigs": [ { "name": "threshold_count", "type": "INTEGER", "description": "threshold_count" } ] }, "referencedTables": [ "Consumer", "Provider" ] } ] } }, "templateType": "CUSTOM", "providerName": "package_sf_custom", "sourceConfiguration": { "type": "DATA_CLOUD", "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "domainUrl": "https://comapany1.my.salesforce-com.r52gqz0r35dj0d86b5mcoqfcf00h7p.wa.crm.dev:6101", "offCoreTenantId": "a360/falcondev/7607223bc6dd4830a534cb148f572eaf" } } ``` _Example: Native request_ ``` { "label": "package_salesforce", "description": "datacloud - sf", "source": "DATA_CLOUD", "templateType": "SALESFORCE", "useCaseTypeConfig": { "useCaseTypes": [ "Overlap" ] }, "providerName": "providerSf", "sourceConfiguration": { "type": "DATA_CLOUD", "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "domainUrl": "https://comapany1.my.salesforce-com.r52gqz0r35dj0d86b5mcoqfcf00h7p.wa.crm.dev:6101", "offCoreTenantId": "a360/falcondev/7607223bc6dd4830a534cb148f572eaf" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomProviderRepresentation`. _Example: AWS response_ ``` { "createdBy": {}, "description": "AWS", "id": "1TQxx0000004Eh6GAE", "label": "package_AWS", "lastModifiedBy": {}, "name": "X00Dxx00QA6JqfVUEMZ_package_AWS1765305467896", "providerName": "package_AWS", "source": "AWS", "sourceConfiguration": { "accountId": "041291292938", "supportedRegions": [ "us-east-1", "us-west-2", "ap-southeast-2", "ap-northeast-1" ], "type": "AWS" }, "templateNames": [], "useCaseTypeConfig": { "useCaseTypes": [ "Overlap" ] } } ``` _Example: Extensible response_ ``` { "createdBy": {}, "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "description": "extensible", "id": "1TQxx0000004EfUGAU", "label": "package_sf_custom", "lastModifiedBy": {}, "name": "X00Dxx00QA6JqfFMEMZ_package_sf_custom1765304627484", "providerName": "package_sf_custom", "source": "DATA_CLOUD", "sourceConfiguration": { "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "domainUrl": "https://comapany1.my.salesforce-com.r52gqz0r35dj0d86b5mcoqfcf00h7p.wa.crm.dev:6101", "offCoreTenantId": "a360/falcondev/7607223bc6dd4830a534cb148f572eaf", "type": "DATA_CLOUD" }, "templateNames": [], "useCaseTypeConfig": { "useCaseTypes": [ "Overlap" ] } } ``` _Example: Native response_ ``` { "createdBy": {}, "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "description": "datacloud-sf", "id": "1TQxx0000004EdsGAE", "label": "package_salesforce", "lastModifiedBy": {}, "name": "X00Dxx00QA6JqfFMEMZ_package_salesforce1765304430035", "providerName": " providerSf", "source": "DATA_CLOUD", "sourceConfiguration": { "dataCloudOrgId": "00Dxx00QA6JqfFMEMZ", "domainUrl": "https://comapany1.my.salesforce-com.r52gqz0r35dj0d86b5mcoqfcf00h7p.wa.crm.dev:6101", "offCoreTenantId": "a360/falcondev/7607223bc6dd4830a534cb148f572eaf", "type": "DATA_CLOUD" }, "templateNames": [], "useCaseTypeConfig": { "useCaseTypes": [ "Overlap" ] } } ``` * **400** Bad request or invalid API input. For example: * Unrecognized field `templateType` at \[line: _lineNumber_, column: _columnNumber_\]. * Use case type or template names for OOTB Salesforce template type can not be null/empty. * Data clean room provider description cannot be empty. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get a provider `GET /ssot/data-clean-room/providers/{providerIdOrName}` Tags: Clean Rooms. Get a clean room provider. **Available Version:** 63.0 #### Parameters * `providerIdOrName` (path, string, required) ID or developer name of the clean room provider. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomProviderRepresentation`. _Example: Example_ ``` { "createdBy": { "id": "005xx000001X8PdAAK", "name": "Admin User" }, "createdDate": "2025-11-25T21:03:45.000Z", "dataCloudOrgId": "00Dxx00QA6JqipwEMB", "description": "sdsfsdfsaf", "id": "1TQxx0000004EcGGAU", "label": "vvs1", "lastModifiedBy": { "id": "005xx000001X8PdAAK", "name": "Admin User" }, "lastModifiedDate": "2025-11-25T21:03:45.000Z", "name": "X00Dxx00QA6JqipwEMB_vvs11764104135467", "providerName": "vvs1", "source": "DATA_CLOUD", "sourceConfiguration": { "dataCloudOrgId": "00Dxx00QA6JqipwEMB", "domainUrl": " ", "offCoreTenantId": "a360/falcondev/942f2924b26249529708d941392c2453", "type": "DATA_CLOUD" }, "templateNames": [ "Overlap" ], "useCaseTypeConfig": { "useCaseTypes": [ "Overlap" ] } } ``` * **400** The server could not process the request as the params/payload was incorrect. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get provider templates `GET /ssot/data-clean-room/providers/{providerIdOrName}/templates` Tags: Clean Rooms. Get a list of all templates associated with a clean room provider. **Available Version:** 63.0 #### Parameters * `providerIdOrName` (path, string, required) ID or developer name of the clean room provider. **Available Version:** 63.0 * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room templates to return from `1` through `20`. By default, `20` templates are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomTemplateCollectionRepresentation`. _Example: Example_ ``` { "limit": 2, "offset": 0, "templates": [ { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentSize", "description": "Captures the Segment Size", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "Category", "description": "Captures the Category", "id": "Category", "label": "Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "ParentCategory", "description": "Captures the Parent Category", "id": "ParentCategory", "label": "Parent Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [ "COUNT" ], "threshold": 100000 }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "PROVIDER" }, { "attributeConfigs": [ { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentSize", "description": "Captures the Segment size to compute overlap", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": false, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "CONSUMER" } ] }, "description": "Overlap Report", "id": "1TTSB000002W6yn4AC", "name": "Overlap", "queryTemplate": { "template": "SELECT Consumer."SegmentId" AS Segment_Id__c, Consumer."SegmentName" AS Segment_Name__c, Provider."SegmentName" AS Provider_Segment_Name__c, Provider."Category" AS Provider_Segment_Category__c, Provider."ParentCategory" AS Provider_Segment_Parent_Category__c, Provider."SegmentSize" AS Provider_Segment_Size__c, Consumer."SegmentSize" AS Segment_Size__c, COUNT(DISTINCT Provider."MemberId") AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer."HashedEmailAddress" = Provider."HashedEmailAddress" GROUP BY Consumer."SegmentId", Consumer."SegmentName", Provider."SegmentName", Provider."Category", Provider."ParentCategory", Provider."SegmentSize", Consumer."SegmentSize" HAVING COUNT(DISTINCT Provider."MemberId") >= 100", "frequencyCapping": [ { "frequency": "DAILY", "count": 9999 }, { "frequency": "MONTHLY", "count": 999999 } ], "name": "report" } }, { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentId", "description": "Segment ID", "id": "SegmentId", "label": "SegmentId", "queryOptions": {}, "required": true }, { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "CONSUMER" }, { "attributeConfigs": [ { "alias": "SegmentName", "description": "Name of the segment.", "id": "SegmentName", "label": "SegmentName", "queryOptions": {}, "required": true }, { "alias": "Category", "description": "Category of the segment.", "id": "Category", "label": "Category", "queryOptions": {}, "required": true }, { "alias": "ParentCategory", "description": "Parent Category of the segment.", "id": "ParentCategory", "label": "ParentCategory", "queryOptions": {}, "required": true }, { "alias": "SegmentSize", "description": "Size of the segment.", "id": "SegmentSize", "label": "SegmentSize", "queryOptions": {}, "required": true }, { "alias": "MemberId", "description": "Member ID, only aggregation or joins is allowed.", "id": "MemberId", "label": "MemberId", "queryOptions": {}, "required": true }, { "alias": "HashedEmailAddress", "description": "Contact ID hashed with SHA256", "id": "HashedEmailAddress", "label": "HashedEmailAddress", "queryOptions": {}, "required": true } ], "memberType": "PROVIDER" } ] }, "description": "Query to calculate the overlap between consumers and providers.", "id": "1TTSB000002Uq9h4AC", "name": "QueryOverlap", "queryTemplate": { "template": "SELECT Consumer.SegmentId AS Segment_Id__c, Consumer.SegmentName AS Segment_Name__c, Provider.SegmentName AS Provider_Segment_Name__c, Provider.Category AS Provider_Segment_Category__c, Provider.ParentCategory AS Provider_Segment_Parent_Category__c, Provider.SegmentSize AS Provider_Segment_Size__c, Consumer.SegmentSize AS Segment_Size__c, COUNT(DISTINCT Provider.MemberId) AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.HashedEmailAddress = Provider.HashedEmailAddress GROUP BY Consumer.SegmentId, Consumer.SegmentName, Provider.SegmentName, Provider.Category, Provider.ParentCategory, Provider.SegmentSize, Consumer.SegmentSize HAVING COUNT(DISTINCT Provider.MemberId) >= :threshold_count", "useCaseType": "Overlap", "queryParameters": "[{"name":"threshold_count","description":"threshold_count","type":"INTEGER"}]", "name": "QueryOverlap", "description": "Query to calculate the overlap between consumers and providers.", "queryTemplateType": "SQL" } } ], "totalSize": 2 } ``` * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get specifications `GET /ssot/data-clean-room/specifications` Tags: Clean Rooms. Get a list of all clean room specifications. **Available Version:** 63.0 #### Parameters * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room specifications to return from `1` through `20`. By default, `20` specifications are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of records to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomSpecificationCollectionRepresentation`. _Example: Example_ ``` { "cleanroomSpecifications": [ { "createdBy": { "name": "OrgFarm EPIC" }, "createdDate": "2025-12-08T06:54:29.000Z", "dataMapping": { "attributes": [ { "alias": "SegmentName", "attributeId": "SegmentName", "filterOptions": { "operator": "equal", "values": [ "Test Optional Value" ] }, "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Internal Organization", "fieldName": "ssot__InternalOrganizationId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "SegmentId", "attributeId": "SegmentId", "filterOptions": { "operator": "equal", "values": [ "Test Required Value" ] }, "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "SegmentSize", "attributeId": "SegmentSize", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Data Source Object", "fieldName": "ssot__DataSourceObjectId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "Category", "attributeId": "Category", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "First Name", "fieldName": "ssot__FirstName__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "ParentCategory", "attributeId": "ParentCategory", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "MemberId", "attributeId": "MemberId", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Data Source Object", "fieldName": "ssot__DataSourceObjectId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "HashedEmailAddress", "attributeId": "HashedEmailAddress", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "First Name", "fieldName": "ssot__FirstName__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } } ], "collaborationEntity": "ssot__ContactPointEmail__dlm" }, "dataSpaceName": "default", "description": "specification for automation OOTB_1765176542856", "id": "1TISB000000754b4AA", "label": "Specification_OOTB_Contact Point Email_Individual_1765176542856", "lastModifiedBy": { "name": "Automated Process" }, "lastModifiedDate": "2025-12-08T06:55:02.000Z", "memberType": "PROVIDER", "name": "Specification_OOTB_Contact_Point_Email_Individual_1765176542856_00DSB00000eLeZ", "ownerOrgId": "00DSB00000eLeZh2AK", "status": "ACTIVE", "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentSize", "description": "Captures the Segment Size", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "Category", "description": "Captures the Category", "id": "Category", "label": "Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "ParentCategory", "description": "Captures the Parent Category", "id": "ParentCategory", "label": "Parent Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [ "COUNT" ], "threshold": 100000 }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "PROVIDER" }, { "attributeConfigs": [ { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentSize", "description": "Captures the Segment size to compute overlap", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": false, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "CONSUMER" } ] }, "description": "Overlap Report", "id": "1TTSB000002W6yn4AC", "name": "Overlap", "queryTemplate": { "template": "SELECT Consumer."SegmentId" AS Segment_Id__c, Consumer."SegmentName" AS Segment_Name__c, Provider."SegmentName" AS Provider_Segment_Name__c, Provider."Category" AS Provider_Segment_Category__c, Provider."ParentCategory" AS Provider_Segment_Parent_Category__c, Provider."SegmentSize" AS Provider_Segment_Size__c, Consumer."SegmentSize" AS Segment_Size__c, COUNT(DISTINCT Provider."MemberId") AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer."HashedEmailAddress" = Provider."HashedEmailAddress" GROUP BY Consumer."SegmentId", Consumer."SegmentName", Provider."SegmentName", Provider."Category", Provider."ParentCategory", Provider."SegmentSize", Consumer."SegmentSize" HAVING COUNT(DISTINCT Provider."MemberId") >= 100", "frequencyCapping": [ { "frequency": "DAILY", "count": 9999 }, { "frequency": "MONTHLY", "count": 999999 } ], "name": "report" } } }, { "createdBy": { "name": "OrgFarm EPIC" }, "createdDate": "2025-12-07T06:44:07.000Z", "dataMapping": { "attributes": [ { "alias": "SegmentName", "attributeId": "SegmentName", "filterOptions": { "operator": "equal", "values": [ "Test Optional Value" ] }, "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Internal Organization", "fieldName": "ssot__InternalOrganizationId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "SegmentId", "attributeId": "SegmentId", "filterOptions": { "operator": "equal", "values": [ "Test Required Value" ] }, "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "SegmentSize", "attributeId": "SegmentSize", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Data Source Object", "fieldName": "ssot__DataSourceObjectId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "Category", "attributeId": "Category", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "First Name", "fieldName": "ssot__FirstName__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "ParentCategory", "attributeId": "ParentCategory", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Individual Id", "fieldName": "ssot__Id__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "MemberId", "attributeId": "MemberId", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "Data Source Object", "fieldName": "ssot__DataSourceObjectId__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } }, { "alias": "HashedEmailAddress", "attributeId": "HashedEmailAddress", "path": [ { "sourceAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__ContactPointEmail__dlm" }, "targetAttribute": { "fieldName": "ssot__Id__c", "objectName": "ssot__Individual__dlm" } } ], "subjectAttribute": { "fieldLabel": "First Name", "fieldName": "ssot__FirstName__c", "objectLabel": "Individual", "objectName": "ssot__Individual__dlm" } } ], "collaborationEntity": "ssot__ContactPointEmail__dlm" }, "dataSpaceName": "default", "description": "specification for automation OOTB_1765089544445", "id": "1TISB000000751N4AQ", "label": "Specification_OOTB_Contact Point Email_Individual_1765089544445", "lastModifiedBy": { "name": "Automated Process" }, "lastModifiedDate": "2025-12-07T06:50:04.000Z", "memberType": "PROVIDER", "name": "Specification_OOTB_Contact_Point_Email_Individual_1765089544445_00DSB00000eLeZ", "ownerOrgId": "00DSB00000eLeZh2AK", "status": "ACTIVE", "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentSize", "description": "Captures the Segment Size", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "Category", "description": "Captures the Category", "id": "Category", "label": "Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "ParentCategory", "description": "Captures the Parent Category", "id": "ParentCategory", "label": "Parent Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [ "COUNT" ], "threshold": 100000 }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "PROVIDER" }, { "attributeConfigs": [ { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentSize", "description": "Captures the Segment size to compute overlap", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": false, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "CONSUMER" } ] }, "description": "Overlap Report", "id": "1TTSB000002W6yn4AC", "name": "Overlap", "queryTemplate": { "template": "SELECT Consumer."SegmentId" AS Segment_Id__c, Consumer."SegmentName" AS Segment_Name__c, Provider."SegmentName" AS Provider_Segment_Name__c, Provider."Category" AS Provider_Segment_Category__c, Provider."ParentCategory" AS Provider_Segment_Parent_Category__c, Provider."SegmentSize" AS Provider_Segment_Size__c, Consumer."SegmentSize" AS Segment_Size__c, COUNT(DISTINCT Provider."MemberId") AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer."HashedEmailAddress" = Provider."HashedEmailAddress" GROUP BY Consumer."SegmentId", Consumer."SegmentName", Provider."SegmentName", Provider."Category", Provider."ParentCategory", Provider."SegmentSize", Consumer."SegmentSize" HAVING COUNT(DISTINCT Provider."MemberId") >= 100", "frequencyCapping": [ { "frequency": "DAILY", "count": 9999 }, { "frequency": "MONTHLY", "count": 999999 } ], "name": "report" } } } ], "limit": 2, "offset": 0, "totalSize": 2 } ``` * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Create a specification `POST /ssot/data-clean-room/specifications` Tags: Clean Rooms. Create a new clean room specification. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataCleanRoomDataSpecificationInputRepresentation`. _Example: Example_ ``` { "dataMapping": { "collaborationEntity": "ssot__ContactPointEmail__dlm", "attributes": [ { "attributeId": "SegmentId", "alias": "SegmentId", "subjectAttribute": { "objectName": "ssot__ContactPointEmail__dlm", "objectLabel": "Contact Point Email", "fieldName": "ssot__InternalOrganizationId__c", "fieldLabel": "Internal Organization" } }, { "attributeId": "SegmentName", "alias": "SegmentName", "subjectAttribute": {} }, { "attributeId": "SegmentSize", "alias": "SegmentSize", "subjectAttribute": {} }, { "attributeId": "MemberId", "alias": "MemberId", "subjectAttribute": { "objectName": "ssot__ContactPointEmail__dlm", "objectLabel": "Contact Point Email", "fieldName": "ssot__DataSourceId__c", "fieldLabel": "Data Source" } }, { "attributeId": "HashedEmailAddress", "alias": "HashedEmailAddress", "subjectAttribute": { "objectName": "ssot__ContactPointEmail__dlm", "objectLabel": "Contact Point Email", "fieldName": "ssot__DataSourceId__c", "fieldLabel": "Data Source" } } ] }, "memberType": "CONSUMER", "ownerOrgId": "00Dxx00QA6JqfVUEMZ", "templateName": "Overlap", "name": "sampleMapping", "label": "sampleMapping", "dataspaceName": "default", "templateVersionId": "1TTxx0000004Cc4GAE", "templateType": "SALESFORCE", "useCaseType": "Overlap" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomDataSpecificationRepresentation`. _Example: Example_ ``` { "dataMapping": { "attributes": [ { "alias": "SegmentId", "attributeId": "SegmentId", "path": [], "subjectAttribute": { "fieldLabel": "Internal Organization", "fieldName": "ssot__InternalOrganizationId__c", "objectLabel": "Contact Point Email", "objectName": "ssot__ContactPointEmail__dlm" } }, { "alias": "MemberId", "attributeId": "MemberId", "path": [], "subjectAttribute": { "fieldLabel": "Data Source", "fieldName": "ssot__DataSourceId__c", "objectLabel": "Contact Point Email", "objectName": "ssot__ContactPointEmail__dlm" } }, { "alias": "HashedEmailAddress", "attributeId": "HashedEmailAddress", "path": [], "subjectAttribute": { "fieldLabel": "Data Source", "fieldName": "ssot__DataSourceId__c", "objectLabel": "Contact Point Email", "objectName": "ssot__ContactPointEmail__dlm" } } ], "collaborationEntity": "ssot__ContactPointEmail__dlm" }, "dataSpace": { "id": "0vhxx000000004rAAA", "name": "default" }, "dataSpaceName": "default", "id": "1TIxx0000004CSOGA2", "memberType": "CONSUMER", "name": "sampleMapping", "ownerOrgId": "00Dxx00QA6JqfVUEMZ", "status": "ACTIVE", "templateVersion": { "configuration": { "memberConfigs": [ { "attributeConfigs": [ { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentSize", "description": "Captures the Segment Size", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "Category", "description": "Captures the Category", "id": "Category", "label": "Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "ParentCategory", "description": "Captures the Parent Category", "id": "ParentCategory", "label": "Parent Category", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [ "COUNT" ], "threshold": 100000 }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "PROVIDER" }, { "attributeConfigs": [ { "alias": "SegmentId", "description": "Captures the Segment Id to compute overlap", "id": "SegmentId", "label": "Segment Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": true }, { "alias": "SegmentName", "description": "Captures the Segment Name", "id": "SegmentName", "label": "Segment Name", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": true, "supportJoin": false }, "required": false }, { "alias": "SegmentSize", "description": "Captures the Segment size to compute overlap", "id": "SegmentSize", "label": "Segment Size", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": true, "supportGroupBy": false, "supportJoin": false }, "required": false }, { "alias": "MemberId", "description": "Captures the Member Id", "id": "MemberId", "label": "Member Id", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": false }, "required": true }, { "alias": "HashedEmailAddress", "description": "Captures the Hashed email address on which match is performed", "id": "HashedEmailAddress", "label": "Hashed Email Address", "queryOptions": { "aggregationOption": { "operators": [] }, "selectable": false, "supportGroupBy": false, "supportJoin": true }, "required": true } ], "memberType": "CONSUMER" } ] }, "description": "Overlap Report", "id": "1TTxx0000004Cc4GAE", "name": "Overlap", "queryTemplate": { "template": "SELECT Consumer.\"SegmentId\" AS Segment_Id__c, Consumer.\"SegmentName\" AS Segment_Name__c, Provider.\"SegmentName\" AS Provider_Segment_Name__c, Provider.\"Category\" AS Provider_Segment_Category__c, Provider.\"ParentCategory\" AS Provider_Segment_Parent_Category__c, Provider.\"SegmentSize\" AS Provider_Segment_Size__c, Consumer.\"SegmentSize\" AS Segment_Size__c, COUNT(DISTINCT Provider.\"MemberId\") AS Matching_Population_Count__c FROM Consumer JOIN Provider ON Consumer.\"HashedEmailAddress\" = Provider.\"HashedEmailAddress\" GROUP BY Consumer.\"SegmentId\", Consumer.\"SegmentName\", Provider.\"SegmentName\", Provider.\"Category\", Provider.\"ParentCategory\", Provider.\"SegmentSize\", Consumer.\"SegmentSize\" HAVING COUNT(DISTINCT Provider.\"MemberId\") >= 100", "frequencyCapping": [ { "frequency": "DAILY", "count": 9999 }, { "frequency": "MONTHLY", "count": 999999 } ], "name": "report" }, "templateType": "SALESFORCE", "templateVersion": "v1.0", "useCaseType": "Overlap" } } ``` * **400** JSON parser error or invalid API input. For example: * Unrecognized field "_fieldName_" at \[line: _lineNumber_, column: _columnNumber_\] * Data clean room collaboration label cannot be empty. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### DELETE Delete a specification `DELETE /ssot/data-clean-room/specifications/{specificationIdOrApiName}` Tags: Clean Rooms. Deletes a specific clean room specification. **Available Version:** 66.0 #### Parameters * `specificationIdOrApiName` (path, string, required) ID or API name of the clean room specification. **Available Version:** 66.0 #### Responses * **200** Success * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get templates `GET /ssot/data-clean-room/templates` Tags: Clean Rooms. Get a list of all clean room templates. **Available Version:** 63.0 #### Parameters * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of clean room templates to return from `1` through `20`. By default, `20` templates are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of records to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomTemplateCollectionRepresentation`. _Example Example: same as GET /ssot/data-clean-room/providers/{providerIdOrName}/templates 200 response._ * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get template collaborations `GET /ssot/data-clean-room/templates/{useCaseTemplateType}/collaborations` Tags: Clean Rooms. Retrieve a paginated list of all collaborations for a specific type of use case template. **Available Version:** 66.0 #### Parameters * `useCaseTemplateType` (path, string, required) Type of use case template. **Available Version:** 66.0 * `filters` (query, string) Field names by which to filter results. Specify a comma-separated list of equality expressions, such as `developerName eq extensiblepackage0123456789012`. By default, no filter is applied. **Available Version:** 66.0 * `limit` (query, integer) Maximum number of clean room templates to return from `1` through `20`. By default, `20` collaborations are returned. **Available Version:** 66.0 * `offset` (query, integer) Number of records to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 66.0 * `orderBy` (query, string) Sort order for the result set. Specify a field and an order, ascending (`ASC`) or descending (`DESC`). For example, `createdDate DESC`. By default, items are returned in the order they are retrieved. **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataCleanRoomCollaborationCollectionForUseCaseTypeRepresentation`. _Example: example1_ ``` { "id": "0trRM00000001TTYAZ", "name": "Match Boost Template", "description": "Template for identity resolution collaboration", "useCaseType": "MATCH_BOOST", "status": "PUBLISHED", "metadataConfiguration": { "memberConfig": [ { "type": "CONSUMER", "canTriggerQuery": true, "canReceiveResult": true, "paysForQueries": true, "contributesData": false, "outputConfig": { "destinationType": "DCFConnector", "connectorType": "CleanroomS3" } }, { "type": "PROVIDER", "canTriggerQuery": false, "canReceiveResult": false, "paysForQueries": false, "contributesData": true, "outputConfig": null } ], "usecaseConfig": { "outputObjects": [ { "objectApiName": "PartyIdentification", "bridgeTable": { "sourceIdColumn": "SourceId" }, "relatedTable": null }, { "objectApiName": "PartnerConsumer1BoostedIndividualTable", "bridgeTable": null, "relatedTable": { "sourceObjectApiName": "ssot__Individual__dlm", "pathFromBridgeTable": [ { "sourceAttribute": { "objectApiName": "PartnerConsumer1BoostedIndividualTable", "fieldApiName": "IndividualId" }, "targetAttribute": { "objectApiName": "PartyIdentification", "fieldApiName": "PartyIdentificationId" } } ] } } ] } } } ``` * **400** Invalid batch request or illegal query parameter value. For example: * Invalid value: _queryParameterValue_. Please provide valid filters. * Illegal value for query parameter `offset`:_queryParameterValue_. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Test connection `POST /ssot/data-clean-room/test-connection` Tags: Clean Rooms. Test the connection between the clean room and the provider's external storage. **Available Version:** 66.0 #### Request body Media type: `application/json`. Schema: `CleanroomTestConnectionInputRepresentation`. _Example: example1_ ``` { "consumerOrgId": "00D000000000001", "connectorType": "CleanroomAwsS3", "connectionAttributes": { "authenticationOption": "idp", "bucketName": "cleanroom-data-bucket", "parentDirectory": "/shared-data/", "iamRoleName": "arn:aws:iam::123456789012:role/CleanroomDataAccessRole", "externalId": "app:DE809C7E:A1B2C3D4" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CleanRoomTestConnectionRepresentation`. _Example: Success response_ ``` { "success": true, "message": "Connection test successful" } ``` _Example: Failure response_ ``` { "success": false, "message": "Unable to assume IAM role. Verify the role ARN and trust policy.", "errorCode": "CONNECTORS_FRAMEWORK_TEST_FAILED", "details": { "subErrorCode": "INVALID_IAM_ROLE", "subErrorMessage": "Role ARN not found or access denied" } } ``` * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn’t accessible to guest users. The response body contains the message and errorCode. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server could not find the requested web page. Verify the URL is correct. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get access policies `GET /ssot/data-governance/access-policies` Tags: Data Governance. Returns a paginated list of builder-compatible access policies. To include system or legacy policies that aren't builder-compatible, set `includeIncompatible` to `true`. **Available Version:** 67.0 #### Parameters * `includeIncompatible` (query, boolean) Indicates whether to include policies that aren't builder-compatible (`true`) or not (`false`). If unspecified, the default value is `false`. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of access policies to return. Values are `5` through `200`. If unspecified, the default value is `25`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `searchString` (query, string) Case-insensitive substring to match against the policy name or label. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyCollectionRepresentation`. _Example: example1_ ``` { "records": [ { "id": "0hp8Z000000002mQAA", "name": "RestrictSensitiveFields", "label": "Restrict Sensitive Fields", "description": "Restricts read access to sensitive account fields.", "builderCompatible": true, "builderValidated": true, "createdBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "createdDate": "2026-06-15T18:24:11.000Z", "lastModifiedBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "lastModifiedDate": "2026-06-15T18:24:11.000Z", "url": "/services/data/v67.0/ssot/data-governance/access-policies/RestrictSensitiveFields", "rules": [] } ], "totalSize": 1, "nextPageUrl": null } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * limit must be between 5 and 200. * offset must be non-negative. ### POST Create access policy `POST /ssot/data-governance/access-policies` Tags: Data Governance. Creates an access policy, with optional inline rules, using all-or-none semantics. A builder-compatible policy can contain at most one rule. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `AccessPolicyInputRepresentation`. _Example: example1_ ``` { "name": "RestrictSensitiveFields", "label": "Restrict Sensitive Fields", "description": "Restricts read access to sensitive account fields.", "rules": [ { "name": "Mask_SSN", "label": "Mask SSN", "category": "TRANSFORM_POLICY_RULE_DEFINITION", "effect": "Transform", "action": [ "Read" ], "resourceScopeType": "FIELD", "principalScopeType": "ANY", "resourceDomains": [ "Account__dlm" ], "resourceTransform": "FIRST_N_CHARS_RESOURCE_TRANSFORM", "resourceTransformArguments": [ { "type": "NUMBER", "value": "4" } ], "transformPrecedence": 100 } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyRepresentation`. _Example: example1_ ``` { "id": "0hp8Z000000002mQAA", "name": "RestrictSensitiveFields", "label": "Restrict Sensitive Fields", "description": "Restricts read access to sensitive account fields.", "builderCompatible": true, "builderValidated": true, "createdBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "createdDate": "2026-06-15T18:24:11.000Z", "lastModifiedBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "lastModifiedDate": "2026-06-15T18:24:11.000Z", "url": "/services/data/v67.0/ssot/data-governance/access-policies/RestrictSensitiveFields", "rules": [ { "id": "0hs8Z000000002mQAA", "name": "Mask_SSN", "label": "Mask SSN", "category": "TRANSFORM_POLICY_RULE_DEFINITION", "effect": "Transform", "action": [ "Read" ], "resourceScopeType": "FIELD", "principalScopeType": "ANY", "resourceDomains": [ "Account__dlm" ], "resourceTransform": "FIRST_N_CHARS_RESOURCE_TRANSFORM", "resourceTransformArguments": [ { "type": "NUMBER", "value": "4" } ], "transformPrecedence": 100 } ] } ``` * **400** INVALID\_INPUT, INVALID\_DEVELOPER\_NAME, MISSING\_ARGUMENT, or MULTIPLE\_RULES\_NOT\_ALLOWED For example: * A policy can contain at most ONE rule to remain compatible with the Access Policy UI Builder. * Developer name must be alphanumeric with no spaces. * Input representation is required. * Policy validation failed: builder-compatible policies can have at most one rule. * **401** INVALID\_SESSION\_ID: Session expired or invalid. ### GET Get access policy `GET /ssot/data-governance/access-policies/{name}` Tags: Data Governance. Returns a single access policy and its rules by developer name. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) Developer name of the access policy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyRepresentation`. _Example example1: same as POST /ssot/data-governance/access-policies 200 response._ * **400** MULTIPLE\_RULES\_NOT\_ALLOWED or NAME\_MISMATCH For example: * The policy cannot contain more than one rule for UI Builder compatibility. * The rule name in URL and request body must match. * **401** INVALID\_SESSION\_ID: Session expired or invalid. * **404** RESOURCE\_NOT\_FOUND: Access Policy with developer name _{name}_ was not found. ### DELETE Delete access policy `DELETE /ssot/data-governance/access-policies/{name}` Tags: Data Governance. Permanently deletes an access policy and cascades the delete to its rules. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) Developer name of the access policy. **Available Version:** 67.0 #### Responses * **202** Success * **401** INVALID\_SESSION\_ID: Session expired or invalid. * **404** RESOURCE\_NOT\_FOUND: Access Policy with developer name _{name}_ was not found. ### PATCH Update access policy `PATCH /ssot/data-governance/access-policies/{name}` Tags: Data Governance. Applies an idempotent partial update to an access policy's label or description. To modify rules, use the PUT rules endpoint instead. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) Developer name of the access policy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `AccessPolicyPatchInputRepresentation`. _Example: example1_ ``` { "label": "Regional Masking Updated", "description": "Updated policy description." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyRepresentation`. _Example: example1_ ``` { "id": "0hp8Z000000002mQAA", "name": "RestrictSensitiveFields", "label": "Regional Masking Updated", "description": "Updated policy description.", "builderCompatible": true, "builderValidated": true, "createdBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "createdDate": "2026-06-15T18:24:11.000Z", "lastModifiedBy": { "id": "0058Z00000BqYZ0QAN", "name": "John Smith", "profilePhotoUrl": "/services/images/photo/0058Z00000BqYZ0QAN" }, "lastModifiedDate": "2026-07-01T14:02:55.000Z", "url": "/services/data/v67.0/ssot/data-governance/access-policies/RestrictSensitiveFields", "rules": [ { "id": "0hs8Z000000002mQAA", "name": "Mask_SSN", "label": "Mask SSN", "category": "TRANSFORM_POLICY_RULE_DEFINITION", "effect": "Transform", "action": [ "Read" ], "resourceScopeType": "FIELD", "principalScopeType": "ANY", "resourceDomains": [ "Account__dlm" ], "resourceTransform": "FIRST_N_CHARS_RESOURCE_TRANSFORM", "resourceTransformArguments": [ { "type": "NUMBER", "value": "4" } ], "transformPrecedence": 100 } ] } ``` * **400** RULE\_MUTATION\_NOT\_SUPPORTED For example: * Rules cannot be updated via PATCH access-policies endpoint. Use PUT /rules instead. * **401** INVALID\_SESSION\_ID: Session expired or invalid. * **404** RESOURCE\_NOT\_FOUND: Access Policy with developer name _{name}_ was not found. ### GET Get access policy rule `GET /ssot/data-governance/access-policies/{name}/rules/{ruleName}` Tags: Data Governance. Returns the details of a specific rule within an access policy. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) Developer name of the parent access policy. **Available Version:** 67.0 * `ruleName` (path, string, required) Developer name of the rule. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyRuleRepresentation`. _Example: example1_ ``` { "id": "0hs8Z000000002mQAA", "name": "Mask_SSN", "label": "Mask SSN", "category": "TRANSFORM_POLICY_RULE_DEFINITION", "effect": "Transform", "action": [ "Read" ], "resourceScopeType": "FIELD", "principalScopeType": "ANY", "resourceDomains": [ "Account__dlm" ], "resourceTransform": "FIRST_N_CHARS_RESOURCE_TRANSFORM", "resourceTransformArguments": [ { "type": "NUMBER", "value": "4" } ], "transformPrecedence": 100 } ``` * **401** INVALID\_SESSION\_ID: Session expired or invalid. * **404** RESOURCE\_NOT\_FOUND or RULE\_NOT\_FOUND For example: * Access Policy with developer name _{name}_ was not found. * Rule _{ruleName}_ was not found in policy _{name}_. ### PUT Replace access policy rule `PUT /ssot/data-governance/access-policies/{name}/rules/{ruleName}` Tags: Data Governance. Overwrites or upserts a single rule within an access policy. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) Developer name of the parent access policy. **Available Version:** 67.0 * `ruleName` (path, string, required) Developer name of the rule. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `AccessPolicyRuleInputRepresentation`. _Example: example1_ ``` { "name": "Mask_SSN", "label": "Mask SSN", "category": "TRANSFORM_POLICY_RULE_DEFINITION", "effect": "Transform", "action": [ "Read" ], "resourceScopeType": "FIELD", "principalScopeType": "ANY", "resourceDomains": [ "Account__dlm" ], "resourceTransform": "FIRST_N_CHARS_RESOURCE_TRANSFORM", "resourceTransformArguments": [ { "type": "NUMBER", "value": "4" } ], "transformPrecedence": 100 } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `AccessPolicyRuleRepresentation`. _Example example1: same as GET /ssot/data-governance/access-policies/{name}/rules/{ruleName} 200 response._ * **400** NAME\_MISMATCH For example: * The rule name in URL and request body must match. * **401** INVALID\_SESSION\_ID: Session expired or invalid. * **403** INSUFFICIENT\_ACCESS: User lacks 'CanAccessCustomerDataCloudAPI' permission. For example, mutation without ModifyAccessPolicies returns "You do not have permission to modify access policies". * **404** RESOURCE\_NOT\_FOUND: Access Policy with developer name _{name}_ was not found. ### GET Get auto-tagging jobs `GET /ssot/data-governance/auto-tagging-jobs` Tags: Data Governance. Returns a paginated list of data governance auto-tagging jobs, optionally filtered by object or status. Auto-tagging jobs are created by the generate tag suggestions action. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of auto-tagging jobs to return. Values are from `5` through `200`. The default value is `25` if unspecified. **Available Version:** 67.0 * `objectName` (query, string) API name of the object to filter jobs by. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `status` (query, string) Status to filter jobs by. Values are `InProgress`, `Success`, or `Fail`. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AutoTaggingJobCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 1, "count": 1, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/auto-tagging-jobs?objectName=Individual_DLO__dll&status=InProgress&limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "jobs": [ { "id": "2dg000000000001", "objectName": "Individual_DLO__dll", "status": "InProgress", "createdDate": "2026-04-26T14:59:02.000Z", "lastModifiedDate": "2026-04-26T14:59:02.000Z" } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. ### GET Get auto-tagging job `GET /ssot/data-governance/auto-tagging-jobs/{id}` Tags: Data Governance. Returns a single data governance auto-tagging job by ID, reporting its progress and status. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the auto-tagging job. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AutoTaggingJobRepresentation`. _Example: example1_ ``` { "id": "2dg000000000001", "objectName": "Individual_DLO__dll", "status": "Success", "createdDate": "2026-04-26T14:59:02.000Z", "lastModifiedDate": "2026-04-26T15:02:18.000Z" } ``` * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. * **404** RESOURCE\_NOT\_FOUND: Auto-tagging job _{id}_ not found. ### GET Get classification assignments `GET /ssot/data-governance/classification-assignments` Tags: Data Governance. Returns a paginated list of data governance classification assignments, optionally filtered by tag or classification. **Available Version:** 67.0 #### Parameters * `classificationFullyQualifiedName` (query, string) Fully-qualified API name of the classification to filter assignments by. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of classification assignments to return. Values are from `5` through `200`. The default value is `25` if unspecified. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `tagFullyQualifiedName` (query, string) Fully-qualified API name of the tag to filter assignments by. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationAssignmentCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/classification-assignments?tagFullyQualifiedName=Compliance_Tags.PII.Email&limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "classificationAssignments": [ { "id": "9aa000000000050", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address" } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **404** RESOURCE\_NOT\_FOUND: Tag _{tagFullyQualifiedName}_ not found. ### POST Create classification assignment `POST /ssot/data-governance/classification-assignments` Tags: Data Governance. Creates a single data governance classification assignment. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationAssignmentCreateItemInputRepresentation`. _Example: example1_ ``` { "classificationFullyQualifiedName": "Compliance_Classifications.PII", "tagFullyQualifiedName": "Compliance_Tags.PII.Email" } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `ClassificationAssignmentRepresentation`. _Example: example1_ ``` { "id": "9aa000000000050", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address" } ``` * **400** MISSING\_ARGUMENT For example: * A _classificationFullyQualifiedName_ is required. * Input representation is required. * **404** RESOURCE\_NOT\_FOUND: Tag _{tagFullyQualifiedName}_ not found. ### GET Get classification assignment `GET /ssot/data-governance/classification-assignments/{id}` Tags: Data Governance. Returns a single data governance classification assignment by ID. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the classification assignment. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationAssignmentRepresentation`. _Example example1: same as POST /ssot/data-governance/classification-assignments 201 response._ * **404** RESOURCE\_NOT\_FOUND: Classification assignment _{id}_ not found. ### DELETE Delete classification assignment `DELETE /ssot/data-governance/classification-assignments/{id}` Tags: Data Governance. Deletes a data governance classification assignment by ID. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the classification assignment. **Available Version:** 67.0 #### Responses * **202** Success * **404** RESOURCE\_NOT\_FOUND: Classification assignment _{id}_ not found. ### POST Bulk create classification assignments `POST /ssot/data-governance/classification-assignments/actions/bulk-create` Tags: Data Governance. Bulk creates data governance classification assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationAssignmentBulkCreateInputRepresentation`. _Example: example1_ ``` { "assignments": [ { "classificationFullyQualifiedName": "Compliance_Classifications.PII", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.Email", "Compliance_Tags.PII.CreditCard", "Compliance_Tags.PII.Phone" ] }, { "classificationFullyQualifiedName": "Compliance_Classifications.Sensitive", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.CreditCard" ] } ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "id": "9aa000000000050", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address" } }, { "statusCode": 201, "result": { "id": "9aa000000000051", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000043", "tagName": "CreditCard", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "tagLabel": "Credit Card Number", "tagFullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number" } }, { "statusCode": 201, "result": { "id": "9aa000000000052", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "tagId": "9ae000000000044", "tagName": "Phone", "tagFullyQualifiedName": "Compliance_Tags.PII.Phone" } }, { "statusCode": 201, "result": { "id": "9aa000000000053", "classificationId": "9ae000000000011", "classificationName": "Sensitive", "classificationFullyQualifiedName": "Compliance_Classifications.Sensitive", "tagId": "9ae000000000043", "tagName": "CreditCard", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard" } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete classification assignments `POST /ssot/data-governance/classification-assignments/actions/bulk-delete` Tags: Data Governance. Bulk deletes data governance classification assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationAssignmentBulkDeleteInputRepresentation`. _Example: example1_ ``` { "ids": [ "9aa000000000050", "9aa000000000053" ] } ``` #### Responses * **202** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 204, "result": null }, { "statusCode": 204, "result": null } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### GET Get classification taxonomies `GET /ssot/data-governance/classification-taxonomies` Tags: Data Governance. Returns a paginated list of classification taxonomies. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of classification taxonomies to return. Must be between `5` and `200`. If unspecified, the default value is `25`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, the default value is `ASC` ordered by developer name. **Available Version:** 67.0 * `searchString` (query, string) Search keyword to match against the developer name or label. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 1, "count": 1, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/classification-taxonomies?limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "taxonomies": [ { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:10.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T18:22:10.000Z", "description": "Sensitivity and compliance classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 2 } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Invalid orderBy field. Valid fields: Label, DeveloperName. ### POST Create classification taxonomy `POST /ssot/data-governance/classification-taxonomies` Tags: Data Governance. Creates a classification taxonomy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyCreateInputRepresentation`. _Example: example1_ ``` { "label": "Compliance Classifications", "description": "Sensitivity and compliance classifications." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:10.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T18:22:10.000Z", "description": "Sensitivity and compliance classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 0 } ``` * **400** INVALID\_INPUT or MISSING\_ARGUMENT For example: * Classification taxonomy name must be a single DeveloperName (managed-package namespace prefix permitted); must not contain `.` * A classification taxonomy with this label already exists. * Name is required. ### GET Get classification taxonomy `GET /ssot/data-governance/classification-taxonomies/{name}` Tags: Data Governance. Returns a classification taxonomy by its API name. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) API name or developer name of the classification taxonomy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:10.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T18:22:10.000Z", "description": "Sensitivity and compliance classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 2 } ``` * **404** RESOURCE\_NOT\_FOUND: Classification taxonomy _{name}_ not found. ### DELETE Delete classification taxonomy `DELETE /ssot/data-governance/classification-taxonomies/{name}` Tags: Data Governance. Deletes a classification taxonomy. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) API name or developer name of the classification taxonomy. **Available Version:** 67.0 #### Responses * **202** Success * **400** INVALID\_OPERATION For example: * Cannot delete system classification taxonomy. * Entity is already being deleted. * **404** RESOURCE\_NOT\_FOUND: Classification taxonomy _{name}_ not found. * **412** REFERENTIAL\_INTEGRITY\_VIOLATION: Cannot delete — has external dependencies or children classifications. ### PATCH Update classification taxonomy `PATCH /ssot/data-governance/classification-taxonomies/{name}` Tags: Data Governance. Updates a classification taxonomy. Omitted fields are left unchanged. **Available Version:** 67.0 #### Parameters * `name` (path, string, required) API name or developer name of the classification taxonomy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyPatchInputRepresentation`. _Example: example1_ ``` { "description": "Sensitivity and compliance classifications for regulated workloads." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:10.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-28T09:20:05.000Z", "description": "Sensitivity and compliance classifications for regulated workloads.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 2 } ``` * **400** INVALID\_INPUT, INVALID\_OPERATION, or MISSING\_ARGUMENT For example: * A classification taxonomy with this label already exists. * Cannot update entity in Deleting state. * Input representation is required. * **404** RESOURCE\_NOT\_FOUND: Classification taxonomy _{name}_ not found. ### POST Bulk create classification taxonomies `POST /ssot/data-governance/classification-taxonomies/actions/bulk-create` Tags: Data Governance. Creates multiple classification taxonomies in a single request. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkCreateInputRepresentation`. _Example: example1_ ``` { "taxonomies": [ { "name": "Compliance_Classifications", "label": "Compliance Classifications", "description": "Sensitivity classifications." }, { "name": "Data_Residency_Classifications", "label": "Data Residency Classifications", "description": "Region-of-origin classifications." } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "description": "Sensitivity classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 0 } }, { "statusCode": 201, "result": { "id": "9as000000000003", "name": "Data_Residency_Classifications", "label": "Data Residency Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Data_Residency_Classifications", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "description": "Region-of-origin classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 0 } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete classification taxonomies `POST /ssot/data-governance/classification-taxonomies/actions/bulk-delete` Tags: Data Governance. Deletes multiple classification taxonomies in a single request. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkDeleteInputRepresentation`. _Example: example1_ ``` { "names": [ "Compliance_Classifications", "Data_Residency_Classifications" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 204, "result": null }, { "statusCode": 204, "result": null } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk update classification taxonomies `POST /ssot/data-governance/classification-taxonomies/actions/bulk-update` Tags: Data Governance. Updates multiple classification taxonomies in a single request. Omitted fields are left unchanged. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkUpdateInputRepresentation`. _Example: example1_ ``` { "items": [ { "name": "Compliance_Classifications", "label": "Compliance Classifications (GA)" }, { "name": "Data_Residency_Classifications", "description": "Data residency and sovereignty classifications." } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 200, "result": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications (GA)", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Compliance_Classifications", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "description": "Sensitivity classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 0 } }, { "statusCode": 200, "result": { "id": "9as000000000003", "name": "Data_Residency_Classifications", "label": "Data Residency Classifications", "url": "/services/data/v68.0/ssot/data-governance/classification-taxonomies/Data_Residency_Classifications", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "description": "Data residency and sovereignty classifications.", "taxonomyKind": "Classification", "type": "Custom", "state": "Active", "childCount": 0 } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### GET Get classifications `GET /ssot/data-governance/classifications` Tags: Data Governance. Returns a paginated list of classifications across all classification taxonomies. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of classifications to return from `5` through `200`. If unspecified, the default number of rows is `25`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified,the default value is `ASC` ordered by developer name. **Available Version:** 67.0 * `parentClassificationFullyQualifiedName` (query, string) Fully-qualified API name of the parent classification. Scopes the list to direct children. **Available Version:** 67.0 * `searchString` (query, string) Search keyword to match against the developer name or label. **Available Version:** 67.0 * `taxonomyName` (query, string) Fully-qualified API name of the classification taxonomy (for example, `Compliance_Classifications`). Scopes the list to classifications under that taxonomy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/classifications?taxonomyName=Compliance_Classifications&limit=25&offset=0&orderBy=DeveloperName+ASC", "nextPageUrl": null, "previousPageUrl": null, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T19:03:18.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T19:03:18.000Z", "fullyQualifiedLabel": "Compliance Classifications.PII", "description": "Personally identifiable information.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address", "type": "Custom" }, { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "type": "Custom" } ] }, { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.Sensitive", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T19:03:25.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T19:03:25.000Z", "fullyQualifiedLabel": "Compliance Classifications.Sensitive", "description": "Sensitive data requiring handling controls.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "type": "Custom" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Invalid orderBy field. Valid fields: Label, DeveloperName. * **404** RESOURCE\_NOT\_FOUND: Classification _{parentClassificationFullyQualifiedName}_ not found. ### POST Create classification `POST /ssot/data-governance/classifications` Tags: Data Governance. Creates a classification under a specified classification taxonomy, with optional initial tag links. If a tag link fails, the classification is still created and the failed tag link is reported. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationCreateInputRepresentation`. _Example: example1_ ``` { "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "description": "Personally identifiable information.", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.Email", "Compliance_Tags.PII.CreditCard" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationRepresentation`. _Example: example1_ ``` { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T19:03:18.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T19:03:18.000Z", "fullyQualifiedLabel": "Compliance Classifications.PII", "description": "Personally identifiable information.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address", "type": "Custom" }, { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "type": "Custom" } ] } ``` * **400** INVALID\_INPUT or MISSING\_ARGUMENT For example: * Classification _fullyQualifiedName_ must be 2 or 3 segments: .\[.\] * A classification with this API name already exists * Input representation is required. RESOURCE\_NOT\_FOUND * **404** RESOURCE\_NOT\_FOUND: Classification taxonomy _{taxonomySegment}_ not found. ### GET Get classification `GET /ssot/data-governance/classifications/{fullyQualifiedName}` Tags: Data Governance. Returns a classification by its fully-qualified API name. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the classification. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationRepresentation`. _Example example1: same as POST /ssot/data-governance/classifications 200 response._ * **404** RESOURCE\_NOT\_FOUND: Classification _{fullyQualifiedName}_ not found. ### DELETE Delete classification `DELETE /ssot/data-governance/classifications/{fullyQualifiedName}` Tags: Data Governance. Deletes a classification and cascades the deletion to any child classifications and assignments. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the classification. **Available Version:** 67.0 #### Responses * **202** Success * **400** INVALID\_OPERATION For example: * Cannot delete system classification. * Entity is already being deleted. * **404** RESOURCE\_NOT\_FOUND: Classification _{fullyQualifiedName}_ not found. * **412** REFERENTIAL\_INTEGRITY\_VIOLATION: Cannot delete — has external dependencies or children classifications. ### PATCH Update classification `PATCH /ssot/data-governance/classifications/{fullyQualifiedName}` Tags: Data Governance. Updates a classification. Omitted fields are left unchanged. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the classification. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationPatchInputRepresentation`. _Example: example1_ ``` { "description": "Personally identifiable information — covers direct and indirect identifiers.", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.Email", "Compliance_Tags.PII.CreditCard", "Compliance_Tags.PII.Phone" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationRepresentation`. _Example: example1_ ``` { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T19:03:18.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-28T10:45:30.000Z", "fullyQualifiedLabel": "Compliance Classifications.PII", "description": "Personally identifiable information — covers direct and indirect identifiers.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address", "type": "Custom" }, { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "type": "Custom" }, { "id": "9ae000000000044", "name": "Phone", "fullyQualifiedName": "Compliance_Tags.PII.Phone", "label": "Phone Number", "fullyQualifiedLabel": "Compliance Tags.PII.Phone Number", "type": "Custom" } ] } ``` * **400** INVALID\_INPUT, INVALID\_OPERATION, or MISSING\_ARGUMENT For example: * A classification with this label already exists. * Referenced tag must be in the same taxonomy. * Cannot update entity in Deleting state. * **404** RESOURCE\_NOT\_FOUND: Classification _{fullyQualifiedName}_ not found. ### GET Get classification assignments on a classification `GET /ssot/data-governance/classifications/{fullyQualifiedName}/assignments` Tags: Data Governance. Returns a paginated list of assignments for a specific classification, including all linked tags. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of classification assignments to return. Values are from `5` through `200`. The default value is `25` if unspecified. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the classification (dotted path). **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `ClassificationAssignmentCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII/assignments?limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "classificationAssignments": [ { "id": "9aa000000000050", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address" }, { "id": "9aa000000000051", "classificationId": "9ae000000000010", "classificationName": "PII", "classificationFullyQualifiedName": "Compliance_Classifications.PII", "classificationLabel": "PII", "classificationFullyQualifiedLabel": "Compliance Classifications.PII", "tagId": "9ae000000000043", "tagName": "CreditCard", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "tagLabel": "Credit Card Number", "tagFullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number" } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **404** RESOURCE\_NOT\_FOUND: Classification _{fullyQualifiedName}_ not found. ### POST Bulk create classifications `POST /ssot/data-governance/classifications/actions/bulk-create` Tags: Data Governance. Creates multiple classifications in a single request. Maximum of 200 items per request. If a tag link fails for an item, the classification is still created. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationBulkCreateInputRepresentation`. _Example: example1_ ``` { "classifications": [ { "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "description": "Personally identifiable information." }, { "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "description": "Sensitive data requiring handling controls.", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.CreditCard" ] } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "fullyQualifiedLabel": "Compliance Classifications.PII", "description": "Personally identifiable information.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [] } }, { "statusCode": 201, "result": { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.Sensitive", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "fullyQualifiedLabel": "Compliance Classifications.Sensitive", "description": "Sensitive data requiring handling controls.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "label": "Compliance Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "type": "Custom" } ] } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete classifications `POST /ssot/data-governance/classifications/actions/bulk-delete` Tags: Data Governance. Deletes multiple classifications in a single request, cascading each deletion to its child classifications and assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationBulkDeleteInputRepresentation`. _Example: example1_ ``` { "fullyQualifiedNames": [ "Compliance_Classifications.Sensitive" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 204, "result": null } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk update classifications `POST /ssot/data-governance/classifications/actions/bulk-update` Tags: Data Governance. Updates multiple classifications in a single request. Omitted fields are left unchanged. Tag validation runs against the state before the batch operation. If a tag link fails, the classification is updated, but the tag link change is not applied, and an error is reported **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ClassificationBulkUpdateInputRepresentation`. _Example: example1_ ``` { "items": [ { "fullyQualifiedName": "Compliance_Classifications.PII", "description": "All PII classifications." }, { "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive Data" }, { "fullyQualifiedName": "Compliance_Classifications.Restricted", "tagFullyQualifiedNames": [ "Compliance_Tags.PII.SSN", "Compliance_Tags.PII.CreditCard" ] } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 200, "result": { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.PII", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "description": "All PII classifications.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [] } }, { "statusCode": 200, "result": { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive Data", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.Sensitive", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [] } }, { "statusCode": 200, "result": { "id": "9ae000000000012", "name": "Restricted", "fullyQualifiedName": "Compliance_Classifications.Restricted", "label": "Restricted", "url": "/services/data/v68.0/ssot/data-governance/classifications/Compliance_Classifications.Restricted", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000002", "name": "Compliance_Classifications", "taxonomyKind": "Classification", "type": "Custom" }, "parentClassification": null, "tags": [ { "id": "9ae000000000060", "fullyQualifiedName": "Compliance_Tags.PII.SSN", "label": "SSN", "type": "Custom" }, { "id": "9ae000000000043", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "type": "Custom" } ] } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### GET Get object access grants `GET /ssot/data-governance/object-access-grants` Tags: Data Governance. Returns a paginated list of object access grants, with optional filters. Providing only a permission set name returns all associated grants across data spaces and objects. Providing only a data space name returns all grants for objects within that data space across all permission sets. Providing only an object name returns all permission sets that grant access to that object. **Available Version:** 67.0 #### Parameters * `dataSpaceName` (query, string) Developer name of the data space to filter grants by. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of object access grants to return. Values are `5` through `200`. If unspecified, the default value is `25`. **Available Version:** 67.0 * `objectApiName` (query, string) API name of the DMO, DLO, or CIO object to filter grants by. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `permissionSetName` (query, string) Developer name of the permission set or permission set group to filter grants by. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataGovernanceObjectAccessGrantCollectionRepresentation`. _Example: example1_ ``` { "grants": [ { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiName": "Account__dlm" }, { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiName": "Contact__dlm" } ], "totalSize": 2, "count": 2, "limit": 200, "offset": 0, "currentPageUrl": "/services/data/v67.0/ssot/data-governance/object-access-grants?permissionSetName=DC_Analyst_PermSet&dataSpaceName=default&limit=200&offset=0", "nextPageUrl": null } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * limit must be between 5 and 200. * offset must be non-negative. ### POST Create object access grant `POST /ssot/data-governance/object-access-grants` Tags: Data Governance. Creates a single object access grant using an idempotent request. If a matching grant already exists, the API returns the existing record; otherwise, it creates and returns a new grant. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ObjectAccessGrantCreateInputRepresentation`. _Example: example1_ ``` { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiName": "Account__dlm" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataGovernanceObjectAccessGrantRepresentation`. _Example: example1_ ``` { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiName": "Account__dlm" } ``` * **400** MISSING\_ARGUMENT, INVALID\_INPUT, or INVALID\_INPUT\_COMBINATION For example: * Input representation is required. * permissionSetName, dataspaceName and atleast one objectApiName is Mandatory. * permissionSetName is required. * dataspaceName is required. * objectApiName is required. * There is no Permission Set {permissionSetName} with assigned Dataspace {dataspaceName}. * **403** INSUFFICIENT\_ACCESS: You do not have permission to modify access of Dataspace Objects through PermissionSet page. ### GET Get object access grant `GET /ssot/data-governance/object-access-grants/{objectApiName}` Tags: Data Governance. Returns a single object access grant. **Available Version:** 67.0 #### Parameters * `objectApiName` (path, string, required) API name of the Data Cloud object. **Available Version:** 67.0 * `dataSpaceName` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 67.0 * `permissionSetName` (query, string) Developer name of the permission set. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataGovernanceObjectAccessGrantRepresentation`. _Example: example1_ ``` { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiName": "Account__dlm" } ``` * **404** RESOURCE\_NOT\_FOUND: There is no grant for _{objectApiName}_ found for Dataspace _{dataSpaceName}_ and Permission set _{permissionSetName}_. ### DELETE Delete object access grant `DELETE /ssot/data-governance/object-access-grants/{objectApiName}` Tags: Data Governance. Deletes a single object access grant. **Available Version:** 67.0 #### Parameters * `objectApiName` (path, string, required) API name of the Data Cloud object. **Available Version:** 67.0 * `dataSpaceName` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 67.0 * `permissionSetName` (query, string) Developer name of the permission set. **Available Version:** 67.0 #### Responses * **204** Success * **403** INSUFFICIENT\_ACCESS: You do not have permission to modify access of Dataspace Objects through PermissionSet page. * **404** RESOURCE\_NOT\_FOUND: There is no grant for _{objectApiName}_ found for Dataspace _{dataSpaceName}_ and Permission set _{permissionSetName}_. ### POST Bulk create object access grants `POST /ssot/data-governance/object-access-grants/actions/bulk-create` Tags: Data Governance. Creates multiple object access grants for a single combination of a data space and a permission set using an idempotent request. A request supports a maximum of 200 items. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ObjectAccessGrantBulkCreateInputRepresentation`. _Example: example1_ ``` { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiNames": [ "Account__dlm", "Contact__dlm", "revenue_insights__cio" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataGovernanceObjectAccessGrantBulkCreateResultRepresentation`. _Example: example1_ ``` { "results": [ { "result": { "objectApiName": "Account__dlm", "permissionSetName": "DC_Analyst_PermSet", "dataspaceName": "default" }, "statusCode": "201" }, { "result": { "objectApiName": "Contact__dlm", "permissionSetName": "DC_Analyst_PermSet", "dataspaceName": "default" }, "statusCode": "201" } ], "hasErrors": false } ``` * **400** MISSING\_ARGUMENT or INVALID\_INPUT\_COMBINATION For example: * Input representation is required. * At least one item is required. * Maximum 200 items per request. Per-item failures are returned in `results[i].result` as a list of errors, with a 4xx `statusCode` for that item. For example, an item can return INVALID\_INPUT ("permissionSetName is required") or INVALID\_INPUT\_COMBINATION ("There is no Permission Set {permissionSetName} with assigned Dataspace {dataspaceName}"). * **403** INSUFFICIENT\_ACCESS: You do not have permission to modify access of Dataspace Objects through PermissionSet page. ### POST Bulk delete object access grants `POST /ssot/data-governance/object-access-grants/actions/bulk-delete` Tags: Data Governance. Deletes multiple object access grants for a single combination of a data space and a permission set using an idempotent request. If a specified grant doesn't exist, no action is taken for that item. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `ObjectAccessGrantBulkDeleteInputRepresentation`. _Example: example1_ ``` { "permissionSetName": "DC_Analyst_PermSet", "dataSpaceName": "default", "objectApiNames": [ "Account__dlm", "revenue_insights__cio" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataGovernanceObjectAccessGrantBulkDeleteResultRepresentation`. _Example: example1_ ``` { "results": [ { "result": null, "statusCode": "204" }, { "result": null, "statusCode": "204" } ], "hasErrors": false } ``` * **400** MISSING\_ARGUMENT or INVALID\_INPUT\_COMBINATION For example: * Input representation is required. * At least one item is required. * Maximum 200 items per request. Per-item failures are returned in `results[i].result` as a list of errors, with a 4xx `statusCode` for that item. For example, an item can return RESOURCE\_NOT\_FOUND ("There is no grant for {objectApiName} found for Dataspace {dataspaceName} and Permission set {permissionSetName}") or INVALID\_INPUT\_COMBINATION ("Duplicate identifier in request"). * **403** INSUFFICIENT\_ACCESS: You do not have permission to modify access of Dataspace Objects through PermissionSet page. ### GET Get tag assignments `GET /ssot/data-governance/tag-assignments` Tags: Data Governance. Returns a paginated list of data governance tag assignments for a given object, with optional field filtering. **Available Version:** 67.0 #### Parameters * `fieldName` (query, string) API name of the field to filter tag assignments by. **Available Version:** 67.0 * `limit` (query, integer) Maximum number of tag assignments to return. Values are from `5` through `200`. The default value is `25` if unspecified. **Available Version:** 67.0 * `objectName` (query, string) API name of the object to filter tag assignments by. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `tagFullyQualifiedName` (query, string) Fully-qualified API name of the tag to filter assignments by. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagAssignmentCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tag-assignments?objectName=Individual_DLO__dll&limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "tagAssignments": [ { "id": "9aa000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Individual_DLO__dll", "objectLabel": "Individual", "fieldName": "Email", "fieldLabel": "Email" }, { "id": "9aa000000000004", "tagId": "9ae000000000044", "tagName": "Phone", "tagFullyQualifiedName": "Compliance_Tags.PII.Phone", "tagLabel": "Phone Number", "tagFullyQualifiedLabel": "Compliance Tags.PII.Phone Number", "objectName": "Individual_DLO__dll", "objectLabel": "Individual", "fieldName": "Phone", "fieldLabel": "Phone" } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * The _fieldName_ requires an _objectName_. * **404** RESOURCE\_NOT\_FOUND: Object _{objectName}_ not found. ### POST Create tag assignment `POST /ssot/data-governance/tag-assignments` Tags: Data Governance. Creates a single data governance tag assignment. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagAssignmentCreateItemInputRepresentation`. _Example: example1_ ``` { "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "objectName": "Individual_DLO__dll", "fieldName": "Email" } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `TagAssignmentRepresentation`. _Example: example1_ ``` { "id": "9aa000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Individual_DLO__dll", "objectLabel": "Individual", "fieldName": "Email", "fieldLabel": "Email" } ``` * **400** MISSING\_ARGUMENT For example: * A _tagFullyQualifiedName_ is required. * Input representation is required * **404** RESOURCE\_NOT\_FOUND: Object _{objectName}_ not found. ### GET Get tag assignment `GET /ssot/data-governance/tag-assignments/{id}` Tags: Data Governance. Returns a single data governance tag assignment by ID. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the tag assignment. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagAssignmentRepresentation`. _Example example1: same as POST /ssot/data-governance/tag-assignments 201 response._ * **404** RESOURCE\_NOT\_FOUND: Tag assignment _{id}_ not found. ### DELETE Delete tag assignment `DELETE /ssot/data-governance/tag-assignments/{id}` Tags: Data Governance. Deletes a data governance tag assignment by ID. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the tag assignment. **Available Version:** 67.0 #### Responses * **202** Success * **404** RESOURCE\_NOT\_FOUND: Tag assignment _{id}_ not found. ### POST Bulk create tag assignments `POST /ssot/data-governance/tag-assignments/actions/bulk-create` Tags: Data Governance. Bulk creates data governance tag assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagAssignmentBulkCreateInputRepresentation`. _Example: example1_ ``` { "assignments": [ { "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "targets": [ { "objectName": "Individual_DLO__dll", "fieldName": "Email" }, { "objectName": "Contact_DLO__dll", "fieldName": "PersonalEmail" } ] }, { "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "targets": [ { "objectName": "Payment_DLO__dll", "fieldName": "CardPAN" }, { "objectName": "Unknown_DLO__dll", "fieldName": "Bogus" } ] } ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 201, "result": { "id": "9aa000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "objectName": "Individual_DLO__dll", "fieldName": "Email", "url": "/services/data/v68.0/ssot/data-governance/tag-assignments/9aa000000000001" } }, { "statusCode": 201, "result": { "id": "9aa000000000002", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "objectName": "Contact_DLO__dll", "fieldName": "PersonalEmail", "url": "/services/data/v68.0/ssot/data-governance/tag-assignments/9aa000000000002" } }, { "statusCode": 201, "result": { "id": "9aa000000000003", "tagId": "9ae000000000043", "tagName": "CreditCard", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "tagLabel": "Credit Card Number", "objectName": "Payment_DLO__dll", "fieldName": "CardPAN", "url": "/services/data/v68.0/ssot/data-governance/tag-assignments/9aa000000000003" } }, { "statusCode": 400, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Object 'Unknown_DLO__dll' not found" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete tag assignments `POST /ssot/data-governance/tag-assignments/actions/bulk-delete` Tags: Data Governance. Bulk deletes data governance tag assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagAssignmentBulkDeleteInputRepresentation`. _Example: example1_ ``` { "ids": [ "9aa000000000001", "9aa000000000002", "9aa000000099999" ] } ``` #### Responses * **202** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 204, "result": null }, { "statusCode": 204, "result": null }, { "statusCode": 400, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Tag assignment '9aa000000099999' not found" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### GET Get tag suggestions `GET /ssot/data-governance/tag-suggestions` Tags: Data Governance. Returns a paginated list of AI-generated data governance tag suggestions, optionally filtered by object, tag, or status. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of tag suggestions to return. **Available Version:** 67.0 * `objectName` (query, string) API name of the object to filter suggestions by. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `status` (query, string) Status to filter suggestions by. **Available Version:** 67.0 * `tagFullyQualifiedName` (query, string) Fully-qualified API name of the tag to filter suggestions by. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagSuggestionCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tag-suggestions?objectName=Individual_DLO__dll&status=New&limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "suggestions": [ { "id": "1dg000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Individual_DLO__dll", "fieldName": null, "status": "New", "score": 0.92, "createdDate": "2026-04-26T15:02:18.000Z", "processedBy": null, "processedDate": null }, { "id": "1dg000000000002", "tagId": "9ae000000000044", "tagName": "Phone", "tagFullyQualifiedName": "Compliance_Tags.PII.Phone", "tagLabel": "Phone Number", "tagFullyQualifiedLabel": "Compliance Tags.PII.Phone Number", "objectName": "Individual_DLO__dll", "fieldName": null, "status": "New", "score": 0.81, "createdDate": "2026-04-26T15:02:18.000Z", "processedBy": null, "processedDate": null } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. * **404** RESOURCE\_NOT\_FOUND: Tag _{tagFullyQualifiedName}_ not found. ### GET Get tag suggestion `GET /ssot/data-governance/tag-suggestions/{id}` Tags: Data Governance. Returns a single AI-generated tag suggestion by ID. **Available Version:** 67.0 #### Parameters * `id` (path, string, required) ID of the tag suggestion. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagSuggestionRepresentation`. _Example: example1_ ``` { "id": "5ts000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Individual_DLO__dll", "fieldName": null, "status": "New", "score": 0.92, "createdDate": "2026-04-26T15:02:18.000Z", "processedBy": null, "processedDate": null } ``` * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. * **404** RESOURCE\_NOT\_FOUND: Tag suggestion _{id}_ not found. ### POST Approve tag suggestions `POST /ssot/data-governance/tag-suggestions/actions/approve` Tags: Data Governance. Approves one or more tag suggestions. Each item returns status code 200 on success, 404 if the suggestion isn't found, or 400 if the suggestion is in a terminal state. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `BulkIdInputRepresentation`. _Example: example1_ ``` { "ids": [ "1dg000000000001", "1dg000000000002", "1dg000000099999" ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 200, "result": { "id": "5ts000000000001", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "objectName": "Individual_DLO__dll", "status": "Approved", "score": 0.92, "processedBy": { "id": "005000000000001", "name": "Dana Patel" }, "processedDate": "2026-04-29T15:01:00.000Z", "assignmentId": "9aa000000000100" } }, { "statusCode": 200, "result": { "id": "5ts000000000002", "tagFullyQualifiedName": "Compliance_Tags.PII.Phone", "objectName": "Individual_DLO__dll", "status": "Approved", "score": 0.87, "processedBy": { "id": "005000000000001", "name": "Dana Patel" }, "processedDate": "2026-04-29T15:01:00.000Z", "assignmentId": "9aa000000000101" } }, { "statusCode": 400, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Tag suggestion '5ts000000099999' not found" } ] } ] } ``` * **400** INVALID\_OPERATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. ### POST Generate tag suggestions `POST /ssot/data-governance/tag-suggestions/actions/generate` Tags: Data Governance. Launches asynchronous AI-driven tag suggestion jobs for one or more objects. Returns per-object job IDs. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `SuggestTagsInputRepresentation`. _Example: example1_ ``` { "objectNames": [ "Individual_DLO__dll", "Account_DLO__dll" ], "taxonomyNames": [ "Compliance_Tags" ] } ``` #### Responses * **202** Success Media type: `application/json`. Schema: `SuggestTagsResultRepresentation`. _Example: example1_ ``` { "jobs": [ { "objectName": "Individual_DLO__dll", "jobId": "2dg000000000001" }, { "objectName": "Account_DLO__dll", "jobId": "2dg000000000002" } ] } ``` * **400** INVALID\_OPERATION, ENTITY\_IS\_LOCKED, or MISSING\_ARGUMENT For example: * Maximum 20 objects per request. * An auto-tagging job is already in progress for object. * At least one taxonomy is required. * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{taxonomyName}_ not found. * **429** REQUEST\_LIMIT\_EXCEEDED: Too many auto-tagging jobs in progress. Org limit: _MaxConcurrentAutoTagJobs org value_ (default 100, configurable by Salesforce via BT admin). ### POST Reject tag suggestions `POST /ssot/data-governance/tag-suggestions/actions/reject` Tags: Data Governance. Rejects one or more tag suggestions. Each item returns status code 200 on success, 404 if the suggestion isn't found, or 400 if the suggestion is in a terminal state. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `BulkIdInputRepresentation`. _Example: example1_ ``` { "ids": [ "1dg000000000003", "1dg000000000004" ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 200, "result": { "id": "5ts000000000003", "status": "Rejected", "processedBy": { "id": "005000000000001", "name": "Dana Patel" }, "processedDate": "2026-04-29T15:01:00.000Z" } }, { "statusCode": 200, "result": { "id": "5ts000000000004", "status": "Rejected", "processedBy": { "id": "005000000000001", "name": "Dana Patel" }, "processedDate": "2026-04-29T15:01:00.000Z" } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. * **403** INSUFFICIENT\_ACCESS: GovernanceAiSuggestTags permission required. ### GET List tag taxonomies `GET /ssot/data-governance/tag-taxonomies` Tags: Data Governance. Returns a paginated list of tag taxonomies. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of tag taxonomies to return. Must be between `5` and `200`. If unspecified, the default value is `25`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, the default value is `ASC` ordered by developer name. **Available Version:** 67.0 * `searchString` (query, string) Search keyword to match against the developer name or label. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tag-taxonomies?limit=25&offset=0&orderBy=DeveloperName+ASC", "nextPageUrl": null, "previousPageUrl": null, "taxonomies": [ { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:05.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-03T11:07:41.000Z", "description": "Compliance-related tags (PII, financial, health).", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 1 }, { "id": "9as000000000099", "name": "FinancialData", "label": "Financial Data", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/FinancialData", "createdBy": { "id": "005000000000099", "name": "System", "profilePhotoUrl": "/services/images/photo/005000000000099" }, "createdDate": "2026-01-01T00:00:00.000Z", "lastModifiedBy": { "id": "005000000000099", "name": "System", "profilePhotoUrl": "/services/images/photo/005000000000099" }, "lastModifiedDate": "2026-01-01T00:00:00.000Z", "description": "Standard (OOTB) financial-data tags.", "taxonomyKind": "Tag", "type": "System", "state": "Active", "childCount": 4 } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Invalid orderBy field. Valid fields: Label, DeveloperName. ### POST Create tag taxonomy `POST /ssot/data-governance/tag-taxonomies` Tags: Data Governance. Creates a top-level tag taxonomy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyCreateInputRepresentation`. _Example: example1_ ``` { "label": "Compliance Tags", "description": "Compliance-related tags (PII, financial, health)." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:05.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-14T18:22:05.000Z", "description": "Compliance-related tags (PII, financial, health).", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } ``` * **400** INVALID\_INPUT or MISSING\_ARGUMENT For example: * Tag taxonomy name must be a single DeveloperName (managed-package namespace prefix permitted); must not contain `.` * A tag taxonomy with this label already exists. * Name is required. ### GET Get tag taxonomy `GET /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` Tags: Data Governance. Returns a tag taxonomy by its fully qualified API name. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag taxonomy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:05.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-03T11:07:41.000Z", "description": "Compliance-related tags (PII, financial, health).", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 1 } ``` * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{fullyQualifiedName}_ not found. ### DELETE Delete tag taxonomy `DELETE /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` Tags: Data Governance. Deletes a tag taxonomy and all child tags. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag taxonomy. **Available Version:** 67.0 #### Responses * **202** Success * **400** INVALID\_OPERATION For example: * Cannot delete system tag taxonomy. * Entity is already being deleted. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{fullyQualifiedName}_ not found. * **412** REFERENTIAL\_INTEGRITY\_VIOLATION: Cannot delete — has external dependencies or children tags. ### PATCH Update tag taxonomy `PATCH /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}` Tags: Data Governance. Updates a tag taxonomy. Omitted fields are left unchanged. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag taxonomy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyPatchInputRepresentation`. _Example: example1_ ``` { "label": "Compliance Tags (GA)", "description": "Compliance-related tags — PII, financial, and health indicators." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TaxonomyRepresentation`. _Example: example1_ ``` { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags (GA)", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-14T18:22:05.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-28T09:15:22.000Z", "description": "Compliance-related tags — PII, financial, and health indicators.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 1 } ``` * **400** INVALID\_INPUT, INVALID\_OPERATION, or MISSING\_ARGUMENT For example: * A tag taxonomy with this label already exists. * Cannot update entity in Deleting state. * Input representation is required. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{fullyQualifiedName}_ not found. ### POST Bulk create tag detection instructions `POST /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}/detection-instructions/actions/bulk-create` Tags: Data Governance. Bulk creates active detection instructions for multiple tags under one taxonomy. Each item creates or replaces the active instruction for one tag. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag taxonomy. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagDetectionInstructionBulkCreateInputRepresentation`. _Example: example1_ ``` { "detectionInstructions": [ { "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "instructionTxt": "Detect credit card numbers: 16-digit Luhn-valid sequences, card-type prefixes." }, { "tagFullyQualifiedName": "Compliance_Tags.PII.SSN", "instructionTxt": "Detect US Social Security Numbers: NNN-NN-NNNN format or 9-digit numeric sequences." } ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "id": "9di000000000002", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "version": 2, "instructionTxt": "Detect credit card numbers: 16-digit Luhn-valid sequences, card-type prefixes.", "isActive": true, "offCoreSyncState": "NotSynced", "lastSyncedDate": null, "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard/detection-instructions/active", "createdDate": "2026-06-15T11:00:00.000Z" } }, { "statusCode": 201, "result": { "id": "9di000000000003", "tagFullyQualifiedName": "Compliance_Tags.PII.SSN", "version": 1, "instructionTxt": "Detect US Social Security Numbers: NNN-NN-NNNN format or 9-digit numeric sequences.", "isActive": true, "offCoreSyncState": "NotSynced", "lastSyncedDate": null, "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.SSN/detection-instructions/active", "createdDate": "2026-06-15T11:00:00.000Z" } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per bulk request. * A _tagFullyQualifiedName_ is required. * An _instructionTxt_ is required and must be at most 100 characters. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{fullyQualifiedName}_ not found. ### GET Get tags with active detection instructions `GET /ssot/data-governance/tag-taxonomies/{fullyQualifiedName}/tags-with-active-detection-instructions` Tags: Data Governance. Returns a paginated list of tags in a taxonomy along with their active detection instruction, if any. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of tags to return. Values are from `5` through `200`. The default value is `25` if unspecified. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag taxonomy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagWithActiveDetectionInstructionCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags/tags-with-active-detection-instructions?limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "tagsWithActiveDetectionInstructions": [ { "tag": { "id": "9ae000000000001", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number" }, "activeDetectionInstruction": { "id": "9di000000000002", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "version": 2, "instructionTxt": "Detect credit card numbers: 16-digit Luhn-valid sequences, card-type prefixes.", "isActive": true, "offCoreSyncState": "Synced", "lastSyncedDate": "2026-06-15T11:01:05.000Z", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard/detection-instructions/active", "createdDate": "2026-06-15T11:00:00.000Z" } }, { "tag": { "id": "9ae000000000002", "name": "SSN", "fullyQualifiedName": "Compliance_Tags.PII.SSN", "label": "Social Security Number" }, "activeDetectionInstruction": { "id": "9di000000000003", "tagFullyQualifiedName": "Compliance_Tags.PII.SSN", "version": 1, "instructionTxt": "Detect US Social Security Numbers: NNN-NN-NNNN format or 9-digit numeric sequences.", "isActive": true, "offCoreSyncState": "Synced", "lastSyncedDate": "2026-06-15T11:01:05.000Z", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.SSN/detection-instructions/active", "createdDate": "2026-06-15T11:00:00.000Z" } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{fullyQualifiedName}_ not found. ### POST Bulk create tag taxonomies `POST /ssot/data-governance/tag-taxonomies/actions/bulk-create` Tags: Data Governance. Creates multiple tag taxonomies in a single request. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkCreateInputRepresentation`. _Example: example1_ ``` { "taxonomies": [ { "name": "Compliance_Tags", "label": "Compliance Tags", "description": "Compliance-related tags." }, { "name": "Ethics_Tags", "label": "Ethics Tags", "description": "Ethical AI compliance indicators." }, { "name": "Marketing_Tags", "label": "Marketing Tags", "description": "Marketing consent and preference tags." } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-29T14:22:11.000Z", "description": "Compliance-related tags.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } }, { "statusCode": 201, "result": { "id": "9as000000000002", "name": "Ethics_Tags", "label": "Ethics Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Ethics_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-29T14:22:11.000Z", "description": "Ethical AI compliance indicators.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } }, { "statusCode": 201, "result": { "id": "9as000000000003", "name": "Marketing_Tags", "label": "Marketing Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Marketing_Tags", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-29T14:22:11.000Z", "description": "Marketing consent and preference tags.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete tag taxonomies `POST /ssot/data-governance/tag-taxonomies/actions/bulk-delete` Tags: Data Governance. Deletes multiple tag taxonomies and all child tags in a single request. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkDeleteInputRepresentation`. _Example: example1_ ``` { "names": [ "Marketing_Tags", "Unused_Tags" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 204, "result": null }, { "statusCode": 404, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Tag taxonomy 'Unused_Tags' not found" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk update tag taxonomies `POST /ssot/data-governance/tag-taxonomies/actions/bulk-update` Tags: Data Governance. Updates multiple tag taxonomies in a single request. Omitted fields are left unchanged. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TaxonomyBulkUpdateInputRepresentation`. _Example: example1_ ``` { "items": [ { "name": "Compliance_Tags", "label": "Compliance Tags (GA)" }, { "name": "Ethics_Tags", "description": "Ethical AI tags — caste, gender, accessibility." } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": false, "results": [ { "statusCode": 200, "result": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags (GA)", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Compliance_Tags", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "description": "Compliance-related tags.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } }, { "statusCode": 200, "result": { "id": "9as000000000002", "name": "Ethics_Tags", "label": "Ethics Tags", "url": "/services/data/v68.0/ssot/data-governance/tag-taxonomies/Ethics_Tags", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "description": "Ethical AI tags — caste, gender, accessibility.", "taxonomyKind": "Tag", "type": "Custom", "state": "Active", "childCount": 0 } } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### GET Get tags `GET /ssot/data-governance/tags` Tags: Data Governance. Returns a paginated list of tags across all tag taxonomies. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of tags to return from `5` through `200`. If unspecified, the default number of rows is `25`. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 67.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, the default value is `ASC` ordered by developer name. **Available Version:** 67.0 * `parentTagFullyQualifiedName` (query, string) Fully-qualified API name of the parent tag. Scopes the list to direct children. **Available Version:** 67.0 * `searchString` (query, string) Search keyword to match against the developer name or label. **Available Version:** 67.0 * `taxonomyName` (query, string) Fully-qualified API name of the tag taxonomy (for example, `Compliance_Tags`). Scopes the list to tags under that taxonomy. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tags?limit=25&offset=0&orderBy=Label+ASC", "nextPageUrl": null, "previousPageUrl": null, "tags": [ { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Email", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-21T14:08:12.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-11T16:48:03.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address", "description": "Personally identifiable email addresses.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Classifications.PII", "type": "Custom" } ] }, { "id": "9ae000000000500", "name": "AccountInfo", "fullyQualifiedName": "FinancialData.AccountInfo", "label": "Account Info", "url": "/services/data/v68.0/ssot/data-governance/tags/FinancialData.AccountInfo", "createdBy": { "id": "005000000000099", "name": "System", "profilePhotoUrl": "/services/images/photo/005000000000099" }, "createdDate": "2026-01-01T00:00:00.000Z", "lastModifiedBy": { "id": "005000000000099", "name": "System", "profilePhotoUrl": "/services/images/photo/005000000000099" }, "lastModifiedDate": "2026-01-01T00:00:00.000Z", "fullyQualifiedLabel": "Financial Data.Account Info", "description": "Standard tag for account-identifier fields.", "type": "System", "state": "Active", "taxonomy": { "id": "9as000000000099", "name": "FinancialData", "label": "Financial Data", "taxonomyKind": "Tag", "type": "System" }, "parentTag": null, "classifications": [] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Invalid orderBy field. Valid fields: Label, DeveloperName. * **404** RESOURCE\_NOT\_FOUND: Tag _{parentTagFullyQualifiedName}_ not found. ### POST Create tag `POST /ssot/data-governance/tags` Tags: Data Governance. Creates a tag under a specified tag taxonomy, optionally nested under a parent tag. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagCreateInputRepresentation`. _Example: example1_ ``` { "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "description": "Personally identifiable email addresses.", "classificationFullyQualifiedNames": [ "Compliance_Classifications.PII" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TagRepresentation`. _Example: example1_ ``` { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Email", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-21T14:08:12.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-21T14:08:12.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address", "description": "Personally identifiable email addresses.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Classifications.PII", "type": "Custom" } ] } ``` * **400** INVALID\_INPUT or MISSING\_ARGUMENT For example: * Tag _fullyQualifiedName_ must be 2 or 3 segments: .\[.\] * A tag with this API name already exists * Input representation is required. * **404** RESOURCE\_NOT\_FOUND: Tag taxonomy _{taxonomySegment}_ not found. ### GET Get tag `GET /ssot/data-governance/tags/{fullyQualifiedName}` Tags: Data Governance. Returns a tag by its fully qualified API name. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagRepresentation`. _Example: example1_ ``` { "id": "9ae000000000043", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-21T14:12:40.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-02-21T14:12:40.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "description": "Credit card PAN — PCI-regulated.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Classifications.PII", "type": "Custom" }, { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "fullyQualifiedLabel": "Compliance Classifications.Sensitive", "type": "Custom" } ] } ``` * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### DELETE Delete tag `DELETE /ssot/data-governance/tags/{fullyQualifiedName}` Tags: Data Governance. Deletes a tag and cascades the deletion to any child tags and assignments. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag. **Available Version:** 67.0 #### Responses * **202** Success * **400** INVALID\_OPERATION For example: * Cannot delete system tag. * Entity is already being deleted. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. * **412** REFERENTIAL\_INTEGRITY\_VIOLATION: Cannot delete — has external dependencies or children tags. ### PATCH Update tag `PATCH /ssot/data-governance/tags/{fullyQualifiedName}` Tags: Data Governance. Updates a tag. Omitted fields are left unchanged. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully qualified API name of the tag. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagPatchInputRepresentation`. _Example: example1_ ``` { "label": "Email Address (PII)", "description": "Personally identifiable email — includes personal and work email fields.", "classificationFullyQualifiedNames": [ "Compliance_Classifications.PII", "Compliance_Classifications.Sensitive" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `TagRepresentation`. _Example: example1_ ``` { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address (PII)", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Email", "createdBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "createdDate": "2026-02-21T14:08:12.000Z", "lastModifiedBy": { "id": "005000000000001", "name": "Dana Patel", "profilePhotoUrl": "/services/images/photo/005000000000001" }, "lastModifiedDate": "2026-04-28T10:30:15.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address (PII)", "description": "Personally identifiable email — includes personal and work email fields.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Classifications.PII", "type": "Custom" }, { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "fullyQualifiedLabel": "Compliance Classifications.Sensitive", "type": "Custom" } ] } ``` * **400** INVALID\_INPUT, INVALID\_OPERATION, or MISSING\_ARGUMENT For example: * A tag with this label already exists. * Referenced tag must be in the same taxonomy. * Cannot update entity in Deleting state. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### GET Get tag assignments on a tag `GET /ssot/data-governance/tags/{fullyQualifiedName}/assignments` Tags: Data Governance. Returns a paginated list of tag assignments for a specific tag. **Available Version:** 67.0 #### Parameters * `limit` (query, integer) Maximum number of tag assignments to return. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 67.0 * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag (dotted path). **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagAssignmentCollectionRepresentation`. _Example: example1_ ``` { "totalSize": 2, "count": 2, "limit": 25, "offset": 0, "currentPageUrl": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Email/assignments?limit=25&offset=0", "nextPageUrl": null, "previousPageUrl": null, "tagAssignments": [ { "id": "9aa000000000001", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Individual_DLO__dll", "objectLabel": "Individual", "fieldName": "Email", "fieldLabel": "Email" }, { "id": "9aa000000000002", "tagId": "9ae000000000042", "tagName": "Email", "tagFullyQualifiedName": "Compliance_Tags.PII.Email", "tagLabel": "Email Address", "tagFullyQualifiedLabel": "Compliance Tags.PII.Email Address", "objectName": "Contact_DLO__dll", "objectLabel": "Contact", "fieldName": "PersonalEmail", "fieldLabel": "Personal Email" } ] } ``` * **400** INVALID\_INPUT\_COMBINATION For example: * Limit must be between 5 and 200. * Offset must be non-negative. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### POST Create tag detection instruction `POST /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions` Tags: Data Governance. Creates or replaces the active detection instruction for a tag. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag (dotted path). **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagDetectionInstructionCreateInputRepresentation`. _Example: example1_ ``` { "instructionTxt": "Detect fields that contain credit card numbers. Look for 16-digit numeric sequences matching Luhn algorithm, card type prefixes (4xxx Visa, 5xxx Mastercard), or masked formats like XXXX-XXXX-XXXX-1234." } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `TagDetectionInstructionRepresentation`. _Example: example1_ ``` { "id": "9di000000000001", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "version": 1, "instructionTxt": "Detect fields that contain credit card numbers. Look for 16-digit numeric sequences matching Luhn algorithm, card type prefixes (4xxx Visa, 5xxx Mastercard), or masked formats like XXXX-XXXX-XXXX-1234.", "isActive": true, "offCoreSyncState": "NotSynced", "lastSyncedDate": null, "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard/detection-instructions/active", "createdDate": "2026-06-15T10:30:00.000Z" } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * The _instructionTxt_ must be at most 100 characters. * The _fullyQualifiedName_ is required. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### GET Get tag detection instruction `GET /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions/active` Tags: Data Governance. Returns the currently active detection instruction for a tag. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag (dotted path). **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `TagDetectionInstructionRepresentation`. _Example: example1_ ``` { "id": "9di000000000001", "tagFullyQualifiedName": "Compliance_Tags.PII.CreditCard", "version": 1, "instructionTxt": "Detect fields that contain credit card numbers...", "isActive": true, "offCoreSyncState": "Synced", "lastSyncedDate": "2026-06-15T10:31:05.000Z", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard/detection-instructions/active", "createdDate": "2026-06-15T10:30:00.000Z" } ``` * **400** MISSING\_ARGUMENT: _fullyQualifiedName_ is required. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### DELETE Delete tag detection instruction `DELETE /ssot/data-governance/tags/{fullyQualifiedName}/detection-instructions/active` Tags: Data Governance. Deactivates the currently active detection instruction for a tag. **Available Version:** 67.0 #### Parameters * `fullyQualifiedName` (path, string, required) Fully-qualified API name of the tag (dotted path). **Available Version:** 67.0 #### Responses * **202** Success * **400** MISSING\_ARGUMENT: _fullyQualifiedName_ is required. * **404** RESOURCE\_NOT\_FOUND: Tag _{fullyQualifiedName}_ not found. ### POST Bulk create tags `POST /ssot/data-governance/tags/actions/bulk-create` Tags: Data Governance. Creates multiple tags in a single request. Maximum of 200 items per request. A parent tag and its child cannot be created in the same request. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagBulkCreateInputRepresentation`. _Example: example1_ ``` { "tags": [ { "fullyQualifiedName": "Compliance_Tags.PII.Phone", "label": "Phone Number", "description": "Phone numbers (personal/business)." }, { "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "description": "Credit card PAN — PCI-regulated.", "classificationFullyQualifiedNames": [ "Compliance_Classifications.PII", "Compliance_Classifications.Sensitive" ] }, { "fullyQualifiedName": "Compliance_Tags.PII.__invalid", "label": "Invalid Name" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 201, "result": { "id": "9ae000000000050", "name": "Phone", "fullyQualifiedName": "Compliance_Tags.PII.Phone", "label": "Phone Number", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Phone", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Phone Number", "description": "Phone numbers (personal/business).", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [] } }, { "statusCode": 201, "result": { "id": "9ae000000000051", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard", "createdDate": "2026-04-29T14:22:11.000Z", "lastModifiedDate": "2026-04-29T14:22:11.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Credit Card Number", "description": "Credit card PAN — PCI-regulated.", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "label": "Compliance Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Tags.PII", "type": "Custom" }, "classifications": [ { "id": "9ae000000000010", "name": "PII", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "fullyQualifiedLabel": "Compliance Classifications.PII", "type": "Custom" }, { "id": "9ae000000000011", "name": "Sensitive", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "fullyQualifiedLabel": "Compliance Classifications.Sensitive", "type": "Custom" } ] } }, { "statusCode": 400, "result": [ { "errorCode": "INVALID_INPUT", "message": "Invalid developer name format" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk delete tags `POST /ssot/data-governance/tags/actions/bulk-delete` Tags: Data Governance. Deletes multiple tags in a single request, cascading each deletion to its child tags and assignments. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagBulkDeleteInputRepresentation`. _Example: example1_ ``` { "fullyQualifiedNames": [ "Compliance_Tags.PII.Phone", "Compliance_Tags.PII.Obsolete" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 204, "result": null }, { "statusCode": 412, "result": [ { "errorCode": "DEPENDENCY_EXISTS", "message": "Cannot delete — has dependencies" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Bulk update tags `POST /ssot/data-governance/tags/actions/bulk-update` Tags: Data Governance. Updates multiple tags in a single requests. Omitted fields are left unchanged. Validation runs against the state before the batch operation. For example, if item 1 re-parents tag A and item 2 references tag A, item 2 validates against tag A's ancestry before the batch operation. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagBulkUpdateInputRepresentation`. _Example: example1_ ``` { "items": [ { "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address (PII)" }, { "fullyQualifiedName": "Compliance_Tags.PII.Phone", "parentTagFullyQualifiedName": "Compliance_Tags.PII.Contact" }, { "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "classificationFullyQualifiedNames": [ "Compliance_Classifications.PII", "Compliance_Classifications.Sensitive" ] }, { "fullyQualifiedName": "Compliance_Tags.PII.NonExistent", "label": "Will Fail" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 200, "result": { "id": "9ae000000000042", "name": "Email", "fullyQualifiedName": "Compliance_Tags.PII.Email", "label": "Email Address (PII)", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Email", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "fullyQualifiedLabel": "Compliance Tags.PII.Email Address (PII)", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII" }, "classifications": [] } }, { "statusCode": 200, "result": { "id": "9ae000000000050", "name": "Phone", "fullyQualifiedName": "Compliance_Tags.PII.Phone", "label": "Phone Number", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.Phone", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000021", "name": "Contact", "fullyQualifiedName": "Compliance_Tags.PII.Contact", "label": "Contact" }, "classifications": [] } }, { "statusCode": 200, "result": { "id": "9ae000000000051", "name": "CreditCard", "fullyQualifiedName": "Compliance_Tags.PII.CreditCard", "label": "Credit Card Number", "url": "/services/data/v68.0/ssot/data-governance/tags/Compliance_Tags.PII.CreditCard", "lastModifiedDate": "2026-04-29T15:01:00.000Z", "type": "Custom", "state": "Active", "taxonomy": { "id": "9as000000000001", "name": "Compliance_Tags", "taxonomyKind": "Tag", "type": "Custom" }, "parentTag": { "id": "9ae000000000020", "name": "PII", "fullyQualifiedName": "Compliance_Tags.PII", "label": "PII" }, "classifications": [ { "id": "9ae000000000010", "fullyQualifiedName": "Compliance_Classifications.PII", "label": "PII", "type": "Custom" }, { "id": "9ae000000000011", "fullyQualifiedName": "Compliance_Classifications.Sensitive", "label": "Sensitive", "type": "Custom" } ] } }, { "statusCode": 404, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Tag 'Compliance_Tags.PII.NonExistent' not found" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * Maximum 200 items per request. * Input representation is required. ### POST Propagate tags `POST /ssot/data-governance/tags/actions/propagate` Tags: Data Governance. Propagates data governance tags to the specified objects. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `TagPropagateInputRepresentation`. _Example: example1_ ``` { "objectNames": [ "Individual_DLO__dll", "Contact_DLO__dll", "NonExistent_DLO__dll" ] } ``` #### Responses * **201** Success Media type: `application/json`. Schema: `BatchRepresentation`. _Example: example1_ ``` { "hasErrors": true, "results": [ { "statusCode": 200, "result": null }, { "statusCode": 200, "result": null }, { "statusCode": 400, "result": [ { "errorCode": "RESOURCE_NOT_FOUND", "message": "Object 'NonExistent_DLO__dll' not found" } ] } ] } ``` * **400** INVALID\_INPUT\_COMBINATION or MISSING\_ARGUMENT For example: * At least one _objectName_ is required. * Maximum 20 objectNames per request. * Input representation is required. ### POST Create data graph `POST /ssot/data-graphs` Tags: Data Graphs. Create a data graph. **Available Version:** 59.0 #### Request body (required) Media type: `application/json`. Schema: `CdpDataGraphInputRepresentation`. _Example: example1_ ``` { "name": "DraftDGWithSchedule", "label": "DraftDGWithSchedule", "creationMode": "draft", "type": "NONE", "dataspaceName": "default", "primaryObjectName": "ssot__Individual__dlm", "fullRefreshConfig": { "schedule": { "frequency": 1, "timeGranularity": "Day" } }, "incrementalRefreshConfig": { "enabled": true }, "sourceObject": { "devName": "Individual", "name": "ssot__Individual__dlm", "label": "Individual", "jsonPath": "$", "type": "standard", "fields": [ { "devName": "Individual_Id", "sourceFieldName": "ssot__Id__c", "isKeyColumn": true, "isProjected": true, "dataType": "Text", "usageTag": "NONE" }, { "devName": "Individual_KQ_Id", "sourceFieldName": "KQ_Id__c", "isKeyColumn": false, "isProjected": true, "dataType": "Text", "usageTag": "KEY_QUALIFIER" } ], "relatedObjects": [] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataGraphOutputRepresentation`. ### GET Get data graph data by entity name `GET /ssot/data-graphs/data/{dataGraphEntityName}` Tags: Data Graphs. Query a data graph by the primary key of either the primary data model object (DMO) or the Individual linked DMO. For real-time data graphs, the endpoint attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable. **Available Version:** 59.0 #### Parameters * `dataGraphEntityName` (path, string, required) API name of the data graph to query. **Available Version:** 59.0 * `dataspace` (query, string) Name of the data space in which to query the data graph. By default, the endpoint queries the `default` dataspace. **Available Version:** 59.0 * `lookupKeys` (query, string, required) Lookup key and value to search on. Specify one of these key-value pairs: * The primary key of the primary DMO, for example, `lookupKeys=[id__c=def]` * The primary key of the Individual linked DMO, for example, `lookupKeys=[IndividualLink__dlm.SourceRecordId__c=1111111]` **Available Version:** 59.0 * `noCache` (query, boolean) Indicates whether to read data from the standard, non-real-time data graph (`true`) or the real-time data graph (`false`). The default is `false`. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ { "json_blob__c": "{\"ssot__Id__c\":\"100005\",\"UnifiedLinkssotIndividualIr1__dlm\":[{\"SourceRecordId__c\":\"10000001\",\"UnifiedRecordId__c\":\"100005\",\"ssot__Individual__dlm\":[{\"ssot__FirstName__c\":\"Jean\",\"ssot__Id__c\":\"10000001\",\"ssot__LastName__c\":\"Johnson\",\"ssot__SalesOrder__dlm\":[{\"ssot__PurchaseOrderDate__c\":\"2023-07-26T07:37:57.927Z\",\"ssot__Id__c\":\"100002\",\"ssot__SoldToCustomerId__c\":\"10000001\",\"ssot__TotalProductAmount__c\":557.000000000000000000},{\"ssot__PurchaseOrderDate__c\":\"2023-07-26T19:52:26.525Z\",\"ssot__Id__c\":\"100001\",\"ssot__SoldToCustomerId__c\":\"10000001\",\"ssot__TotalProductAmount__c\":192.000000000000000000},{\"ssot__PurchaseOrderDate__c\":\"2023-07-06T20:30:18.255Z\",\"ssot__Id__c\":\"100005\",\"ssot__SoldToCustomerId__c\":\"10000001\",\"ssot__TotalProductAmount__c\":590.000000000000000000}]}]}]}" } ], "done": true } ``` ### GET Get data graph data by ID `GET /ssot/data-graphs/data/{dataGraphEntityName}/{id}` Tags: Data Graphs. Query data graph data by ID. For real-time data graphs, the API retrieves data from the real-time data graph and only falls back to the standard data graph if the real-time data graph is unavailable. **Available Version:** 59.0 #### Parameters * `dataspace` (query, string) Name of the data space to query. If unspecified, the `default` data space is used. **Available Version:** 59.0 * `live` (query, boolean) Indicates whether live lookup for the data graph is enabled (`true`) or not (`false`). **Available Version:** 63.0 * `id` (path, string, required) Record ID to query for, which is matched against the primary key field of the primary data model object (DMO) in the data graph. **Available Version:** 59.0 * `dataGraphEntityName` (path, string, required) API name of the data graph to query. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "ssot__id__c": "100005", "ssot__name__c": "Name", "ssot__age__c": 30, "ssot__ContactPointEmail__dlm": [ { "ssot__id__c": "99997", "ssot__emailid__c": "name@email.com" }, { "ssot__id__c": "99998", "ssot__emailid__c": "name1@email.com" } ], "ssot__orders__dlm": [ { "ssot__order_id__c": 1, "ssot__order_date__c": "01-01-2023", "ssot__order_price__c": 1500, "ssot__items__dlm": [ { "ssot__item_id__c": 2, "ssot__item_name__c": "Mobile S20", "ssot__item_price__c": 900, "ssot__order_id__c": 1 }, { "ssot__item_id__c": 3, "ssot__item_name__c": "Mobile Samsung", "ssot__item_price__c": 600, "ssot__order_id__c": 1 } ] } ] } ``` ### GET Get data graph metadata `GET /ssot/data-graphs/metadata` Tags: Data Graphs, Metadata. Query data graph metadata. This API supports both standard and real-time data graphs that allow you to retrieve metadata from each respective graph type. **Available Version:** 59.0 #### Parameters * `dataspace` (query, string) Name of the data space to query. If unspecified, the `default` data space is used. **Available Version:** 59.0 * `dataGraphEntityName` (query, string) API name of the data graph to query. If unspecified, metadata for all data graphs is returned. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDgMetadataRepresentation`. _Example: Example_ ``` { "developerName": "IndividualDAO", "description": "Data Application Object for Individual", "valuesDmoName": "IndividualDao_values__dlm", "idDmoName": "IndividualDao_id__dlm", "dataspaceName": "default", "status": "Ready", "primaryObjectName": "Individual_dao__dlm", "primaryObjectType": "Custom", "dgObject": { "developerName": "Individual_dao__dlm", "type": "DMO/CI", "fields": [ { "developerName": "IndividualId__c", "lookupCol": "", "length": "10", "data_type": "string", "keyCol": "" } ], "relatedObjects": [ { "developerName": "SalesOrder__dlm", "type": "DMO/CI", "memberDmoName": "SalesOrder_Fragment__dlm", "paths": [ { "fieldName": "CustomerId__c", "parentFieldName": "IndividualId__c", "cardinality": "OneToOne" } ], "fields": [ { "developerName": "IndividualId__c", "lookupCol": "", "length": "10", "data_type": "string", "keyCol": "" } ], "recencyCriteria": { "fieldName": "OrderDate__c", "valueUnit": "Day", "value": "10", "valueType": "Time" }, "relatedObjects": [ { "developerName": "LineItem__dlm", "type": "DMO/CI", "memberDmoName": "LineItem_fragment__dlm", "paths": [ { "fieldName": "OrderId__c", "parentFieldName": "SalesOrderId__c", "cardinality": "OneToOne" } ], "fields": [ { "developerName": "IndividualId__c", "lookupCol": "", "length": "10", "data_type": "string", "keyCol": "" } ] } ] }, { "developerName": "SpendsByMonth__ci", "type": "Calculated", "memberDmoName": "SpendsByMonth_fragment__dlm", "paths": [ { "fieldName": "CustomerId__c", "parentFieldName": "IndividualId__c", "cardinality": "1:1/1:N/N:1" } ], "fields": [ { "developerName": "IndividualId__c", "lookupCol": "", "length": "10", "data_type": "string", "keyCol": "" } ], "recencyCriteria": { "value": "10", "valueType": "record" } } ] }, "extendedProperties": "", "version": "1" } ``` ### GET Get data graph `GET /ssot/data-graphs/{dataGraphName}` Tags: Data Graphs. Query a data graph. **Available Version:** 59.0 #### Parameters * `dataGraphName` (path, string, required) Name of the data graph. **Available Version:** 64.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataGraphOutputRepresentation`. ### DELETE Delete data graph `DELETE /ssot/data-graphs/{dataGraphName}` Tags: Data Graphs. Delete a data graph. **Available Version:** 59.0 #### Parameters * `dataGraphName` (path, string, required) Name of the data graph. **Available Version:** 64.0 #### Responses * **200** Success ### POST Activate data graph `POST /ssot/data-graphs/{dataGraphName}/actions/activate` Tags: Data Graphs. Activate a data graph draft. Activation saves the draft configuration and builds the data graph, which starts a materialization job to process the data according to the graph definition. In the Data 360 UI, this action corresponds to **Save and Build**. **Available Version:** 67.0 #### Parameters * `dataGraphName` (path, string, required) Name of the data graph. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `CdpDataGraphActivateInputRepresentation`. _Example: example1_ ``` { "dataGraphName": "MyDataGraph", "fullRefreshConfig": { "schedule": { "frequency": 1, "timeGranularity": "Day" } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataGraphActionResponseRepresentation`. _Example: example1_ ``` { "errors": [ { "errorCode": "", "message": "" } ], "success": true } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Refresh data graph `POST /ssot/data-graphs/{dataGraphName}/actions/refresh` Tags: Data Graphs. Refresh a data graph. **Available Version:** 64.0 #### Parameters * `dataGraphName` (path, string, required) Name of the data graph. **Available Version:** 64.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataGraphActionResponseRepresentation`. _Example: Example_ ``` { "errors": [ { "errorCode": "", "message": "" } ], "success": true } ``` ### GET Get data kits `GET /ssot/data-kits` Tags: Data Kits. Get a list of data kits by namespace. **Available Version:** 63.0 #### Parameters * `namespace` (query, string) Namespace prefix of the data kit package. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitOutputRepresentation`. _Example: Example_ ``` { "dataKitDetails": [ { "components": [ { "componentType": "DataStreamBundle", "connectorType": "STREAMINGAPP", "developerName": "mob", "label": "mob", "streams": [] }, { "componentType": "DataStreamBundle", "connectorType": "INGESTAPI", "developerName": "inge", "label": "inge", "streams": [] }, { "componentType": "DataStreamBundle", "connectorType": "INGESTAPI", "developerName": "ingf", "label": "ingf", "streams": [] } ], "developerName": "relUpdates", "label": "relUpdates", "publishingSequence": [ { "componentType": "DataStreamBundle", "developerName": "inge" }, { "componentType": "DataStreamBundle", "developerName": "mob" }, { "componentType": "DataStreamBundle", "developerName": "ingf" } ] }, { "components": [ { "componentType": "DataLakeObject", "developerName": "DLOKQTEST", "label": "DLOKQTEST" } ], "developerName": "kqdatakit", "label": "kqdatakit", "publishingSequence": [ { "componentType": "DataLakeObject", "developerName": "DLOKQTEST" } ] }, { "components": [ { "componentType": "DataStreamBundle", "connectorType": "CRM", "developerName": "sfm_UserStream", "label": "User Stream", "streams": [ { "externalRecordIdentifier": "User", "fieldApiNames": [ [ "Id", "DefaultDivision", "Username", "Name", "FirstName", "LastName", "MiddleName", "InformalName", "Suffix", "CompanyName", "Division", "Department", "Title", "Address", "Street", "City", "State", "PostalCode", "Country", "StateCode", "CountryCode", "Latitude", "Longitude", "Xyz", "GeocodeAccuracy", "Email", "EmailPreferences", "SenderEmail", "SenderName", "Signature" ], [ "LastTabSetId", "LastDashboardId", "HasUserVerifiedPhone", "HasUserVerifiedEmail", "IsPartner", "ContactId", "PersonId", "AccountId", "CallCenterId", "Extension", "PortalRole", "IsPortalEnabled", "AdminType", "AdminPermissions1", "AdminPermissions2", "TrialAccessLevel", "ActiveAccessLevel", "SandboxAccessLevel", "HasOverrideConfiguration", "HasEditTrialUserRestricted", "HasEditLoginMessages", "HasEditPartnerIdentifier", "HasEditApiPermission", "HasEditOrgStatus", "HasDefenseIntegration", "HasAccessCoreServiceProtection", "HasProductManagerRestricted", "HasManageAnalyticsBlacktab", "HasPremierAdministrator", "HasManageCoreServiceProtection" ], [ "ChatterAdoptionStageModifiedDate", "IsPrmSuperUser", "LastViewedDate", "LastReferencedDate", "BannerPhotoId", "BannerPhotoUrl", "SmallBannerPhotoUrl", "MediumBannerPhotoUrl", "IsProfilePhotoActive", "IndividualId", "GlobalIdentity", null, null ] ], "label": "User", "streamDevName": "sfm_UserStreamDataKit_User" } ] } ], "developerName": "sfm_UserStreamDataKit", "label": "User Stream DataKit", "publishingSequence": [ { "componentType": "DataStreamBundle", "developerName": "UserStream" } ] } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create data kit `POST /ssot/data-kits` Tags: Data Kits. Create a standard data kit. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataKitInputRepresentation`. _Example: Example_ ``` { "dataKitDevName": "NewDataKit", "label": "New Data Kit From API", "dataKitType": "None", "components": [ { "type": "DataStreamBundle", "info": { "name": "CRMBundle", "connectorType": "CRM", "streams": [ { "devName": "Lead_Home__dll", "label": "Lead_Home" }, { "devName": "User_Home__dll", "label": "User_Home" } ] } } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitRepresentation`. _Example: Example_ ``` { "components": [ { "info": { "connectorType": "CRM", "name": "CRMBundle", "streams": [ { "devName": "Lead_Home__dll", "fieldApiNames": [], "label": "Lead_Home" }, { "devName": "User_Home__dll", "fieldApiNames": [], "label": "User_Home" } ] }, "type": "DataStreamBundle" } ], "devName": "NewDataKit", "label": "New Data Kit From API" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data kit available components `GET /ssot/data-kits/available-components` Tags: Data Kits. Get a list of available components within data kits by component type. **Available Version:** 63.0 #### Parameters * `componentType` (query, string) Type of components to return. These values are supported: * `DataStreamBundle` * `CalculatedInsight` * `DataLakeObject` * `DataTransform` * `EngagementSignal` * `PersonalizationObjective` * `PersonalizationRecommender` * `PersonalizationPoint` * `PersonalizationSchema` **Available Version:** 63.0 * `dataKitDevName` (query, string) Developer name of the data kit. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of available components to return from `1` through `200`. By default, `200` components are returned. **Available Version:** 63.0 * `offset` (query, integer) Number of records to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitComponentCollectionRepresentation`. _Example: Example_ ``` { "components": [ { "info": { "connectorType": "STREAMINGAPP", "streams": [ { "devName": "mob_Behavioral_Events_2D04D600", "fieldApiNames": [], "label": "mob-Behavioral Events 2D04D600" } ] }, "type": "DataStreamBundle" }, { "info": { "connectorType": "CRM", "streams": [ { "devName": "Contact_std", "fieldApiNames": [], "label": "Contact_Home" }, { "devName": "Lead_Home", "fieldApiNames": [], "label": "Lead_Home" }, { "devName": "Opportunity_Home", "fieldApiNames": [], "label": "Opportunity_Home" }, { "devName": "OpportunityContactRole_Home", "fieldApiNames": [], "label": "OpportunityContactRole_Home" }, { "devName": "User_Home", "fieldApiNames": [], "label": "User_Home" } ] }, "type": "DataStreamBundle" } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Deploy data kit components `POST /ssot/data-kits/{dataKitDevName}` Tags: Data Kits. Deploy multiple components from a specific data kit. > **Note:** See [Supported Component Types for Data Kit Deployment](https://developer.salesforce.com/docs/data/connectapi/guide/deploy-data-kit-payloads.html) for the complete list of component types and their corresponding payload configurations. **Available Version:** 64.0 #### Parameters * `dataKitDevName` (path, string, required) Developer name of the data kit. **Available Version:** 64.0 * `asyncMode` (query, boolean, required) Specifies asynchronous data kit deployment. Must be set to `true`; other values are not currently supported. **Available Version:** 64.0 * `dataspace` (query, string) Name of the data space to which to deploy the data kit components. If unspecified, the `default` data space is used. **Available Version:** 64.0 #### Request body Media type: `application/json`. Schema: `CdpDataKitDeployInputRepresentation`. _Example: B2C commerce bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "COMMERCE", "bundleName": "commercebundle1", "bundleConfig": { "instanceId": "bjmp_prd" } } } ] } ``` _Example: BYOL bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "EXTERNAL", "bundleName": "testsnowflake", "bundleConfig": { "connectionName": "testsnowflake" } } } ] } ``` _Example: Calculated insight request_ ``` { "components": [ { "type": "CalculatedInsight", "config": { "apiName": "Namespace__testCI", "apiNameOverride": "CiTest1", "label": "CiTest1", "publishInterval": "NotScheduled" } } ] } ``` _Example: Connector framework bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "MORECONNECTORS", "bundleName": "BundleName", "forceNoRefresh": true, "bundleConfig": { "connectionName": "connectionName" } } } ] } ``` _Example: CRM bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "CRM", "bundleName": "BundleName", "forceNoRefresh": true, "bundleConfig": { "orgId": "org123" } } } ] } ``` _Example: Data transform request_ ``` { "components": [ { "type": "DataTransform", "config": { "dataTransformType": "BATCH", "dataTransformDevName": "Namespace__BatchTransformAccount", "apiName": "BatchTransformAccount", "label": "BatchTransformAccount", "dataSpaceName": "default", "dataObjectOverrides": [ { "nameOfObjInPublishingOrg": "Contacts__dll", "nameOfObjInSubscriberOrg": "Contacts_2_companion__dll" }, { "nameOfObjInPublishingOrg": "output_dlo_2__dll", "nameOfObjInSubscriberOrg": "output_dlo_2_copy__dll" } ], "definitionOverrides": [ { "templateDevName": "DefinitionDeveloperNameInDatakit_1", "devName": "Renamed_DefinitionName_1", "label": "Renamed_Label_1" }, { "templateDevName": "DefinitionDeveloperNameInDatakit_2", "devName": "Renamed_DefinitionName_2", "label": "Renamed_Label_2" } ] } } ] } ``` _Example: DLO request_ ``` { "components": [ { "type": "DataLakeObject", "config": { "dataSourceObjectDevName": "Namespace__DLOname", "apiName": "hello", "label": "lab", "dataSpaceName": "default" } } ] } ``` _Example: Ingestion API bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "INGESTAPI", "bundleName": "IngestionDataStreams", "bundleConfig": { "connectorName": "NewIngestionConnector" } } } ] } ``` _Example: Streaming app bundle request_ ``` { "components": [ { "type": "DataStreamBundle", "config": { "connectorType": "STREAMINGAPP", "bundleName": "BundleName", "forceNoRefresh": true, "bundleConfig": { "connectorName": "connectorName", "streamingAppDataConnectorType": "MobileApp" } } } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitAsyncRepresentation`. _Example: Example_ ``` { "jobId": "08PVF000000fHhd" } ``` * **400** Invalid data in the deployment request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### DELETE Delete data kit `DELETE /ssot/data-kits/{dataKitDevName}` Tags: Data Kits. Delete a data kit. **Available Version:** 64.0 #### Parameters * `dataKitDevName` (path, string, required) Developer name of the data kit. **Available Version:** 63.0 #### Responses * **200** Success * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** PackageKitDefinition does not exist: _dataKitDevName_ ### PATCH Update data kit components `PATCH /ssot/data-kits/{dataKitDevName}` Tags: Data Kits. Update the components of an existing data kit. Updating components is a destructive sync: newly provided components replace the existing set, and any omitted components are removed. **Available Version:** 64.0 #### Parameters * `dataKitDevName` (path, string, required) Developer name of the data kit. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataKitPatchInputRepresentation`. _Example: example1_ ``` { "components": [ { "type": "DataLakeObject", "info": { "name": "Opportunity_Home__dll", "label": "Opportunity_Home" } } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitRepresentation`. _Example: Example_ ``` { "components": [ { "info": { "label": "Opportunity_Home", "name": "Opportunity_Home__dll" }, "type": "DataLakeObject" } ], "devName": "NewDataKit", "label": "New Data Kit From API" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data kit manifest `GET /ssot/datakit/{dataKitDevName}/manifest` Tags: Data Kits. Get a list of all member components and dependencies for a data kit. **Available Version:** 63.0 #### Parameters * `dataKitDevName` (path, string, required) Developer name of the data kit or name of the `DataPackageKitDefinition`. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataKitMembersList`. _Example: Example_ ``` { "dataKitMembers": [ { "developerName": [ "testdk" ], "entityName": "DataPackageKitDefinition", "id": [ "1dkSB000000dVqL" ] }, { "developerName": [ "testdk_1762749290261" ], "entityName": "DataPackageKitObject", "id": [ "5cQSB000000fhQn" ] }, { "developerName": [ "acde_ff72b9e2_fd4b_4aeb_89d1_177e0b2095f4" ], "entityName": "DataSource", "id": [ "3iPSB000004gmh3" ] }, { "developerName": [ "inapi" ], "entityName": "DataSourceBundleDefinition", "id": [ "1raSB000000cBAX" ] }, { "developerName": [ "acde_exercises_6C0A36AC", "acde_footwear_6C0A36AB" ], "entityName": "DataSourceObject", "id": [ "9XDSB000003w3Jx", "9XDSB000003w3Jy" ] }, { "developerName": [ "acde_exercises_6C0A36AC_1762749291203", "acde_footwear_6C0A36AB_1762749292154" ], "entityName": "DataStreamTemplate", "id": [ "40BSB00000YyRGT", "40BSB00000YyRGU" ] }, { "developerName": [ "exercises", "footwear" ], "entityName": "ExtDataTranObjectTemplate", "id": [ "17PSB0000008wMz", "17PSB0000008wN0" ] } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Undeploy data kit component `POST /ssot/data-kits/{dataKitName}/undeploy` Tags: Data Kits. Undeploy a component previously deployed from a data kit. The undeployment occurs in the sequential order of components specified in the request body. **Available Version:** 63.0 #### Parameters * `asyncMode` (query, boolean, required) Indicates whether the deployment is asynchronous. Only the `true` value is accepted. **Available Version:** 63.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 63.0 * `dataKitName` (path, string, required) Developer name of the data kit. **Available Version:** 63.0 #### Request body (required) Media type: `application/json`. Schema: `DataKitUnDeployInputRepresentation`. _Example: Example_ ``` { "components": [ { "type": "DataTransform", "name": "testDk__managed_stream_transform" }, { "type": "DataLakeObject", "name": "testDk__managed_dlo" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitAsyncRepresentation`. _Example: Example_ ``` { "jobId": "08PVF000000fHhd" } ``` ### GET Get data kit component dependency `GET /ssot/data-kits/{dataKitName}/components/{componentName}/dependencies` Tags: Data Kits. Get the dependencies for components deployed from a data kit. **Available Version:** 63.0 #### Parameters * `componentName` (path, string, required) Name of the component. **Available Version:** 63.0 * `dataKitName` (path, string, required) Developer name of the data kit. **Available Version:** 63.0 * `componentType` (query, string, required) Type of component. Valid values are: * `ActivationTarget` * `CalculatedInsight` * `DataAction` * `DataActionTarget` * `DataConnection` * `DataGraph` * `DataLakeObject` * `DataSemanticSearch` * `DataShare` * `DataStreamBundle` * `DataTransform` * `IdentityResolution` * `MarketSegment` * `MarketSegmentActivation` * `MlConfiguredModel` * `MlPredictionJob` * `MlRetriever` * `SemanticModel` **Available Version:** 63.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitComponentDependencyCollectionRepresentation`. _Example: Example_ ``` { "componentDependencies": [ { "id": "0gOVF000000UfTxYAK", "name": "managed_dlo", "type": "DataLakeObject" } ] } ``` ### GET Get data kit component status `GET /ssot/data-kits/{dataKitName}/components/{componentName}/deployment-status` Tags: Data Kits. Get the status of a component deployed from a data kit. **Available Version:** 62.0 #### Parameters * `componentName` (path, string, required) Name of the component. **Available Version:** 62.0 * `dataKitName` (path, string, required) Developer name of the data kit. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataKitComponentDeploymentStatusRepresentation`. _Example: Example_ ``` { "componentDetails": [ { "componentId": "0gOVF000000UfTxYAK", "dataKitName": "testDk__manageDk", "status": "Active" } ], "status": { "code": "ACTIVE", "message": "The Status of the component is ACTIVE" } } ``` ### GET Get data lake objects `GET /ssot/data-lake-objects` Tags: Data Lake Objects. Get a collection of all data lake objects (DLOs). **Available Version:** 60.0 #### Parameters * `limit` (query, integer) Maximum number of relationships to return. If unspecified, the default value is `20`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataLakeObjectCollectionRepresentation`. _Example: Example_ ``` { "dataLakeObjects": [ { "capabilities": {}, "category": "Other", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_id", "name": "KQ_id__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Org ID", "name": "SfdcOrganizationId__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "createddate__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "createdbyid__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "id__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "systemmodstamp__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Feature Name", "name": "featurename__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Feature State", "name": "featurestate__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Display Name", "name": "displayname__c" } ], "dataSpaceInfo": [], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_id", "name": "KQ_id__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Org ID", "name": "SfdcOrganizationId__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "createddate__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "createdbyid__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "id__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "systemmodstamp__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Feature Name", "name": "featurename__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Feature State", "name": "featurestate__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Display Name", "name": "displayname__c" } ], "id": "1dlSB000004BXhbYAG", "label": "ProvisionedFeature", "name": "ProvisionedFeature__dll", "namespace": "", "recordModifiedFieldName": "systemmodstamp__c", "status": "ACTIVE" }, { "capabilities": {}, "category": "Other", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Id", "name": "KQ_Id__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "Currency Static Conversion Rate Id", "name": "Id__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "From ISO Currency Code", "name": "FromISOCurrencyCode__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "To ISO Currency Code", "name": "ToISOCurrencyCode__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Rate Numerator", "name": "RateNumeratorNumber__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Rate Denominator", "name": "RateDenominatorNumber__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization__c" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Id", "name": "KQ_Id__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "Currency Static Conversion Rate Id", "name": "Id__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "From ISO Currency Code", "name": "FromISOCurrencyCode__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "To ISO Currency Code", "name": "ToISOCurrencyCode__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Rate Numerator", "name": "RateNumeratorNumber__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Rate Denominator", "name": "RateDenominatorNumber__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization__c" } ], "id": "1dlSB000004BXj7YAG", "label": "Static Currency Rates Home", "name": "StaticCurrencyRates_Home__dll", "namespace": "", "orgUnitIdentifierFieldName": "InternalOrganization__c", "status": "ACTIVE" } ] } ``` ### POST Create data lake object `POST /ssot/data-lake-objects` Tags: Data Lake Objects. Create a data lake object (DLO). **Available Version:** 60.0 #### Request body Media type: `application/json`. Schema: `DataLakeObjectInputRepresentation`. _Example: Example_ ``` { "name": "DataLakeObjectTwo", "label": "DataLakeObjectTwo", "category": "Profile", "dataspaceInfo": [ { "name": "default", "filter": { "conjunctiveOperator": "OrOperator", "conditionGroups": [], "conditions": { "conditions": [ { "fieldName": "FieldOne__c", "filterValue": "test", "operator": "EqualsOperator", "tableName": "DataLakeObjectTwo__dll" } ] } } } ], "orgUnitIdentifierFieldName": "", "recordModifiedFieldName": "", "dataLakeFieldInputRepresentations": [ { "name": "FieldOne", "label": "FieldOne", "dataType": "Text", "isPrimaryKey": "true" }, { "name": "FieldTwo", "label": "FieldTwo", "dataType": "Number", "isPrimaryKey": "false" }, { "name": "FieldThree", "label": "FieldThree", "dataType": "DateTime", "isPrimaryKey": "false" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataLakeObjectRepresentation`. _Example: Example_ ``` { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_FieldOne", "name": "KQ_FieldOne__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "FieldOne", "name": "FieldOne__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "FieldTwo", "name": "FieldTwo__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "FieldThree", "name": "FieldThree__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization__c" } ], "dataSpaceInfo": [ { "filter": { "conditions": [ { "fieldName": "FieldOne__c", "filterValue": "test", "operator": "EqualsOperator", "tableName": "DataLakeObjectTwo__dll" } ], "conjunctiveOperator": "OrOperator", "conditionGroups": [] }, "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_FieldOne", "name": "KQ_FieldOne__c" }, { "dataType": "Text", "isPrimaryKey": true, "label": "FieldOne", "name": "FieldOne__c" }, { "dataType": "Number", "isPrimaryKey": false, "label": "FieldTwo", "name": "FieldTwo__c" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "FieldThree", "name": "FieldThree__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject__c" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization__c" } ], "id": "1dlSB000004BpUjYAK", "label": "DataLakeObjectTwo", "name": "DataLakeObjectTwo__dll", "namespace": "", "status": "PROCESSING" } ``` ### GET Get data lake object `GET /ssot/data-lake-objects/{recordIdOrDeveloperName}` Tags: Data Lake Objects. Get a data lake object (DLO). **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) ID or developer name of the DLO. **Available Version:** 60.0 * `limit` (query, integer) Maximum number of relationships to return. If unspecified, the default value is `20`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataLakeObjectRepresentation`. _Example Example: same as POST /ssot/data-lake-objects 200 response._ ### DELETE Delete data lake object `DELETE /ssot/data-lake-objects/{recordIdOrDeveloperName}` Tags: Data Lake Objects. Delete a data lake object (DLO). **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) ID or developer name of the DLO. **Available Version:** 60.0 #### Responses * **204** Success ### PATCH Update data lake object `PATCH /ssot/data-lake-objects/{recordIdOrDeveloperName}` Tags: Data Lake Objects. Update a data lake object (DLO) by adding new fields or changing the label. **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) ID or developer name of the DLO. **Available Version:** 60.0 #### Request body Media type: `application/json`. Schema: `DataLakeObjectPatchInputRepresentation`. _Example: Example_ ``` { "label": "DataLakeObjectTWO", "dataLakeFieldInputRepresentations": [ { "name": "FieldFour", "label": "FieldFour", "dataType": "Text", "isPrimaryKey": "false" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataLakeObjectRepresentation`. _Example Example: same as POST /ssot/data-lake-objects 200 response._ ### GET Get data model objects `GET /ssot/data-model-objects` Tags: Data Model Objects. Get a paginated list of all data model objects (DMOs). **Available Version:** 61.0 #### Parameters * `limit` (query, integer) Maximum number of DMOs to return. If unspecified, the default value is `50`. **Available Version:** 61.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 61.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataModelObjectCollectionRepresentation`. _Example: Example_ ``` { "dataModelObject": [ { "category": "UNASSIGNED", "creationType": "Standard", "dataSpaceName": "default", "fields": [ { "creationType": "Standard", "isDistinct": false, "label": "Academic Term Id", "name": "ssot__AcademicTermId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "isPrimaryKey": true, "label": "Academic Term Registration Timeline Id", "name": "ssot__Id__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Category", "name": "ssot__Category__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source", "name": "ssot__DataSourceId__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source Object", "name": "ssot__DataSourceObjectId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Default", "name": "ssot__IsDefault__c", "type": "Boolean", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Description", "name": "ssot__Description__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Internal Organization", "name": "ssot__InternalOrganizationId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Name", "name": "ssot__Name__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Published", "name": "ssot__IsPublished__c", "type": "Boolean", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Registration Close Date", "name": "ssot__RegistrationCloseDate__c", "type": "Date", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Registration Open Date", "name": "ssot__RegistrationOpenDate__c", "type": "Date", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Student Academic Level", "name": "ssot__StudentAcademicLevel__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Study Year Classification", "name": "ssot__StudyYearClassification__c", "type": "Text", "usageTag": "None" } ], "hasExternalDataLakeObjectMappings": false, "id": "0gjSB00000FBlzCYAT", "isEditable": false, "isEnabled": false, "isSegmentable": false, "label": "Academic Term Registration Timeline", "name": "ssot__AcademicTermRegstrnTimeline__dlm" }, { "category": "UNASSIGNED", "creationType": "Standard", "dataSpaceName": "default", "fields": [ { "creationType": "Standard", "isDistinct": false, "isPrimaryKey": true, "label": "Academic Year Id", "name": "ssot__Id__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source", "name": "ssot__DataSourceId__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source Object", "name": "ssot__DataSourceObjectId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Description", "name": "ssot__Description__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Internal Organization", "name": "ssot__InternalOrganizationId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Name", "name": "ssot__Name__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Year", "name": "ssot__YearText__c", "type": "Text", "usageTag": "None" } ], "hasExternalDataLakeObjectMappings": false, "id": "0gjSB00000FBlzEYAT", "isEditable": false, "isEnabled": false, "isSegmentable": false, "label": "Academic Year", "name": "ssot__AcademicYear__dlm" } ] } ``` * **400** Number outside valid range. Maximum SOQL offset allowed for apiName MktDataModelObject is 2000. ### POST Create data model object `POST /ssot/data-model-objects` Tags: Data Model Objects. Create a custom data model object (DMO). **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `DataModelObjectInputRepresentation`. _Example: Example_ ``` { "name": "CustomDMO", "label": "CustomDMO", "description": "This is a Custom DMO", "dataSpaceName": "default", "category": "PROFILE", "fields": [ { "name": "CustomDMO123", "label": "CustomDMO123", "description": "This is the first Custom DMO field.", "isPrimaryKey": true, "isDynamicLookup": false, "dataType": "Date" }, { "name": "CustomDMO456", "label": "CustomDMO456", "description": "This is the second Custom DMO field.", "isPrimaryKey": false, "isDynamicLookup": false, "dataType": "DateTime" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataModelObjectRepresentation`. _Example: Example_ ``` { "category": "PROFILE", "creationType": "Custom", "dataSpaceName": "default", "description": "This is a Custom DMO", "fields": [ { "creationType": "Custom", "isDistinct": false, "isPrimaryKey": true, "keyQualifierName": "KQ_CustomDMO123", "label": "CustomDMO123", "name": "CustomDMO123__c", "type": "Date", "usageTag": "None" }, { "creationType": "Custom", "isDistinct": false, "label": "CustomDMO456", "name": "CustomDMO456__c", "type": "DateTime", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source", "name": "DataSource__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source Object", "name": "DataSourceObject__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Internal Organization", "name": "InternalOrganization__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Key Qualifier CustomDMO123", "name": "KQ_CustomDMO123__c", "type": "Text", "usageTag": "KeyQualifier" } ], "hasExternalDataLakeObjectMappings": false, "id": "0gjSB00000FsETZYA3", "isEditable": true, "isEnabled": false, "isSegmentable": false, "label": "CustomDMO", "name": "CustomDMO__dlm" } ``` * **400** Invalid input or duplicate developer name. For example: * The Object API Name field can contain only alphanumeric characters and underscores. It must be unique, begin with a letter, not include spaces, not end with an underscore, not start with SSOT for custom DMOs, and not contain two consecutive underscores. * Developer name already exists for given entity or has been previously used. Choose a different name. ### GET Get data model object `GET /ssot/data-model-objects/{dataModelObjectName}` Tags: Data Model Objects. Get a data model object (DMO). **Available Version:** 61.0 #### Parameters * `dataModelObjectName` (path, string, required) Developer name of the DMO. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataModelObjectRepresentation`. _Example: Example_ ``` { "category": "UNASSIGNED", "creationType": "Standard", "dataSpaceName": "default", "fields": [ { "creationType": "Standard", "isDistinct": false, "label": "Activity DateTime", "name": "ssot__ActivityDateTime__c", "type": "DateTime", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "isPrimaryKey": true, "label": "Activity Id", "name": "ssot__Id__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Activity Type", "name": "ssot__ActivityType__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Created By", "name": "ssot__CreatedById__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Created Date", "name": "ssot__CreatedDate__c", "type": "DateTime", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source", "name": "ssot__DataSourceId__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source Object", "name": "ssot__DataSourceObjectId__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Internal Organization", "name": "ssot__InternalOrganizationId__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Snippet", "name": "ssot__SnippetText__c", "type": "Text", "usageTag": "None" }, { "creationType": "Standard", "isDistinct": false, "label": "Subject", "name": "ssot__SubjectText__c", "type": "Text", "usageTag": "None" } ], "hasExternalDataLakeObjectMappings": false, "id": "0gjSB00000FBlzeYAD", "isEditable": false, "isEnabled": false, "isSegmentable": false, "label": "Activity", "name": "ssot__Activity__dlm" } ``` * **404** No record exists or user might not have access to DMO with developer name: _dataModelObjectName_. ### DELETE Delete data model object `DELETE /ssot/data-model-objects/{dataModelObjectName}` Tags: Data Model Objects. Delete a standard or custom data model object (DMO). **Available Version:** 61.0 #### Parameters * `dataModelObjectName` (path, string, required) Developer name of the DMO. **Available Version:** 61.0 #### Responses * **204** Success * **404** Not found. ### PATCH Update data model object `PATCH /ssot/data-model-objects/{dataModelObjectName}` Tags: Data Model Objects. Update a custom data model object (DMO). The state of the DMO prior to the patch update is returned. To view the latest updates, send this request again or use the [get data model object](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObject) endpoint. **Available Version:** 61.0 #### Parameters * `dataModelObjectName` (path, string, required) Developer name of the DMO. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `DataModelObjectInputRepresentation`. _Example: Example_ ``` { "name": "CustomDMO__dlm", "label": "CustomDMO", "description": "This is an updated custom DMO.", "dataSpaceName": "default", "category": "PROFILE", "fields": [ { "name": "CustomDMO789", "label": "CustomDMO789", "description": "This is the new second Custom DMO field.", "isPrimaryKey": false, "isDynamicLookup": false, "dataType": "DateTime" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataModelObjectRepresentation`. _Example: Example_ ``` { "category": "PROFILE", "creationType": "Custom", "dataSpaceName": "default", "description": "This is an updated custom DMO.", "fields": [ { "creationType": "Custom", "isDistinct": false, "isPrimaryKey": true, "keyQualifierName": "KQ_CustomDMO123", "label": "CustomDMO123", "name": "CustomDMO123__c", "type": "Date", "usageTag": "None" }, { "creationType": "Custom", "isDistinct": false, "label": "CustomDMO456", "name": "CustomDMO456__c", "type": "DateTime", "usageTag": "None" }, { "creationType": "Custom", "isDistinct": false, "label": "CustomDMO789", "name": "CustomDMO789__c", "type": "DateTime", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source", "name": "DataSource__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Data Source Object", "name": "DataSourceObject__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Internal Organization", "name": "InternalOrganization__c", "type": "Text", "usageTag": "None" }, { "creationType": "System", "isDistinct": false, "label": "Key Qualifier CustomDMO123", "name": "KQ_CustomDMO123__c", "type": "Text", "usageTag": "KeyQualifier" } ], "hasExternalDataLakeObjectMappings": false, "id": "0gjSB00000FsETZYA3", "isEditable": true, "isEnabled": false, "isSegmentable": false, "label": "CustomDMO", "name": "CustomDMO__dlm" } ``` * **400** Invalid input. For example: * Data model object developer name cannot be updated. * Some of the data model fields do not have a data type. Verify the data type for following fields: _field name(s)_. ### GET Get data model object mappings `GET /ssot/data-model-object-mappings` Tags: Data Model Objects. Get the details of all mappings associated with a data model object (DMO). **Available Version:** 61.0 #### Parameters * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 * `dloDeveloperName` (query, string) Developer name of the data lake object (DLO) source object. **Available Version:** 61.0 * `dmoDeveloperName` (query, string, required) Developer name of the DMO target object. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpObjectSourceTargetMapCollectionRepresentation`. _Example: Example_ ``` { "objectSourceTargetMaps": [ { "developerName": "exercise_map_Account_1755672548340", "fieldMappings": [ { "developerName": "DataSource__c_fieldmap_ssot__DataSourceId__c", "sourceFieldDeveloperName": "DataSource__c", "targetFieldDeveloperName": "ssot__DataSourceId__c" }, { "developerName": "runid__c_fieldmap_ssot__Id__c", "sourceFieldDeveloperName": "runid__c", "targetFieldDeveloperName": "ssot__Id__c" }, { "developerName": "KQ_runid__c_fieldmap_KQ_Id__c", "sourceFieldDeveloperName": "KQ_runid__c", "targetFieldDeveloperName": "KQ_Id__c" }, { "developerName": "DataSourceObject__c_fieldmap_ssot__DataSourceObjectId__c", "sourceFieldDeveloperName": "DataSourceObject__c", "targetFieldDeveloperName": "ssot__DataSourceObjectId__c" }, { "developerName": "type__c_fieldmap_ssot__Name__c", "sourceFieldDeveloperName": "type__c", "targetFieldDeveloperName": "ssot__Name__c" }, { "developerName": "InternalOrganization__c_fieldmap_ssot__InternalOrganizationId__c", "sourceFieldDeveloperName": "InternalOrganization__c", "targetFieldDeveloperName": "ssot__InternalOrganizationId__c" } ], "sourceEntityDeveloperName": "exercise__dll", "status": "ACTIVE", "targetEntityDeveloperName": "ssot__Account__dlm" }, { "developerName": "StaticCurrencyRates_Home_map_Account_1755673249962", "fieldMappings": [ { "developerName": "FromISOCurrencyCode__c_fieldmap_ssot__AccountBusinessType__c", "sourceFieldDeveloperName": "FromISOCurrencyCode__c", "targetFieldDeveloperName": "ssot__AccountBusinessType__c" }, { "developerName": "DataSource__c_fieldmap_ssot__DataSourceId__c", "sourceFieldDeveloperName": "DataSource__c", "targetFieldDeveloperName": "ssot__DataSourceId__c" }, { "developerName": "DataSourceObject__c_fieldmap_ssot__DataSourceObjectId__c", "sourceFieldDeveloperName": "DataSourceObject__c", "targetFieldDeveloperName": "ssot__DataSourceObjectId__c" }, { "developerName": "Id__c_fieldmap_ssot__Id__c", "sourceFieldDeveloperName": "Id__c", "targetFieldDeveloperName": "ssot__Id__c" }, { "developerName": "KQ_Id__c_fieldmap_KQ_Id__c", "sourceFieldDeveloperName": "KQ_Id__c", "targetFieldDeveloperName": "KQ_Id__c" }, { "developerName": "InternalOrganization__c_fieldmap_ssot__InternalOrganizationId__c", "sourceFieldDeveloperName": "InternalOrganization__c", "targetFieldDeveloperName": "ssot__InternalOrganizationId__c" } ], "sourceEntityDeveloperName": "StaticCurrencyRates_Home__dll", "status": "ACTIVE", "targetEntityDeveloperName": "ssot__Account__dlm" } ] } ``` * **400** DMO or source object (CRM) developer name is missing. * **404** Not found. For example: * Object source target map not found for the given target object developer name: _dmoDeveloperName_. * DLO not found for the given developer name: _dloDeveloperName_. ### POST Create data model object mapping `POST /ssot/data-model-object-mappings` Tags: Data Model Objects. Create a new mapping between a data lake object (DLO) source and a data model object (DMO) target. > **Note:** Refer to the [Data 360 DMO Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/dmo-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 61.0 #### Parameters * `dataspace` (query, string, required) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `CdpObjectSourceTargetMapInputRepresentation`. _Example: Example_ ``` { "sourceEntityDeveloperName": "test1__dll", "targetEntityDeveloperName": "ssot__AcademicYear__dlm", "fieldMapping": [ { "sourceFieldDeveloperName": "eventinstanceid__c", "targetFieldDeveloperName": "ssot__Id__c" }, { "sourceFieldDeveloperName": "EmailAddress__c", "targetFieldDeveloperName": "ssot__Name__c" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpObjectSourceTargetMapRepresentation`. _Example: Example_ ``` { "developerName": "test1_map_AcademicYear_1756753400979", "fieldMappings": [ { "developerName": "eventinstanceid__c_fieldmap_ssot__Id__c", "sourceFieldDeveloperName": "eventinstanceid__c", "targetFieldDeveloperName": "ssot__Id__c" }, { "developerName": "KQ_eventinstanceid__c_fieldmap_KQ_Id__c", "sourceFieldDeveloperName": "KQ_eventinstanceid__c", "targetFieldDeveloperName": "KQ_Id__c" }, { "developerName": "DataSource__c_fieldmap_ssot__DataSourceId__c", "sourceFieldDeveloperName": "DataSource__c", "targetFieldDeveloperName": "ssot__DataSourceId__c" }, { "developerName": "DataSourceObject__c_fieldmap_ssot__DataSourceObjectId__c", "sourceFieldDeveloperName": "DataSourceObject__c", "targetFieldDeveloperName": "ssot__DataSourceObjectId__c" }, { "developerName": "EmailAddress__c_fieldmap_ssot__Name__c", "sourceFieldDeveloperName": "EmailAddress__c", "targetFieldDeveloperName": "ssot__Name__c" }, { "developerName": "InternalOrganization__c_fieldmap_ssot__InternalOrganizationId__c", "sourceFieldDeveloperName": "InternalOrganization__c", "targetFieldDeveloperName": "ssot__InternalOrganizationId__c" } ], "sourceEntityDeveloperName": "test1__dll", "status": "CREATING", "targetEntityDeveloperName": "ssot__AcademicYear__dlm" } ``` * **400** Invalid input or missing argument. For example: * Source entity developer name in request body is missing. * Unable to find the primary key of the DLO in POST request of mapping creation. * **404** Not found. For example: * DLO not found for the given developer name: _sourceEntityDeveloperName_. ### GET Get data model object mapping `GET /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}` Tags: Data Model Objects. Get the details of a data model object (DMO) mapping. > **Note:** Refer to the [Data 360 DMO Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/dmo-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 61.0 #### Parameters * `objectSourceTargetMapDeveloperName` (path, string, required) Developer name of the object source target mapping between a DLO and a DMO. Retrieve this value from the [get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObjectMappingCollection) endpoint. **Available Version:** 61.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpObjectSourceTargetMapRepresentation`. _Example: Example_ ``` { "developerName": "StaticCurrencyRates_Home_map_StaticCurrencyRates_Home_1754427001213", "fieldMappings": [ { "developerName": "FromISOCurrencyCode__c_fieldmap_FromISOCurrencyCode__c", "sourceFieldDeveloperName": "FromISOCurrencyCode__c", "targetFieldDeveloperName": "FromISOCurrencyCode__c" }, { "developerName": "DataSource__c_fieldmap_DataSourceId__c", "sourceFieldDeveloperName": "DataSource__c", "targetFieldDeveloperName": "DataSourceId__c" }, { "developerName": "ToISOCurrencyCode__c_fieldmap_ToISOCurrencyCode__c", "sourceFieldDeveloperName": "ToISOCurrencyCode__c", "targetFieldDeveloperName": "ToISOCurrencyCode__c" }, { "developerName": "DataSourceObject__c_fieldmap_DataSourceObjectId__c", "sourceFieldDeveloperName": "DataSourceObject__c", "targetFieldDeveloperName": "DataSourceObjectId__c" }, { "developerName": "Id__c_fieldmap_Id__c", "sourceFieldDeveloperName": "Id__c", "targetFieldDeveloperName": "Id__c" }, { "developerName": "KQ_Id__c_fieldmap_KQ_Id__c", "sourceFieldDeveloperName": "KQ_Id__c", "targetFieldDeveloperName": "KQ_Id__c" }, { "developerName": "RateNumeratorNumber__c_fieldmap_RateNumeratorNumber__c", "sourceFieldDeveloperName": "RateNumeratorNumber__c", "targetFieldDeveloperName": "RateNumeratorNumber__c" }, { "developerName": "RateDenominatorNumber__c_fieldmap_RateDenominatorNumber__c", "sourceFieldDeveloperName": "RateDenominatorNumber__c", "targetFieldDeveloperName": "RateDenominatorNumber__c" }, { "developerName": "InternalOrganization__c_fieldmap_InternalOrganizationId__c", "sourceFieldDeveloperName": "InternalOrganization__c", "targetFieldDeveloperName": "InternalOrganizationId__c" } ], "sourceEntityDeveloperName": "StaticCurrencyRates_Home__dll", "status": "ACTIVE", "targetEntityDeveloperName": "StaticCurrencyRates_Home__dlm" } ``` * **404** Object source target map not found for the given name: _objectSourceTargetMapDeveloperName_. ### DELETE Delete data model object mapping `DELETE /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}` Tags: Data Model Objects. Delete a mapping between a data lake object (DLO) source and a data model object (DMO) target. **Available Version:** 61.0 #### Parameters * `objectSourceTargetMapDeveloperName` (path, string, required) Developer name of the object source target mapping between a DLO and a DMO. Retrieve this value from the [get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObjectMappingCollection) endpoint. **Available Version:** 61.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 #### Responses * **200** Success * **404** Object source target map not found for the given name: _objectSourceTargetMapDeveloperName_. ### DELETE Delete data model object field mapping `DELETE /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings` Tags: Data Model Objects. Delete a field mapping between a data lake object (DLO) source and a data model object (DMO) target. **Available Version:** 61.0 #### Parameters * `objectSourceTargetMapDeveloperName` (path, string, required) Developer name of the object source target mapping between a DLO and a DMO. Retrieve this value from the [get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObjectMappingCollection) endpoint. **Available Version:** 61.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 #### Responses * **200** Success * **404** Object source target map not found for the given name: _objectSourceTargetMapDeveloperName_. ### PATCH Delete data model object field mapping `PATCH /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings/{fieldSourceTargetMapDeveloperName}` Tags: Data Model Objects. Add or update field mappings between a data lake object (DLO) source and a data model object (DMO) target. > **Note:** Refer to the [Data 360 DMO Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/dmo-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 61.0 #### Parameters * `fieldSourceTargetMapDeveloperName` (path, string) Developer name of the field source target mapping between a DLO and a DMO. Required when adding new field mappings. Retrieve this value from the [get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObjectMappingCollection) endpoint. **Available Version:** 61.0 * `objectSourceTargetMapDeveloperName` (path, string, required) Developer name of the object source target mapping between a DLO and a DMO. Retrieve this value from the [get data model object mappings](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getDataModelObjectMappingCollection) endpoint. **Available Version:** 61.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `CdpObjectSourceTargetMapInputRepresentation`. _Example: Example_ ``` { "sourceEntityDeveloperName": "StaticCurrencyRates_Home__dll", "targetEntityDeveloperName": "StaticCurrencyRates_Home__dlm", "fieldMapping": [ { "sourceFieldDeveloperName": "InternalOrganization__c", "targetFieldDeveloperName": "InternalOrganizationId__c" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpObjectSourceTargetMapRepresentation`. _Example Example: same as GET /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName} 200 response._ * **400** Invalid input. For example: * Source entity developer name in request body is missing. * Field mapping(s) in request body is missing. * **404** Not found. For example: * Object source target map not found for the given name: _objectSourceTargetMapDeveloperName_. ### DELETE Delete field source target relationship `DELETE /ssot/data-model-objects/relationships/{name}` Tags: Data Model Objects. Delete a data model object (DMO) relationship between a field in the source DMO and a field in the target DMO. **Available Version:** 64.0 #### Parameters * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 64.0 * `name` (path, string, required) ID or developer name of the field source target relationship. **Available Version:** 64.0 #### Responses * **200** Success ### GET Get field source target relationships `GET /ssot/data-model-objects/{dataModelObjectName}/relationships` Tags: Data Model Objects. Get the details of all data model object (DMO) relationships between fields in the source DMO and fields in the target DMO. **Available Version:** 64.0 #### Parameters * `dataModelObjectName` (path, string, required) Name of the data model object (DMO), which is either the source DMO or the target DMO. **Available Version:** 64.0 * `creationType` (query, string) Filter the returned results based on relationship creation type. **Available Version:** 64.0 Allowed values: `CalculatedInsight`, `Curated`, `Custom`, `SegmentMembership`, `Standard`, `System`. * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 64.0 * `limit` (query, integer) Maximum number of relationships to return. If unspecified, the default value is `20`. **Available Version:** 64.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 64.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 64.0 Allowed values: `FilterSortOrderAsc`, `FilterSortOrderDesc`. * `sortBy` (query, string) The field on which the results are to be sorted. **Available Version:** 64.0 * `status` (query, string) Filter the returned results based on relationship status. **Available Version:** 64.0 Allowed values: `Active`, `Creating`, `DeactivateByUser`, `Deleting`, `Error`, `Inactive`, `Updating`. #### Responses * **200** Success Media type: `application/json`. Schema: `FieldSrcTrgtRelationshipCollectionRepresentation`. _Example: Example_ ``` { "relationships": [ { "id": "0gexx00000000MbAAI", "name": "ds1_Individual_Id_map_ds1_DataSpace1Dmo_Id_1726382174104", "sourceEntity": { "name": "ds1_Individual__dlm", "label": "Individual", "keyQualifierField": "KQ_Id" }, "sourceField": { "name": "Id__c", "label": "Id", "type": "MktDataModelField" }, "targetEntity": { "name": "ds1_DataSpace1Dmo__dlm", "label": "DataSpace1Dmo", "keyQualifierField": "KQ_Id" }, "cardinality": "ManyToOne", "status": "ACTIVE", "owner": "DataCloud", "creationType": "Custom" }, { "id": "0gexx00000000fxAAA", "name": "ds1_ds1CI_id_dim_map_ds1_DataSpace1Dmo_Id_1727463748432", "sourceEntity": { "name": "ds1_ds1CI__cio", "label": "ds1CI", "keyQualifierField": null }, "sourceField": { "name": "id_dim__c", "label": "Id_Dim", "type": "MktCalculatedInsightField" }, "targetEntity": { "name": "ds1_DataSpace1Dmo__dlm", "label": "DataSpace1Dmo", "keyQualifierField": "KQ_Id" }, "targetField": { "name": "Id__c", "label": "Id", "type": "MktDataModelField" }, "cardinality": "ManyToOne", "status": "CREATING", "owner": "DataCloud", "creationType": "Calculated_Insight" } ], "count": 20, "currentPageToken": "abcd1234=", "currentPageUrl": "/services/data/v63.0/ssot/field-source-target-relationships?dataspace=ds1&dmoDeveloperName=ds1_Individual__dlm&limit=20&offset=20&orderBy=ASC&pageToken=abcd1234%3D&sortBy=DeveloperName", "nextPageToken": "efgh5678=", "nextPageUrl": "/services/data/v63.0/ssot/field-source-target-relationships?dataspace=ds1&dmoDeveloperName=ds1_Individual__dlm&limit=20&offset=40&orderBy=ASC&pageToken=efgh5678%3D&sortBy=DeveloperName", "previousPageToken": "ijkl9012==", "previousPageUrl": "/services/data/v63.0/ssot/field-source-target-relationships?dataspace=ds1&dmoDeveloperName=ds1_Individual__dlm&limit=20&offset=0&orderBy=ASC&pageToken=ijkl9012%3D%3D&sortBy=DeveloperName", "sortBy": "DeveloperName", "totalSize": 66 } ``` ### POST Create field source target relationships `POST /ssot/data-model-objects/{dataModelObjectName}/relationships` Tags: Data Model Objects. Create bulk data model object (DMO) relationships between fields in the source DMO and fields in the target DMO. If a relationship already exists, it is skipped. **Available Version:** 64.0 #### Parameters * `dataModelObjectName` (path, string, required) Name of the data model object (DMO), which is either the source DMO or the target DMO. **Available Version:** 64.0 * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 64.0 #### Request body (required) Media type: `application/json`. Schema: `FieldSrcTrgtRelationshipCollectionInputRepresentation`. _Example: Example_ ``` { "relationships": [ { "sourceObjectName": "ds1_example1__dlm", "targetObjectName": "ds1_example2__dlm", "cardinality": "ManyToOne", "creationType": "Custom", "sourceFieldName": "field1__c", "targetFieldName": "field2__c", "owner": "DataCloud" }, { "sourceObjectName": "ds1_example1__dlm", "targetObjectName": "ds1_example3__dlm", "cardinality": "ManyToOne", "creationType": "Custom", "sourceFieldName": "field3__c", "targetFieldName": "field2__c", "owner": "DataCloud" }, { "sourceObjectName": "ds1_example1__dlm", "targetObjectName": "ds1_Individual__dlm", "cardinality": "ManyToOne", "creationType": "Custom", "sourceFieldName": "field1__c", "targetFieldName": "Age__c", "owner": "DataCloud" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `FieldSrcTrgtRelationshipCollectionRepresentation`. _Example Example: same as GET /ssot/data-model-objects/{dataModelObjectName}/relationships 200 response._ ### GET Get data shares `GET /ssot/data-shares` Tags: Data Shares. Returns all data shares in the org, ordered by developer name. **Available Version:** 63.0 #### Parameters * `limit` (query, integer) Maximum number of data shares to return. **Available Version:** 63.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v63.0/ssot/data-shares?limit=10&offset=0", "nextPageUrl": null, "totalSize": 2, "dataShares": [ { "dataShareObjects": { "names": [ "Account_Home__dll", "Sales_Order__dlm", "Contact_Point_Email__cio" ] }, "dataspaceName": "default", "id": "1edxx0000000001AAA", "label": "Sales Data Share", "name": "Sales_Data_Share", "status": "Active" }, { "dataShareObjects": { "names": [ "IndividualGDPRState__dlm", "IndividualGDPRState__dll", "Privacy_Consent__cio" ] }, "dataspaceName": "default", "id": "1edxx0000000002AAA", "label": "Marketing Data Share", "name": "Marketing_Data_Share", "status": "Active" } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create data share `POST /ssot/data-share` Tags: Data Shares. Creates a data share and adds the data model object (DMO), data lake object (DLO), and calculated insight object (CIO) to it. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataShareInputRepresentation`. _Example: example1_ ``` { "name": "Sales_Data_Share", "label": "Sales Data Share", "dataspaceName": "default", "description": "Shares sales DMOs and DLOs with external partners", "dataShareObjects": { "names": [ "Account_Home__dll", "Sales_Order__dlm", "Contact_Point_Email__cio" ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareRepresentation`. _Example: example1_ ``` { "dataShareObjects": { "names": [ "IndividualGDPRState__dlm", "IndividualGDPRState__dll" ] }, "dataspaceName": "default", "id": "1edxx0000000001AAA", "label": "Sales_Data_Share", "name": "Sales_Data_Share", "status": "PROCESSING" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data share `GET /ssot/data-share/{nameOrId}` Tags: Data Shares. Returns a data share with its object names. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or record ID of the data share. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareRepresentation`. _Example example1: same as POST /ssot/data-share 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### DELETE Delete data share `DELETE /ssot/data-share/{nameOrId}` Tags: Data Shares. Deletes a data share. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or record ID of the data share. **Available Version:** 63.0 #### Responses * **200** Success * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### PATCH Update data share `PATCH /ssot/data-share/{nameOrId}` Tags: Data Shares. Updates a data share and adds the data model object (DMO), data lake object (DLO), and calculated insight object (CIO) to it. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or record ID of the data share. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataSharePatchInputRepresentation`. _Example: example1_ ``` { "label": "Sales Data Share (Updated)", "description": "Added order-line DMO", "dataShareObjects": { "names": [ "Account_Home__dll", "Sales_Order__dlm", "Sales_Order_Line__dlm", "Contact_Point_Email__cio" ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareRepresentation`. _Example example1: same as POST /ssot/data-share 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Link data share with target `POST /ssot/data-share/{nameOrId}/actions/link` Tags: Data Shares. Links a data share with a data share target. If the target is already linked, the operation is idempotent and no changes are made. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or ID of the data share. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataShareLinkActionInputRepresentation`. _Example: example1_ ``` { "dataShareTargetNames": [ "Snowflake_Prod_Target", "BigQuery_Analytics_Target" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareRepresentation`. _Example example1: same as POST /ssot/data-share 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Unlink data share with target `POST /ssot/data-share/{nameOrId}/actions/unlink` Tags: Data Shares. Unlinks a data share from a data share target. If the target is already unlinked, the operation is idempotent and no changes are made. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or ID of the data share. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataShareUnlinkActionInputRepresentation`. _Example: example1_ ``` { "dataShareTargetNames": [ "BigQuery_Analytics_Target" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareRepresentation`. _Example example1: same as POST /ssot/data-share 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data share targets `GET /ssot/data-share-targets/{targetType}` Tags: Data Shares. Returns all data share targets of a given target type. **Available Version:** 63.0 #### Parameters * `targetType` (path, string, required) Type of data share target. Possible values are `Aws`, `BigQuery`, `Databricks`, `Datacloud`, `Ibm`, `Other`, `Snowflake`, and `SnowflakeOpenFlow`. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareTargetCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v63.0/ssot/data-share-targets/Snowflake", "nextPageUrl": null, "totalSize": 1, "dataShareTargets": [ { "id": "0v9xx0000000001AAA", "name": "Snowflake_Prod_Target", "label": "Snowflake Prod Target", "targetType": "Snowflake", "status": "Active", "accountUrl": "https://myorg-account.snowflakecomputing.com", "subType": "CleanRoom" } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create data share target `POST /ssot/data-share-target` Tags: Data Shares. Creates a data share target of a particular target type. **Available Version:** 63.0 #### Request body Media type: `application/json`. Schema: `DataShareTargetInputRepresentation`. _Example: AWS request_ ``` { "targetType": "Aws", "name": "Aws_S3_Target", "label": "AWS S3 Target", "dataspaceName": "default", "description": "AWS data share target", "accountId": "123456789012", "subType": "Aws", "awsRoleArn": "arn:aws:iam::123456789012:role/DataCloudShareRole" } ``` _Example: BigQuery request_ ``` { "targetType": "BigQuery", "name": "BigQuery_Analytics_Target", "label": "BigQuery Analytics Target", "dataspaceName": "default", "description": "BigQuery target for analytics team", "targetEmailId": "analytics-team@myorg.iam.gserviceaccount.com", "targetEmailType": "ServiceAccount" } ``` _Example: Databricks request_ ``` { "targetType": "Databricks", "name": "Databricks_Target", "label": "Databricks Target", "dataspaceName": "default", "description": "Databricks data share target", "serviceAccountId": "svc-databricks-001", "accountUrl": "https://dbc-a1b2c3d4-e5f6.cloud.databricks.com" } ``` _Example: Datacloud request_ ``` { "targetType": "Datacloud", "name": "Datacloud_Partner_Target", "label": "Data Cloud Partner Target", "dataspaceName": "default", "description": "Share to another Data Cloud org", "targetOrgId": "00DED000000XXXX2AG", "subType": "DatacloudToDatacloud", "targetUrl": "https://partner-org.my.salesforce.com" } ``` _Example: Snowflake request_ ``` { "targetType": "Snowflake", "name": "Snowflake_Prod_Target", "label": "Snowflake Prod Target", "dataspaceName": "default", "description": "Snowflake production data share target", "accountUrl": "https://myorg-account.snowflakecomputing.com", "subType": "CleanRoom" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareTargetRepresentation`. _Example: AWS response_ ``` { "id": "0v9xx0000000001AAA", "name": "Aws_S3_Target", "label": "AWS S3 Target", "targetType": "Aws", "status": "Active", "accountId": "123456789012", "awsRoleArn": "arn:aws:iam::123456789012:role/DataCloudShareRole", "subType": "Aws" } ``` _Example: BigQuery response_ ``` { "id": "0v9xx0000000002AAA", "name": "BigQuery_Analytics_Target", "label": "BigQuery Analytics Target", "targetType": "BigQuery", "status": "Active", "targetEmailId": "abc@salesforce.com", "targetEmailType": "User" } ``` _Example: Databricks response_ ``` { "id": "0v9xx0000000003AAA", "name": "Databricks_Target", "label": "Databricks Target", "targetType": "Databricks", "status": "Active", "accountUrl": "https://dbc-a1b2c3d4-e5f6.cloud.databricks.com", "serviceAccountId": "svc-databricks-001" } ``` _Example: Datacloud response_ ``` { "id": "0v9xx0000000004AAA", "name": "Datacloud_Partner_Target", "label": "Data Cloud Partner Target", "targetType": "Datacloud", "status": "Active", "targetOrgId": "00DED000000XXXX2AG", "subType": "DatacloudToDatacloud" } ``` _Example: Snowflake response_ ``` { "id": "0v9xx0000000005AAA", "name": "Snowflake_Prod_Target", "label": "Snowflake Prod Target", "targetType": "Snowflake", "status": "Active", "accountUrl": "https://myorg-account.snowflakecomputing.com", "subType": "CleanRoom" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data share target `GET /ssot/data-share-target/{nameOrId}` Tags: Data Shares. Returns a data share target. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or record ID of the data share target. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataShareTargetRepresentation`. _Example: example1_ ``` { "id": "0v9xx0000000001AAA", "name": "Snowflake_Prod_Target", "label": "Snowflake Prod Target", "targetType": "Snowflake", "status": "Active", "accountUrl": "https://myorg-account.snowflakecomputing.com", "subType": "CleanRoom" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### DELETE Delete data share target `DELETE /ssot/data-share-target/{nameOrId}` Tags: Data Shares. Deletes a data share target. **Available Version:** 63.0 #### Parameters * `nameOrId` (path, string, required) API name or record ID of the data share target. **Available Version:** 63.0 #### Responses * **200** Success * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get data spaces `GET /ssot/data-spaces` Tags: Data Spaces. Get a collection of all data spaces that a user is assigned to. **Available Version:** 62.0 #### Parameters * `limit` (query, integer) The maximum number of items to return in each response. Values are from `1` through `4999`. The default value is `50` if unspecified. **Available Version:** 62.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 62.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "", "dataSpaces": [ { "description": "Your org’s default data space. It can be renamed, but not deleted.", "id": "0vhSB000001bekHYAQ", "label": "default", "name": "default", "status": "Active" }, { "description": "Custom data space.", "id": "0vhSB000001bqwjYAA", "label": "nonDefault", "name": "nonDefault", "prefix": "ndf", "status": "Active" } ], "totalSize": 2 } ``` * **500** Internal server error. ### POST Create data space `POST /ssot/data-spaces` Tags: Data Spaces. Create a new data space based on the input details provided. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `DataSpaceInputRepresentation`. _Example: Example_ ``` { "label": "nonDefault", "prefix": "ndf", "description": "Custom data space." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceInfoRepresentation`. _Example: Example_ ``` { "description": "Custom data space.", "id": "0vhSB000001bqwjYAA", "label": "nonDefault", "name": "nonDefault", "prefix": "ndf", "status": "Active" } ``` * **400** Bad request. * **403** CONFLICT: Data space with name: _dataSpaceName_ already exists. Please provide a different name. * **409** Forbidden. * **500** Internal server error. ### GET Get data space `GET /ssot/data-spaces/{idOrName}` Tags: Data Spaces. Return the specified data space. **Available Version:** 62.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceInfoRepresentation`. _Example: Example_ ``` { "description": "Custom data space.", "id": "0vhSB000001bqwjYAA", "label": "nonDefault", "name": "nonDefault", "prefix": "ndf", "status": "Active" } ``` * **404** Not found. * **500** Internal server error. ### DELETE Delete data space `DELETE /ssot/data-spaces/{idOrName}` Tags: Data Spaces. Delete the specified data space. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 62.0 #### Responses * **204** Success * **403** INSUFFICIENT\_ACCESS\_OR\_READONLY: Data space cannot be deleted because user lacks required permissions. * **404** NOT\_FOUND: Data space with idOrName: _idOrName_ doesn't exist. * **412** REFERENTIAL\_INTEGRITY\_VIOLATION: Data space cannot be deleted due to existing dependencies. Remove all dependencies before deleting. ### PATCH Update data space `PATCH /ssot/data-spaces/{idOrName}` Tags: Data Spaces. Update the specified data space. **Available Version:** 62.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `DataSpacePatchInputRepresentation`. _Example: Example_ ``` { "label": "nonDefault", "description": "Custom data space." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceInfoRepresentation`. _Example: Example_ ``` { "description": "Custom data space.", "id": "0vhSB000001bqwjYAA", "label": "nonDefault", "name": "nonDefault", "prefix": "ndf", "status": "Active" } ``` * **400** Bad request. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Sync data space `POST /ssot/data-spaces/{idOrName}/actions/retry` Tags: Data Spaces. Retry off-core sync for a data space in an error state. **Available Version:** 67.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 67.0 #### Responses * **204** Success: Sync request accepted. The data space will be synchronized shortly. * **404** NOT\_FOUND: Data space with idOrName: _idOrName_ doesn't exist. ### GET Get data space members `GET /ssot/data-spaces/{idOrName}/members` Tags: Data Spaces. Get information about the objects that can access a data space. Currently, only data lake objects (DLOs) are supported. **Available Version:** 61.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 61.0 * `batchSize` (query, integer) The maximum number of items to return in each response. Values are from `1` through `2000`. The default value is `50` if unspecified. **Available Version:** 61.0 * `continuationToken` (query, string) Token used to retrieve the next set of data space members. Returned when more results are available than can be returned in a single request. * **First request:** Omit the parameter or pass `null` to retrieve the first page. * **Subsequent requests:** Pass the token from the previous response to retrieve the next page. * **Expired tokens:** Tokens can expire after a period of time. If a token expires, restart pagination from the firstpage. * **Last page:** When the response returns no `continuationToken`, you've reached the last page. **Available Version:** 67.0 * `offset` (query, integer) Number of rows to skip before returning results. Values are from `1` through '2000' If unspecified, no rows are skipped. **Available Version:** 61.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceMemberCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "", "totalSize": 1, "continuationToken": "eyJwYWdlIjoyLCJvZmZzZXQiOjEwMH0", "members": [ { "memberName": "DeveloperName1__dll", "status": "ACTIVE", "filter": { "conjunctiveOperator": "OrOperator", "conditionGroups": [], "conditions": [ { "fieldName": "Field__c", "filterValue": "test", "operator": "EqualsOperator", "tableName": "DeveloperName__dll" } ] } } ] } ``` * **400** Bad request. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### PUT Upsert data space members `PUT /ssot/data-spaces/{idOrName}/members` Tags: Data Spaces. Add members to a data space or update existing data space filters. Currently, only data lake objects (DLOs) are supported. Both create and update are acceptable methods. **Available Version:** 61.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 61.0 #### Request body (required) Media type: `application/json`. Schema: `DataSpaceMemberCollectionInputRepresentation`. _Example: Example_ ``` { "members": { "members": [ { "memberName": "DeveloperName1__dll", "filter": { "conjunctiveOperator": "OrOperator", "conditionGroups": [], "conditions": { "conditions": [ { "fieldName": "Field__c", "filterValue": "test", "operator": "EqualsOperator", "tableName": "DeveloperName__dll" } ] } } } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceMemberPutCollectionRepresentation`. _Example: Example_ ``` { "dataSpaceMembers": { "members": [ { "memberName": "DeveloperName1__dll", "status": "PROCESSING", "filter": { "conjunctiveOperator": "OrOperator", "conditionGroups": [], "conditions": [ { "fieldName": "Field__c__c", "filterValue": "test", "operator": "EqualsOperator", "tableName": "DeveloperName__dll" } ] } } ] }, "errors": [], "success": "true" } ``` * **400** Bad request. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### DELETE Delete data space members `DELETE /ssot/data-spaces/{idOrName}/members` Tags: Data Spaces. Delete the specified data lake objects (DLOs) from a data space. **Available Version:** 66.0 #### Parameters * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 66.0 * `memberNames` (query, string, required) DLO names separated by commas, for example, `DataSpaceMember1__dll,DataSpaceMember2__dll`. Maximum 10 members per request. **Available Version:** 66.0 #### Responses * **200** The request was successfully processed, but individual items may have failed. Check the `success` boolean for each entry: * `true`: Member deleted and the `errors` object is empty. * `false`: Deletion failed. The `errors` object will contain one of the following: * `REFERENTIAL_INTEGRITY_VIOLATION`: Dependencies found while deleting DLOs. * `NOT_FOUND`: Data space not found. * `NO_ACCESS`: Member access forbidden. ### GET Get data space member `GET /ssot/data-spaces/{idOrName}/members/{dataSpaceMemberObjectName}` Tags: Data Spaces. Get details about a data space member for a given data lake object (DLO). **Available Version:** 62.0 #### Parameters * `dataSpaceMemberObjectName` (path, string, required) Developer name of the data space member. For example, `DLO_DloDeveloperName`. **Available Version:** 62.0 * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataSpaceMemberRepresentation`. _Example: Example_ ``` { "memberName": "DeveloperName1__dll", "status": "ACTIVE" } ``` * **400** Bad request. * **403** Forbidden. * **404** Not found. * **500** Internal server error. ### POST Sync data space member `POST /ssot/data-spaces/{idOrName}/members/{dataSpaceMemberObjectName}/actions/retry` Tags: Data Spaces. Retry off-core sync for a data space member in an error state. **Available Version:** 67.0 #### Parameters * `dataSpaceMemberObjectName` (path, string, required) Developer name of the data space member. For example, `DLO_DloDeveloperName`. **Available Version:** 67.0 * `idOrName` (path, string, required) ID or API name of the data space. **Available Version:** 67.0 #### Responses * **204** Success: Sync request accepted. The data space member will be synchronized shortly. * **404** NOT\_FOUND: Data space member with memberDevName: _dataSpaceMemberObjectName_ and data space: _idOrName_ couldn't be found. ### GET Get data streams `GET /ssot/data-streams` Tags: Data Streams. Get a list of data streams. **Available Version:** 60.0 #### Parameters * `connectionName` (query, string) Name of the data stream connection. **Available Version:** 60.0 * `filter` (query, string) Filter the result set to a more narrow scope or specific type, such as `filter=MC` or `filter=SFDC` for connector types. **Available Version:** 60.0 * `includeMappings` (query, string) Indicates whether or not to include mappings in the results. **Available Version:** 60.0 * `limit` (query, integer) Maximum number of rows to return from `1` through `200`. If unspecified, the default number of rows is `10`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set: `ASC` for ascending or `DESC` for descending. If unspecified, results are returned in ascending order. Possible values are: * `Id` * `DataConnectorId` * `DataConnectorType` * `DataSourceId` * `DeveloperName` **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataStreamCollectionRepresentation`. _Example: SFDC data streams response_ ``` { "currentPageUrl": "/services/data/v62.0/ssot/data-streams?limit=10&offset=1", "dataStreams": [ { "advancedAttributes": {}, "connectorInfo": { "connectorDetails": { "name": "SalesforceDotCom_Home", "sourceObject": "Account" }, "connectorType": "SalesforceDotCom" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Billing City", "name": "BillingCity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Zip/Postal Code", "name": "ShippingPostalCode" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Master Record ID", "name": "MasterRecordId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping City", "name": "ShippingCity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing State/Province", "name": "BillingState" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Deleted", "name": "IsDeleted" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Last Modified By ID", "name": "LastModifiedById" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Country", "name": "BillingCountry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SIC Description", "name": "SicDesc" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Referenced Date", "name": "LastReferencedDate" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Billing Latitude", "name": "BillingLatitude" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "CreatedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Source", "name": "AccountSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Number", "name": "AccountNumber" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Annual Revenue", "name": "AnnualRevenue" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Geocode Accuracy", "name": "BillingGeocodeAccuracy" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Billing Longitude", "name": "BillingLongitude" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Activity", "name": "LastActivityDate" }, { "dataType": "Url", "isPrimaryKey": false, "label": "Photo URL", "name": "PhotoUrl" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Jigsaw Company ID", "name": "JigsawCompanyId" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Account Fax", "name": "Fax" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Industry", "name": "Industry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Street", "name": "BillingStreet" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Parent Account ID", "name": "ParentId" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Viewed Date", "name": "LastViewedDate" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Account Phone", "name": "Phone" }, { "dataType": "Url", "isPrimaryKey": false, "label": "Website", "name": "Website" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "LastModifiedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "CreatedById" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping State/Province", "name": "ShippingState" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Street", "name": "ShippingStreet" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Zip/Postal Code", "name": "BillingPostalCode" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Description", "name": "Description" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Name", "name": "Name" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Employees", "name": "NumberOfEmployees" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SfdcOrganizationId", "name": "SfdcOrganizationId" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Shipping Longitude", "name": "ShippingLongitude" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Shipping Latitude", "name": "ShippingLatitude" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data.com Key", "name": "Jigsaw" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Type", "name": "Type" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "SystemModstamp" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Geocode Accuracy", "name": "ShippingGeocodeAccuracy" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Country", "name": "ShippingCountry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Id", "name": "KQ_Id" }, { "dataType": "Text", "isPrimaryKey": true, "label": "Account ID", "name": "Id" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Owner ID", "name": "OwnerId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "label": "Account_Home", "name": "Account_Home__dll", "recordModifiedFieldName": "SystemModstamp", "status": "ACTIVE" }, "dataStreamType": "SFDC", "isEnabled": true, "label": "Account_Home", "lastRunStatus": "FAILURE", "mappings": [], "name": "Account_Home", "recordId": "1dsQZ000000AcFJYA0", "refreshConfig": { "frequency": { "frequencyType": "BATCH", "hours": [], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "UPSERT", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": false }, "sourceFields": [ { "datatype": "Text", "name": "Id" }, { "datatype": "Text", "name": "IsDeleted" }, { "datatype": "Text", "name": "MasterRecordId" }, { "datatype": "Text", "name": "Name" }, { "datatype": "Text", "name": "Type" }, { "datatype": "Text", "name": "ParentId" }, { "datatype": "Text", "name": "BillingStreet" }, { "datatype": "Text", "name": "BillingCity" }, { "datatype": "Text", "name": "BillingState" }, { "datatype": "Text", "name": "BillingPostalCode" }, { "datatype": "Text", "name": "BillingCountry" }, { "datatype": "Number", "name": "BillingLatitude" }, { "datatype": "Number", "name": "BillingLongitude" }, { "datatype": "Text", "name": "BillingGeocodeAccuracy" }, { "datatype": "Text", "name": "ShippingStreet" }, { "datatype": "Text", "name": "ShippingCity" }, { "datatype": "Text", "name": "ShippingState" }, { "datatype": "Text", "name": "ShippingPostalCode" }, { "datatype": "Text", "name": "ShippingCountry" }, { "datatype": "Number", "name": "ShippingLatitude" }, { "datatype": "Number", "name": "ShippingLongitude" }, { "datatype": "Text", "name": "ShippingGeocodeAccuracy" }, { "datatype": "Phone", "name": "Phone" }, { "datatype": "Phone", "name": "Fax" }, { "datatype": "Text", "name": "AccountNumber" }, { "datatype": "Url", "name": "Website" }, { "datatype": "Url", "name": "PhotoUrl" }, { "datatype": "Text", "name": "Industry" }, { "datatype": "Number", "name": "AnnualRevenue" }, { "datatype": "Number", "name": "NumberOfEmployees" }, { "datatype": "Text", "name": "Description" }, { "datatype": "Text", "name": "OwnerId" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "CreatedDate" }, { "datatype": "Text", "name": "CreatedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastModifiedDate" }, { "datatype": "Text", "name": "LastModifiedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "SystemModstamp" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "LastActivityDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastViewedDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastReferencedDate" }, { "datatype": "Text", "name": "Jigsaw" }, { "datatype": "Text", "name": "JigsawCompanyId" }, { "datatype": "Text", "name": "AccountSource" }, { "datatype": "Text", "name": "SicDesc" }, { "datatype": "Text", "name": "SfdcOrganizationId" } ], "status": "ACTIVE" }, { "advancedAttributes": {}, "connectorInfo": { "connectorDetails": { "name": "SalesforceDotCom_Home", "sourceObject": "Case" }, "connectorType": "SalesforceDotCom" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Status", "name": "Status" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Parent Case ID", "name": "ParentId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Id", "name": "KQ_Id" }, { "dataType": "Text", "isPrimaryKey": true, "label": "Case ID", "name": "Id" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "SystemModstamp" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SfdcOrganizationId", "name": "SfdcOrganizationId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account ID", "name": "AccountId" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Contact Mobile", "name": "ContactMobile" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Owner ID", "name": "OwnerId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Closed", "name": "IsClosed" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Priority", "name": "Priority" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Deleted", "name": "IsDeleted" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Comments", "name": "Comments" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Case Type", "name": "Type" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Name", "name": "SuppliedName" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Last Modified By ID", "name": "LastModifiedById" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Case Origin", "name": "Origin" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Subject", "name": "Subject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Escalated", "name": "IsEscalated" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Viewed Date", "name": "LastViewedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Case Number", "name": "CaseNumber" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Company", "name": "SuppliedCompany" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Closed Date", "name": "ClosedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Master Record ID", "name": "MasterRecordId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Phone", "name": "SuppliedPhone" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "CreatedById" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Referenced Date", "name": "LastReferencedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Description", "name": "Description" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "CreatedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Contact ID", "name": "ContactId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Case Reason", "name": "Reason" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "LastModifiedDate" }, { "dataType": "Email", "isPrimaryKey": false, "label": "Contact Email", "name": "ContactEmail" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Contact Fax", "name": "ContactFax" }, { "dataType": "Email", "isPrimaryKey": false, "label": "Email Address", "name": "SuppliedEmail" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Contact Phone", "name": "ContactPhone" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "label": "Case_Home", "name": "Case_Home__dll", "recordModifiedFieldName": "SystemModstamp", "status": "ACTIVE" }, "dataStreamType": "SFDC", "isEnabled": true, "label": "Case_Home", "lastAddedRecords": 0, "lastProcessedRecords": 0, "lastRefreshDate": "2025-01-08T20:21:03.000Z", "lastRunStatus": "SUCCESS", "mappings": [], "name": "Case_Home", "recordId": "1dsQZ000000AcGvYAK", "refreshConfig": { "frequency": { "frequencyType": "BATCH", "hours": [], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "UPSERT", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": false }, "sourceFields": [ { "datatype": "Text", "name": "Id" }, { "datatype": "Text", "name": "IsDeleted" }, { "datatype": "Text", "name": "MasterRecordId" }, { "datatype": "Text", "name": "CaseNumber" }, { "datatype": "Text", "name": "ContactId" }, { "datatype": "Text", "name": "AccountId" }, { "datatype": "Text", "name": "ParentId" }, { "datatype": "Text", "name": "SuppliedName" }, { "datatype": "Email", "name": "SuppliedEmail" }, { "datatype": "Text", "name": "SuppliedPhone" }, { "datatype": "Text", "name": "SuppliedCompany" }, { "datatype": "Text", "name": "Type" }, { "datatype": "Text", "name": "Status" }, { "datatype": "Text", "name": "Reason" }, { "datatype": "Text", "name": "Origin" }, { "datatype": "Text", "name": "Subject" }, { "datatype": "Text", "name": "Priority" }, { "datatype": "Text", "name": "Description" }, { "datatype": "Text", "name": "IsClosed" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "ClosedDate" }, { "datatype": "Text", "name": "IsEscalated" }, { "datatype": "Text", "name": "OwnerId" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "CreatedDate" }, { "datatype": "Text", "name": "CreatedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastModifiedDate" }, { "datatype": "Text", "name": "LastModifiedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "SystemModstamp" }, { "datatype": "Phone", "name": "ContactPhone" }, { "datatype": "Phone", "name": "ContactMobile" }, { "datatype": "Email", "name": "ContactEmail" }, { "datatype": "Phone", "name": "ContactFax" }, { "datatype": "Text", "name": "Comments" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastViewedDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastReferencedDate" }, { "datatype": "Text", "name": "SfdcOrganizationId" } ], "status": "ACTIVE", "totalRecords": 3 }, { "advancedAttributes": {}, "connectorInfo": { "connectorDetails": { "name": "SalesforceDotCom_Home", "sourceObject": "TenantEntitlementTransaction" }, "connectorType": "SalesforceDotCom" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "category": "Other", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Org ID", "name": "SfdcOrganizationId" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "createddate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "createdbyid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_id", "name": "KQ_id" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "id" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Entitlement Card Definition Dev Name", "name": "entitlementcarddefdevlname" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Quantity", "name": "quantity" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Start Date", "name": "startdate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "End Date", "name": "enddate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Transaction Type", "name": "entitlementtransactiontype" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Transaction Subtype", "name": "entitlementtransactionsubtype" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Related Entitlement Transaction", "name": "relatedtntentitlementtrxnid" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "lastmodifieddate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Deleted", "name": "isdeleted" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Management Org Contract", "name": "mgmtorgcontract" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Management Org Entitlement Schedule", "name": "mgmtorgentitlementschedule" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Type Definition", "name": "usagetypedef" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 0", "name": "usagesubtype0" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 1", "name": "usagesubtype1" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 2", "name": "usagesubtype2" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Multiplier", "name": "multiplier" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "systemmodstamp" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Unit", "name": "unit" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Raw Quantity", "name": "rawquantity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Business Environment Type", "name": "businessenvtype" } ], "dataSpaceInfo": [], "label": "TenantEntitlementTransaction", "name": "TenantEntitlementTransaction__dll", "recordModifiedFieldName": "systemmodstamp", "status": "ACTIVE" }, "dataStreamType": "SFDC", "isEnabled": true, "label": "TenantEntitlementTransaction", "lastRunStatus": "NONE", "mappings": [], "name": "TenantEntitlementTransaction", "recordId": "1dsQZ000000Aa75YAC", "refreshConfig": { "frequency": { "hours": [], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "UPSERT", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": true }, "sourceFields": [ { "datatype": "Text", "name": "SfdcOrganizationId" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "createddate" }, { "datatype": "Text", "name": "createdbyid" }, { "datatype": "Text", "name": "id" }, { "datatype": "Text", "name": "entitlementcarddefdevlname" }, { "datatype": "Number", "name": "quantity" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "startdate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "enddate" }, { "datatype": "Text", "name": "entitlementtransactiontype" }, { "datatype": "Text", "name": "entitlementtransactionsubtype" }, { "datatype": "Text", "name": "relatedtntentitlementtrxnid" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "lastmodifieddate" }, { "datatype": "Text", "name": "isdeleted" }, { "datatype": "Text", "name": "mgmtorgcontract" }, { "datatype": "Text", "name": "mgmtorgentitlementschedule" }, { "datatype": "Text", "name": "usagetypedef" }, { "datatype": "Text", "name": "usagesubtype0" }, { "datatype": "Text", "name": "usagesubtype1" }, { "datatype": "Text", "name": "usagesubtype2" }, { "datatype": "Number", "name": "multiplier" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "systemmodstamp" }, { "datatype": "Number", "name": "unit" }, { "datatype": "Number", "name": "rawquantity" }, { "datatype": "Text", "name": "businessenvtype" } ], "status": "ACTIVE" }, { "advancedAttributes": {}, "connectorInfo": { "connectorDetails": { "name": "SalesforceDotCom_Home", "sourceObject": "TenantUsageTypeMultiplier" }, "connectorType": "SalesforceDotCom" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "category": "Other", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Org ID", "name": "SfdcOrganizationId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_id", "name": "KQ_id" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "id" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "End Date", "name": "effenddatetime" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Start Date", "name": "effstartdatetime" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Type Definition", "name": "usagetypedef" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 0", "name": "usagesubtype0" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 1", "name": "usagesubtype1" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Usage Subtype 2", "name": "usagesubtype2" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Multiplier", "name": "multiplier" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "systemmodstamp" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Unit", "name": "unit" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Management Usage Type Multiplier", "name": "mgmtusagetypemultiplier" } ], "dataSpaceInfo": [], "label": "TenantUsageTypeMultiplier", "name": "TenantUsageTypeMultiplier__dll", "recordModifiedFieldName": "systemmodstamp", "status": "ACTIVE" }, "dataStreamType": "SFDC", "isEnabled": true, "label": "TenantUsageTypeMultiplier", "lastRunStatus": "NONE", "mappings": [], "name": "TenantUsageTypeMultiplier", "recordId": "1dsQZ000000Aa74YAC", "refreshConfig": { "frequency": { "hours": [], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "UPSERT", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": true }, "sourceFields": [ { "datatype": "Text", "name": "SfdcOrganizationId" }, { "datatype": "Text", "name": "id" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "effenddatetime" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "effstartdatetime" }, { "datatype": "Text", "name": "usagetypedef" }, { "datatype": "Text", "name": "usagesubtype0" }, { "datatype": "Text", "name": "usagesubtype1" }, { "datatype": "Text", "name": "usagesubtype2" }, { "datatype": "Number", "name": "multiplier" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS", "name": "systemmodstamp" }, { "datatype": "Number", "name": "unit" }, { "datatype": "Text", "name": "mgmtusagetypemultiplier" } ], "status": "ACTIVE" } ], "totalSize": 4 } ``` _Example: Marketing Cloud data streams response_ ``` { "currentPageUrl": "/services/data/v65.0/ssot/data-streams?limit=1&offset=1", "dataStreams": [ { "advancedAttributes": {}, "capabilities": {}, "connectorInfo": { "connectorDetails": { "bundleName": "EMAIL", "eid": "524000862", "mid": "524000862", "name": "ConnectionTest2", "sourceObjectName": "Campaign", "type": "SalesforceMarketingCloud" }, "connectorType": "SalesforceMarketingCloud" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "capabilities": {}, "category": "Other", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_ID", "name": "KQ_ID" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "ID" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Modified Date", "name": "ModifiedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "EID", "name": "EID" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "End Date", "name": "EndDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Start Date", "name": "StartDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Campaign Status", "name": "CampaignStatus" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "CreatedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Name", "name": "Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Is Active", "name": "IsActive" }, { "dataType": "Text", "isPrimaryKey": false, "label": "External Key", "name": "ExternalKey" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "filter": { "conditions": [ { "fieldName": "InternalOrganization__c", "filterValue": "524000862", "operator": "InOperator", "tableName": "sfmc_campaign_524000862__dll" } ], "conjunctiveOperator": "NoneOperator", "conditionGroups": [] }, "label": "default", "name": "default" }, { "filter": { "conditions": [ { "fieldName": "InternalOrganization__c", "filterValue": "524000862", "operator": "InOperator", "tableName": "sfmc_campaign_524000862__dll" } ], "conjunctiveOperator": "NoneOperator", "conditionGroups": [] }, "label": "nondefaultuma", "name": "nondefaultuma" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_ID", "name": "KQ_ID" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ID", "name": "ID" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Modified Date", "name": "ModifiedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "EID", "name": "EID" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "End Date", "name": "EndDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Start Date", "name": "StartDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Campaign Status", "name": "CampaignStatus" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "CreatedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Name", "name": "Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Is Active", "name": "IsActive" }, { "dataType": "Text", "isPrimaryKey": false, "label": "External Key", "name": "ExternalKey" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "id": "0gOSB000005XBOR2A4", "label": "SFMC Campaign 524000862", "name": "sfmc_campaign_524000862__dll", "status": "ERROR" }, "dataSource": "SFMC524000862", "dataStreamType": "MC", "isEnabled": true, "label": "SFMC Campaign 524000862", "lastRunStatus": "NONE", "mappings": [], "name": "sfmc_campaign_524000862", "recordId": "1dsSB000003WIrLYAW", "refreshConfig": { "frequency": { "frequencyType": "DAILY", "hours": [ null ], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "TOTAL_REPLACE", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": false }, "sourceFields": [ { "datatype": "Text", "name": "tgt_DataSource" }, { "datatype": "Text", "name": "tgt_DataSourceObject" }, { "datatype": "Text", "name": "tgt_ID" }, { "datatype": "Text", "name": "tgt_MID" }, { "datatype": "Text", "name": "tgt_EID" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "tgt_CreatedDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "tgt_ModifiedDate" }, { "datatype": "Text", "name": "tgt_Name" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "tgt_StartDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "tgt_EndDate" }, { "datatype": "Text", "name": "tgt_CampaignStatus" }, { "datatype": "Text", "name": "tgt_ExternalKey" }, { "datatype": "Text", "name": "tgt_IsActive" } ], "status": "ERROR" } ], "nextPageUrl": "/services/data/v65.0/ssot/data-streams?limit=1&offset=2", "totalSize": 5 } ``` ### POST Create data stream `POST /ssot/data-streams` Tags: Data Streams. Create a data stream. This endpoint also creates an unstructured data lake object (UDLO) when `dataLakeObjectInfo.category` is `Directory_Table` — it serves all UDLO creation paths (uploaded files, cloud-storage connections, and scheduled external connectors). **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `DataStreamInputRepresentation`. _Example: S3 data stream request_ ``` { "name": "S3Stream", "label": "S3Stream", "datasource": "AwsS3_S3Connection", "datastreamType": "CONNECTORSFRAMEWORK", "connectorInfo": { "connectorType": "DataConnector", "connectorDetails": { "name": "S3Connection" } }, "dataLakeObjectInfo": { "label": "S3Stream", "name": "S3Stream__dll", "category": "Profile", "dataspaceInfo": [ { "name": "Default" } ], "dataLakeFieldInputRepresentations": [ { "name": "bikeid", "label": "bikeid", "dataType": "Number", "isPrimaryKey": true }, { "name": "trip_id", "label": "trip_id", "dataType": "Number", "isPrimaryKey": false }, { "name": "formulaDate", "label": "formulaDate", "dataType": "DateTime", "isPrimaryKey": false }, { "name": "DateDifference", "label": "DateDifference", "dataType": "DateTime", "isPrimaryKey": false }, { "name": "usertype", "label": "usertype", "dataType": "Text", "isPrimaryKey": false } ] }, "sourceFields": [ { "name": "bikeid", "dataType": "Number" }, { "name": "trip_id", "dataType": "Number" }, { "name": "starttime", "dataType": "DateTime" }, { "name": "usertype", "dataType": "Text" } ], "mappings": [ { "sourceFieldLabel": "bikeid", "targetFieldName": "bikeid" }, { "sourceFieldLabel": "trip_id", "targetFieldName": "trip_id" }, { "transformationFormula": "DAYPRECISION(sourceField['starttime'])", "targetFieldName": "formulaDate", "targetFieldReturntype": "DateTime" }, { "transformationFormula": "DAYSBETWEEN(NOW(),sourceField['starttime'])", "targetFieldName": "DateDifference", "targetFieldReturntype": "DateTime" }, { "sourceFieldLabel": "usertype", "targetFieldName": "usertype", "targetFieldReturntype": "Text" } ], "refreshConfig": { "isAccelerationEnabled": true, "refreshMode": "UPSERT", "frequency": { "frequencyType": "WEEKLY", "refreshDayOfWeek": "Sunday", "hours": [ 7 ] } }, "advancedAttributes": { "fileName": "*", "fileType": "CSV", "importDirectory": "divvy", "isMissingFileFailure": true, "areHeadersIncludedInFile": false } } ``` _Example: S3 data stream from existing DLO request_ ``` { "name": "S3Stream", "label": "S3Stream", "datasource": "AwsS3_S3Connection", "datastreamType": "CONNECTORSFRAMEWORK", "connectorInfo": { "connectorType": "DataConnector", "connectorDetails": { "name": "S3Connection" } }, "existingDataLakeObjectInfo": { "name": "S3Stream__dll" }, "sourceFields": [ { "name": "bikeid", "dataType": "Number" }, { "name": "trip_id", "dataType": "Number" }, { "name": "starttime", "dataType": "DateTime" }, { "name": "usertype", "dataType": "Text" } ], "mappings": [ { "sourceFieldLabel": "bikeid", "targetFieldName": "bikeid" }, { "sourceFieldLabel": "trip_id", "targetFieldName": "trip_id" }, { "transformationFormula": "DAYPRECISION(sourceField['starttime'])", "targetFieldName": "formulaDate", "targetFieldReturntype": "DateTime" }, { "transformationFormula": "DAYSBETWEEN(NOW(),sourceField['starttime'])", "targetFieldName": "DateDifference", "targetFieldReturntype": "DateTime" }, { "sourceFieldLabel": "usertype", "targetFieldName": "usertype", "targetFieldReturntype": "Text" } ], "refreshConfig": { "isAccelerationEnabled": true, "refreshMode": "UPSERT", "frequency": { "frequencyType": "WEEKLY", "refreshDayOfWeek": "Sunday", "hours": [ 7 ] } }, "advancedAttributes": { "fileName": "*", "fileType": "CSV", "importDirectory": "divvy", "isMissingFileFailure": true, "areHeadersIncludedInFile": false } } ``` _Example: S3 data stream with org currency request_ ``` { "name": "S3Stream", "label": "S3Stream", "datasource": "AwsS3_S3Connection", "datastreamType": "CONNECTORSFRAMEWORK", "connectorInfo": { "connectorType": "DataConnector", "connectorDetails": { "name": "S3Connection" } }, "dataLakeObjectInfo": { "label": "S3Stream", "name": "S3Stream__dll", "category": "Profile", "dataspaceInfo": [ { "name": "Default" } ], "dataLakeFieldInputRepresentations": [ { "name": "bikeid", "label": "bikeid", "dataType": "Number", "isPrimaryKey": true }, { "name": "trip_id", "label": "trip_id", "dataType": "Number", "isPrimaryKey": false }, { "name": "formulaDate", "label": "formulaDate", "dataType": "DateTime", "isPrimaryKey": false }, { "name": "DateDifference", "label": "DateDifference", "dataType": "DateTime", "isPrimaryKey": false }, { "name": "usertype", "label": "usertype", "dataType": "Text", "isPrimaryKey": false }, { "name": "currency", "label": "currency", "dataType": "currency", "isPrimaryKey": false } ] }, "sourceFields": [ { "name": "bikeid", "dataType": "Number" }, { "name": "trip_id", "dataType": "Number" }, { "name": "starttime", "dataType": "DateTime" }, { "name": "usertype", "dataType": "Text" } ], "mappings": [ { "sourceFieldLabel": "bikeid", "targetFieldName": "bikeid" }, { "sourceFieldLabel": "trip_id", "targetFieldName": "trip_id" }, { "transformationFormula": "DAYPRECISION(sourceField['starttime'])", "targetFieldName": "formulaDate", "targetFieldReturntype": "DateTime" }, { "transformationFormula": "DAYSBETWEEN(NOW(),sourceField['starttime'])", "targetFieldName": "DateDifference", "targetFieldReturntype": "DateTime" }, { "sourceFieldLabel": "usertype", "targetFieldName": "usertype", "targetFieldReturntype": "Text" }, { "transformationFormula": "USD", "targetFieldName": "currency", "targetFieldReturntype": "currency" } ], "refreshConfig": { "isAccelerationEnabled": true, "refreshMode": "UPSERT", "frequency": { "frequencyType": "WEEKLY", "refreshDayOfWeek": "Sunday", "hours": [ 7 ] } }, "advancedAttributes": { "fileName": "*", "fileType": "CSV", "importDirectory": "divvy", "isMissingFileFailure": true, "areHeadersIncludedInFile": false }, "currencyIsoCodeInfo": { "currencyIsoCode": "USD" } } ``` _Example: Full refresh data stream request_ ``` { "name": "ConnectAPI_FullRefresh_Example", "label": "ConnectAPI Full Refresh Example", "refreshConfig": { "frequency": { "frequencyType": "HOURLY" }, "refreshMode": "TOTAL_REPLACE" }, "connectorInfo": { "connectorType": "SalesforceMarketingCloud", "connectorDetails": { "subType": "SalesforceMarketingCloudDataExtension", "eid": "524000862", "mid": "524000862", "customObjectId": "e8409a55-ad31-f011-a5db-5cba2c759f08", "customObjectName": "API_TEST_1" } }, "advancedAttributes": { "mcDataExtractMode": "FullRefresh" }, "sourceFields": [ { "dataType": "Text", "name": "SubscriberKey" }, { "dataType": "DATETIME", "name": "CreateDate" } ], "dataLakeObjectInfo": { "category": "Profile", "dataspaceInfo": [ { "name": "default" } ], "label": "ConnectAPI Full Refresh Example", "name": "connectapi_full_refresh_example__dll", "dataLakeFieldInputRepresentations": [ { "dataType": "Text", "isPrimaryKey": true, "label": "SubscriberKey" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "CreateDate" } ] }, "mappings": [ { "sourceFieldLabel": "SubscriberKey", "targetFieldName": "SubscriberKey" }, { "sourceFieldLabel": "CreateDate", "targetFieldName": "CreatedDate" } ] } ``` _Example: Incremental datetime data stream request_ ``` { "name": "ConnectAPI_incremental_datetime", "label": "ConnectAPI incremental datetime", "refreshConfig": { "frequency": { "frequencyType": "HOURLY", "hours": [], "refreshDayOfMonth": [] }, "refreshMode": "UPSERT" }, "connectorInfo": { "connectorType": "SalesforceMarketingCloud", "connectorDetails": { "subType": "SalesforceMarketingCloudDataExtension", "eid": "524000819", "mid": "524000819", "customObjectId": "70b445b5-31a1-ef11-a5ca-5cba2c756a48", "customObjectName": "Incremental Datetime DE" } }, "advancedAttributes": { "mcDataExtractMode": "DeltaExtractByDate", "mcDeltaExtractField": "inc cdc field" }, "sourceFields": [ { "dataType": "Text", "name": "id" }, { "dataType": "DateTime", "name": "inc cdc field" }, { "dataType": "Text", "name": "field 2" }, { "dataType": "Text", "name": "field 3" } ], "dataLakeObjectInfo": { "category": "Engagement", "dataspaceInfo": [ { "name": "default", "filter": null } ], "label": "ConnectAPI incremental datetime", "name": "connectapi_incremental_datetime__dll", "eventDateTimeFieldName": "inc_cdc_field", "recordModifiedFieldName": null, "dataLakeFieldInputRepresentations": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Datetime", "isPrimaryKey": false, "label": "inc cdc field", "name": "inc_cdc_field" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "field 2", "name": "field_2" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "field 3", "name": "field_3" }, { "dataType": "Text", "isPrimaryKey": true, "label": "id", "name": "id" } ] }, "mappings": [ { "sourceFieldLabel": "id", "targetFieldName": "id", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "'SFMC524000819'", "targetFieldName": "DataSource", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "'524000819_524000819_root'", "targetFieldName": "InternalOrganization", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "SFMC524000819_524000819_Incremental_DE", "targetFieldName": "DataSourceObject", "targetFieldReturntype": "TEXT" }, { "sourceFieldLabel": "field 3", "targetFieldName": "field_3", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "if(ISEMPTY(sourceField['inc cdc field'])", "targetFieldName": "inc_cdc_field", "targetFieldReturntype": "DATETIME" }, { "sourceFieldLabel": "field 2", "targetFieldName": "field_2", "targetFieldReturntype": "TEXT" } ] } ``` _Example: Incremental numeric data stream request_ ``` { "name": "ConnectAPI_API_TEST_2_incremental_numeric", "label": "ConnectAPI incremental numeric", "refreshConfig": { "frequency": { "frequencyType": "HOURLY", "hours": [], "refreshDayOfMonth": [] }, "refreshMode": "UPSERT" }, "connectorInfo": { "connectorType": "SalesforceMarketingCloud", "connectorDetails": { "subType": "SalesforceMarketingCloudDataExtension", "eid": "524000819", "mid": "524000819", "customObjectId": "785cee98-2ba1-ef11-a5ca-5cba2c756a48", "customObjectName": "Incremental DE" } }, "advancedAttributes": { "mcDataExtractMode": "DeltaExtractByNumber", "mcDeltaExtractField": "inc cdc field" }, "sourceFields": [ { "dataType": "Text", "name": "id" }, { "dataType": "Number", "name": "inc cdc field" }, { "dataType": "Text", "name": "field 2" }, { "dataType": "Text", "name": "field 3" } ], "dataLakeObjectInfo": { "category": "Profile", "dataspaceInfo": [ { "name": "default", "filter": null } ], "label": "ConnectAPI incremental numeric", "name": "connectapi_incremental_numeric__dll", "eventDateTimeFieldName": null, "recordModifiedFieldName": null, "dataLakeFieldInputRepresentations": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Number", "isPrimaryKey": false, "label": "inc cdc field", "name": "inc_cdc_field" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "field 2", "name": "field_2" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "field 3", "name": "field_3" }, { "dataType": "Text", "isPrimaryKey": true, "label": "id", "name": "id" } ] }, "mappings": [ { "sourceFieldLabel": "id", "targetFieldName": "id", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "'SFMC524000819'", "targetFieldName": "DataSource", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "'524000819_524000819_root'", "targetFieldName": "InternalOrganization", "targetFieldReturntype": "TEXT" }, { "transformationFormula": "SFMC524000819_524000819_Incremental_DE", "targetFieldName": "DataSourceObject", "targetFieldReturntype": "TEXT" }, { "sourceFieldLabel": "field 3", "targetFieldName": "field_3", "targetFieldReturntype": "TEXT" }, { "sourceFieldLabel": "inc cdc field", "targetFieldName": "inc_cdc_field", "targetFieldReturntype": "NUMBER" }, { "sourceFieldLabel": "field 2", "targetFieldName": "field_2", "targetFieldReturntype": "TEXT" } ] } ``` _Example: Bundle data stream request_ ``` { "name": "name", "label": "label", "refreshConfig": {}, "connectorInfo": { "connectorType": "SalesforceMarketingCloud", "connectorDetails": { "subType": "SalesforceMarketingCloudStandard", "eid": "524000862", "mid": "524000862", "sourceObjectName": "EinsteinEmailEngagementScoring" } }, "advancedAttributes": {}, "sourceFields": [], "dataLakeObjectInfo": {}, "mappings": [] } ``` _Example: Snowflake data stream request_ ``` { "name": "GBQ_Retail", "label": "GBQ_Retail", "datastreamType": "EXTERNAL", "connectorInfo": { "connectorType": "DataConnector", "connectorDetails": { "name": "GBQ" } }, "dataLakeObjectInfo": { "dataspaceInfo": [ { "name": "Default" } ], "category": "Engagement", "label": "GBQ_Retail", "name": "GBQ_Retail__dll", "eventDateTimeFieldName": "purchasedate", "dataLakeFieldInputRepresentations": [ { "dataType": "Boolean", "isPrimaryKey": false, "label": "DISCOUNTAPPLIED", "name": "discountapplied" }, { "dataType": "Number", "isPrimaryKey": false, "label": "QUANTITY", "name": "quantity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "PRODUCTNAME", "name": "productname" }, { "dataType": "Text", "isPrimaryKey": true, "label": "ORDERID", "name": "orderid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SKU", "name": "sku" }, { "dataType": "Text", "isPrimaryKey": false, "label": "CUSTOMERID", "name": "customerid" }, { "dataType": "Number", "isPrimaryKey": false, "label": "TOTALPRICE", "name": "totalprice" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SHIPPINGSTATUS", "name": "shippingstatus" }, { "dataType": "Text", "isPrimaryKey": false, "label": "PROMOTIONSAPPLIED", "name": "promotionsapplied" }, { "dataType": "Text", "isPrimaryKey": false, "label": "PAYMENTSTATUS", "name": "paymentstatus" }, { "dataType": "Date", "isPrimaryKey": false, "label": "PURCHASEDATE", "name": "purchasedate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "RETURNREASON", "name": "returnreason" }, { "dataType": "Number", "isPrimaryKey": false, "label": "UNITPRICE", "name": "unitprice" }, { "dataType": "Text", "isPrimaryKey": false, "label": "PRODUCTID", "name": "productid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "RETURMSTATUS", "name": "returmstatus" }, { "dataType": "Text", "isPrimaryKey": false, "label": "STYLE", "name": "style" } ] }, "mappings": [ { "sourceFieldLabel": "PAYMENTSTATUS", "targetFieldName": "paymentstatus" }, { "sourceFieldLabel": "SKU", "targetFieldName": "sku" }, { "sourceFieldLabel": "DISCOUNTAPPLIED", "targetFieldName": "discountapplied" }, { "sourceFieldLabel": "PRODUCTID", "targetFieldName": "productid" }, { "sourceFieldLabel": "PURCHASEDATE", "targetFieldName": "purchasedate" }, { "sourceFieldLabel": "PRODUCTNAME", "targetFieldName": "productname" }, { "sourceFieldLabel": "ORDERID", "targetFieldName": "orderid" }, { "sourceFieldLabel": "SHIPPINGSTATUS", "targetFieldName": "shippingstatus" }, { "sourceFieldLabel": "QUANTITY", "targetFieldName": "quantity" }, { "sourceFieldLabel": "PROMOTIONSAPPLIED", "targetFieldName": "promotionsapplied" }, { "sourceFieldLabel": "CUSTOMERID", "targetFieldName": "customerid" }, { "sourceFieldLabel": "UNITPRICE", "targetFieldName": "unitprice" }, { "sourceFieldLabel": "RETURNREASON", "targetFieldName": "returnreason" }, { "sourceFieldLabel": "STYLE", "targetFieldName": "style" }, { "sourceFieldLabel": "RETURMSTATUS", "targetFieldName": "returmstatus" }, { "sourceFieldLabel": "TOTALPRICE", "targetFieldName": "totalprice" } ], "refreshConfig": { "refreshMode": "TOTAL_REPLACE" }, "sourceFields": [ { "dataType": "Text", "name": "CUSTOMERID" }, { "dataType": "Date", "format": "MM/dd/yyyy", "name": "PURCHASEDATE" }, { "dataType": "Text", "name": "ORDERID" }, { "dataType": "Text", "name": "PRODUCTID" }, { "dataType": "Text", "name": "PRODUCTNAME" }, { "dataType": "Text", "name": "STYLE" }, { "dataType": "Number", "name": "QUANTITY" }, { "dataType": "Number", "name": "UNITPRICE" }, { "dataType": "Number", "name": "TOTALPRICE" }, { "dataType": "Text", "name": "PAYMENTSTATUS" }, { "dataType": "Text", "name": "SHIPPINGSTATUS" }, { "dataType": "Text", "name": "RETURMSTATUS" }, { "dataType": "Text", "name": "RETURNREASON" }, { "dataType": "Boolean", "name": "DISCOUNTAPPLIED" }, { "dataType": "Text", "name": "PROMOTIONSAPPLIED" }, { "dataType": "Text", "name": "SKU" } ], "advancedAttributes": { "schema": "DEMO_DATA", "database": "sfmc-data-cloud-poc", "object": "RETAIL_ORDER_HISTORY" }, "dataAccessMode": "Direct_Access" } ``` _Example: UDLO data stream request (uploaded files)_ ``` { "name": "company_documents", "label": "Company Documents", "datasource": "UploadedFiles", "connectorInfo": { "connectorType": "DataConnector", "connectorDetails": { "name": "UploadedFiles" } }, "dataLakeObjectInfo": { "name": "company_documents", "label": "Company Documents", "category": "Directory_Table", "dataspaceInfo": [ { "name": "default" } ], "fields": [ { "name": "FilePath__c", "label": "File Path", "dataType": "Text", "isPrimaryKey": true }, { "name": "ResolvedFilePath__c", "label": "Resolved File Path", "dataType": "Text", "isPrimaryKey": false }, { "name": "cdp_sys_SourceVersion__c", "label": "Source Version", "dataType": "Text", "isPrimaryKey": false }, { "name": "Size__c", "label": "Size", "dataType": "Number", "isPrimaryKey": false }, { "name": "LastModified__c", "label": "Last Modified", "dataType": "DateTime", "isPrimaryKey": false }, { "name": "ETag__c", "label": "ETag", "dataType": "Text", "isPrimaryKey": false }, { "name": "ContentType__c", "label": "Content Type", "dataType": "Text", "isPrimaryKey": false }, { "name": "ParentId__c", "label": "Parent Id", "dataType": "Text", "isPrimaryKey": false }, { "name": "Metadata__c", "label": "Metadata", "dataType": "Text", "isPrimaryKey": false }, { "name": "Col1__c", "label": "Col1", "dataType": "Text", "isPrimaryKey": false }, { "name": "Col2__c", "label": "Col2", "dataType": "Text", "isPrimaryKey": false }, { "name": "Col3__c", "label": "Col3", "dataType": "Text", "isPrimaryKey": false }, { "name": "Col4__c", "label": "Col4", "dataType": "Text", "isPrimaryKey": false }, { "name": "Col5__c", "label": "Col5", "dataType": "Text", "isPrimaryKey": false } ], "dataModelObjectConfig": { "name": "Company_Documents", "label": "Company Documents" } }, "sourceFields": [ { "name": "FilePath__c", "dataType": "Text" }, { "name": "ResolvedFilePath__c", "dataType": "Text" }, { "name": "cdp_sys_SourceVersion__c", "dataType": "Text" }, { "name": "Size__c", "dataType": "Number" }, { "name": "LastModified__c", "dataType": "DateTime" }, { "name": "ETag__c", "dataType": "Text" }, { "name": "ContentType__c", "dataType": "Text" }, { "name": "ParentId__c", "dataType": "Text" }, { "name": "Metadata__c", "dataType": "Text" }, { "name": "Col1__c", "dataType": "Text" }, { "name": "Col2__c", "dataType": "Text" }, { "name": "Col3__c", "dataType": "Text" }, { "name": "Col4__c", "dataType": "Text" }, { "name": "Col5__c", "dataType": "Text" } ], "mappings": [ { "sourceFieldLabel": "FilePath__c", "targetFieldName": "FilePath__c" }, { "sourceFieldLabel": "ResolvedFilePath__c", "targetFieldName": "ResolvedFilePath__c" }, { "sourceFieldLabel": "cdp_sys_SourceVersion__c", "targetFieldName": "cdp_sys_SourceVersion__c" }, { "sourceFieldLabel": "Size__c", "targetFieldName": "Size__c" }, { "sourceFieldLabel": "LastModified__c", "targetFieldName": "LastModified__c" }, { "sourceFieldLabel": "ETag__c", "targetFieldName": "ETag__c" }, { "sourceFieldLabel": "ContentType__c", "targetFieldName": "ContentType__c" }, { "sourceFieldLabel": "ParentId__c", "targetFieldName": "ParentId__c" }, { "sourceFieldLabel": "Metadata__c", "targetFieldName": "Metadata__c" }, { "sourceFieldLabel": "Col1__c", "targetFieldName": "Col1__c" }, { "sourceFieldLabel": "Col2__c", "targetFieldName": "Col2__c" }, { "sourceFieldLabel": "Col3__c", "targetFieldName": "Col3__c" }, { "sourceFieldLabel": "Col4__c", "targetFieldName": "Col4__c" }, { "sourceFieldLabel": "Col5__c", "targetFieldName": "Col5__c" } ], "advancedAttributes": { "objectType": "UNSTRUCTURED_DATA", "driveLibraryId": "fileUploads$dc_file_upload", "importDirectory": "my-udlo-directory/", "fileName": "*.pdf" }, "refreshConfig": { "refreshMode": "TOTAL_REPLACE", "frequency": { "frequencyType": "None" } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataStreamRepresentation`. _Example: S3 data stream response_ ``` { "dataLakeObjectInfo": { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "id": "0gOVF000000n00T2AQ", "label": "S3Stream", "name": "S3Stream__dll", "status": "PROCESSING" }, "id": "1sdVF000002DfVeYAK", "label": "S3Stream", "name": "S3Stream", "recordId": "1dsVF000000a0Kr", "status": "PROCESSING" } ``` _Example: S3 data stream from existing DLO response_ ``` { "dataLakeObjectInfo": { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "id": "0gOVF000000n00T2AQ", "label": "S3Stream", "name": "S3Stream__dll", "status": "ACTIVE" }, "id": "1sdVF000002DfXFYA0", "label": "S3Stream", "name": "S3Stream", "recordId": "1dsVF000000a0MT", "status": "PROCESSING" } ``` _Example: S3 data stream with org currency response_ ``` { "dataLakeObjectInfo": { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Currency", "isPrimaryKey": false, "label": "currency", "name": "currency" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_record_currency", "name": "cdp_sys_record_currency" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_bikeid", "name": "KQ_bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "usertype", "name": "usertype" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Currency", "isPrimaryKey": false, "label": "currency", "name": "currency" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "formulaDate", "name": "formulaDate" }, { "dataType": "Number", "isPrimaryKey": false, "label": "trip_id", "name": "trip_id" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "DateDifference", "name": "DateDifference" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_record_currency", "name": "cdp_sys_record_currency" }, { "dataType": "Number", "isPrimaryKey": true, "label": "bikeid", "name": "bikeid" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "id": "0gOVF000000n03h2AA", "label": "S3Stream", "name": "S3Stream__dll", "status": "PROCESSING" }, "id": "1sdVF000002DfdiYAC", "label": "S3Stream", "name": "S3Stream", "recordId": "1dsVF000000a0O5", "status": "PROCESSING" } ``` ### GET Get data stream `GET /ssot/data-streams/{recordIdOrDeveloperName}` Tags: Data Streams. Get a data stream. **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) Record ID or developer name of the data stream. **Available Version:** 60.0 * `includeMappings` (query, string) Indicates whether or not to include mappings in the results. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataStreamDetailedRepresentation`. _Example: Example_ ``` { "advancedAttributes": {}, "connectorInfo": { "connectorDetails": { "name": "SalesforceDotCom_Home", "sourceObject": "Account" }, "connectorType": "SalesforceDotCom" }, "dataAccessMode": "INGEST", "dataLakeObjectInfo": { "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "Billing City", "name": "BillingCity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Zip/Postal Code", "name": "ShippingPostalCode" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Master Record ID", "name": "MasterRecordId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping City", "name": "ShippingCity" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing State/Province", "name": "BillingState" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Deleted", "name": "IsDeleted" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Last Modified By ID", "name": "LastModifiedById" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Country", "name": "BillingCountry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SIC Description", "name": "SicDesc" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Referenced Date", "name": "LastReferencedDate" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Billing Latitude", "name": "BillingLatitude" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Created Date", "name": "CreatedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Source", "name": "AccountSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Number", "name": "AccountNumber" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Annual Revenue", "name": "AnnualRevenue" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Geocode Accuracy", "name": "BillingGeocodeAccuracy" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Billing Longitude", "name": "BillingLongitude" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Activity", "name": "LastActivityDate" }, { "dataType": "Url", "isPrimaryKey": false, "label": "Photo URL", "name": "PhotoUrl" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Jigsaw Company ID", "name": "JigsawCompanyId" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Account Fax", "name": "Fax" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Industry", "name": "Industry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Street", "name": "BillingStreet" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Parent Account ID", "name": "ParentId" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Viewed Date", "name": "LastViewedDate" }, { "dataType": "Phone", "isPrimaryKey": false, "label": "Account Phone", "name": "Phone" }, { "dataType": "Url", "isPrimaryKey": false, "label": "Website", "name": "Website" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "LastModifiedDate" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Created By ID", "name": "CreatedById" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping State/Province", "name": "ShippingState" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Street", "name": "ShippingStreet" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Billing Zip/Postal Code", "name": "BillingPostalCode" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Description", "name": "Description" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Name", "name": "Name" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Employees", "name": "NumberOfEmployees" }, { "dataType": "Text", "isPrimaryKey": false, "label": "SfdcOrganizationId", "name": "SfdcOrganizationId" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Shipping Longitude", "name": "ShippingLongitude" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Shipping Latitude", "name": "ShippingLatitude" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data.com Key", "name": "Jigsaw" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Account Type", "name": "Type" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "System Modstamp", "name": "SystemModstamp" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Geocode Accuracy", "name": "ShippingGeocodeAccuracy" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Shipping Country", "name": "ShippingCountry" }, { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Id", "name": "KQ_Id" }, { "dataType": "Text", "isPrimaryKey": true, "label": "Account ID", "name": "Id" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Owner ID", "name": "OwnerId" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "label": "Account_Home", "name": "Account_Home__dll", "recordModifiedFieldName": "SystemModstamp", "status": "ACTIVE" }, "dataStreamType": "SFDC", "isEnabled": true, "label": "Account_Home", "lastRunStatus": "FAILURE", "mappings": [], "name": "Account_Home", "recordId": "1dsQZ000000AcFJYA0", "refreshConfig": { "frequency": { "frequencyType": "BATCH", "hours": [], "refreshDayOfMonth": [] }, "hasHeaders": false, "isAccelerationEnabled": false, "refreshMode": "UPSERT", "shouldFetchImmediately": false, "shouldTreatMissingFilesAsFailures": false }, "sourceFields": [ { "datatype": "Text", "name": "Id" }, { "datatype": "Text", "name": "IsDeleted" }, { "datatype": "Text", "name": "MasterRecordId" }, { "datatype": "Text", "name": "Name" }, { "datatype": "Text", "name": "Type" }, { "datatype": "Text", "name": "ParentId" }, { "datatype": "Text", "name": "BillingStreet" }, { "datatype": "Text", "name": "BillingCity" }, { "datatype": "Text", "name": "BillingState" }, { "datatype": "Text", "name": "BillingPostalCode" }, { "datatype": "Text", "name": "BillingCountry" }, { "datatype": "Number", "name": "BillingLatitude" }, { "datatype": "Number", "name": "BillingLongitude" }, { "datatype": "Text", "name": "BillingGeocodeAccuracy" }, { "datatype": "Text", "name": "ShippingStreet" }, { "datatype": "Text", "name": "ShippingCity" }, { "datatype": "Text", "name": "ShippingState" }, { "datatype": "Text", "name": "ShippingPostalCode" }, { "datatype": "Text", "name": "ShippingCountry" }, { "datatype": "Number", "name": "ShippingLatitude" }, { "datatype": "Number", "name": "ShippingLongitude" }, { "datatype": "Text", "name": "ShippingGeocodeAccuracy" }, { "datatype": "Phone", "name": "Phone" }, { "datatype": "Phone", "name": "Fax" }, { "datatype": "Text", "name": "AccountNumber" }, { "datatype": "Url", "name": "Website" }, { "datatype": "Url", "name": "PhotoUrl" }, { "datatype": "Text", "name": "Industry" }, { "datatype": "Number", "name": "AnnualRevenue" }, { "datatype": "Number", "name": "NumberOfEmployees" }, { "datatype": "Text", "name": "Description" }, { "datatype": "Text", "name": "OwnerId" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "CreatedDate" }, { "datatype": "Text", "name": "CreatedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastModifiedDate" }, { "datatype": "Text", "name": "LastModifiedById" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "SystemModstamp" }, { "datatype": "DateTime", "format": "yyyy-MM-dd", "name": "LastActivityDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastViewedDate" }, { "datatype": "DateTime", "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "name": "LastReferencedDate" }, { "datatype": "Text", "name": "Jigsaw" }, { "datatype": "Text", "name": "JigsawCompanyId" }, { "datatype": "Text", "name": "AccountSource" }, { "datatype": "Text", "name": "SicDesc" }, { "datatype": "Text", "name": "SfdcOrganizationId" } ], "status": "ACTIVE" } ``` ### DELETE Delete data stream `DELETE /ssot/data-streams/{recordIdOrDeveloperName}` Tags: Data Streams. Delete a data stream. **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) Record ID or developer name of the data stream. **Available Version:** 60.0 * `shouldDeleteDataLakeObject` (query, boolean) Indicates whether to delete the data lake objects (DLOs) associated with the data stream (`true`) or not (`false`). The default value is `false`. **Available Version:** 60.0 #### Responses * **204** Success ### PATCH Update data stream `PATCH /ssot/data-streams/{recordIdOrDeveloperName}` Tags: Data Streams. Update a data stream. > **Note:** Refer to the [Data 360 Data Streams Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/data-stream-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 60.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) Record ID or developer name of the data stream. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `DataStreamPatchInputRepresentation`. _Example: S3 data stream request_ ``` { "datastreamType": "CONNECTORSFRAMEWORK", "label": "updatedLabel", "refreshConfig": { "refreshMode": "TOTAL_REPLACE", "frequency": { "frequencyType": "WEEKLY", "refreshDayOfWeek": "Monday", "hours": [ 8 ] } }, "advancedAttributes": { "fileName": "*.csv", "importDirectory": "divyy", "isMissingFileFailure": false, "areHeadersIncludedInFile": true } } ``` _Example: BYOL data stream request_ ``` { "datastreamType": "EXTERNAL", "sourceFields": [ { "dataType": "Text", "name": "NAME" } ], "mappings": [ { "transformationFormula": "", "targetFieldName": "version", "targetFieldReturntype": "Text" }, { "sourceFieldLabel": "NAME", "targetFieldName": "name" } ], "dataLakeObjectInfo": { "dataLakeFieldInputRepresentations": [ { "dataType": "Text", "label": "name", "name": "name" } ] }, "refreshConfig": { "isAccelerationEnabled": "true", "refreshMode": "INCREMENTAL", "frequency": { "frequencyType": "Hourly" } }, "advancedAttributes": { "incrementalColumn": "CREATED" } } ``` _Example: Add a new source field request_ ``` { "sourceFields": [ { "dataType": "Text", "name": "NewField" } ], "mappings": [ { "sourceFieldLabel": "NewField", "targetFieldName": "NewField", "targetFieldReturntype": "Text" } ] } ``` _Example: Add a new formula field request_ ``` { "sourceFields": [ { "dataType": "Text", "name": "first name" }, { "dataType": "Text", "name": "last name" } ], "mappings": [ { "transformationFormula": "CONCAT(sourceField['first name']", "targetFieldName": "full_name", "targetFieldReturntype": "TEXT" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataStreamRepresentation`. _Example: S3 data stream response_ ``` { "dataLakeObjectInfo": { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Primary_Key", "name": "KQ_Primary_Key" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "Last_Modified_Date" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Yearly Income", "name": "Yearly_Income" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Custom Individual", "name": "Custom_Individual" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Last Name", "name": "Last_Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Number", "isPrimaryKey": true, "label": "Primary Key", "name": "Primary_Key" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "First Name", "name": "First_Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_Primary_Key", "name": "KQ_Primary_Key" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "Last Modified Date", "name": "Last_Modified_Date" }, { "dataType": "Number", "isPrimaryKey": false, "label": "Yearly Income", "name": "Yearly_Income" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Custom Individual", "name": "Custom_Individual" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Last Name", "name": "Last_Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Number", "isPrimaryKey": true, "label": "Primary Key", "name": "Primary_Key" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "First Name", "name": "First_Name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion" } ], "id": "0gOVF000000kgfO2AQ", "label": "DLODataStream_1751974529429", "name": "DLODataStream_1751974529429__dll", "recordModifiedFieldName": "Last_Modified_Date", "status": "ACTIVE" }, "id": "1sdVF0000026HLEYA2", "label": "DLODataStream_1751974529429", "name": "DLODataStream_1751974529429", "recordId": "1dsVF000000YLhyYAG", "status": "PROCESSING" } ``` _Example: BYOL data stream response_ ``` { "dataLakeObjectInfo": { "capabilities": {}, "category": "Profile", "dataLakeFieldInfoRepresentation": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_schema_name", "name": "KQ_schema_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "VERSION", "name": "version" }, { "dataType": "Text", "isPrimaryKey": true, "label": "SCHEMA_NAME", "name": "schema_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "DATABASE_NAME", "name": "database_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "CREATED", "name": "created" }, { "dataType": "Text", "isPrimaryKey": false, "label": "IS_SERVICE_CLASS", "name": "is_service_class" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "COMMENT", "name": "comment" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "name", "name": "name" } ], "dataSpaceInfo": [ { "label": "default", "name": "default" } ], "fields": [ { "dataType": "Text", "isPrimaryKey": false, "label": "KQ_schema_name", "name": "KQ_schema_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "VERSION", "name": "version" }, { "dataType": "Text", "isPrimaryKey": true, "label": "SCHEMA_NAME", "name": "schema_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "DATABASE_NAME", "name": "database_name" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source", "name": "DataSource" }, { "dataType": "DateTime", "isPrimaryKey": false, "label": "CREATED", "name": "created" }, { "dataType": "Text", "isPrimaryKey": false, "label": "IS_SERVICE_CLASS", "name": "is_service_class" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Data Source Object", "name": "DataSourceObject" }, { "dataType": "Text", "isPrimaryKey": false, "label": "COMMENT", "name": "comment" }, { "dataType": "Text", "isPrimaryKey": false, "label": "Internal Organization", "name": "InternalOrganization" }, { "dataType": "Text", "isPrimaryKey": false, "label": "name", "name": "name" } ], "id": "0gOVF000000p7Yv2AI", "label": "testSnowFlake", "name": "testSnowFlake__dll", "status": "PROCESSING" }, "id": "1sdVF000002JsI6YAK", "label": "testSnowFlake", "name": "testSnowFlake", "recordId": "1dsVF000000bcxZYAQ", "status": "PROCESSING" } ``` ### POST Run data streams `POST /ssot/data-streams/{recordIdOrDeveloperName}/actions/run` Tags: Data Streams. Start a data stream run to ingest data from the source and refresh the data lake object (DLO). **Available Version:** 62.0 #### Parameters * `recordIdOrDeveloperName` (path, string, required) Record ID or developer name of the data stream. **Available Version:** 60.0 * `interactive` (query, boolean) Indicates whether to execute fast forward conversion for the data stream (`true`) or not (`false`). The default value is `false`. `true` is supported only for file upload connector types. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataStreamActionResponseRepresentation`. ### GET Get data transforms `GET /ssot/data-transforms` Tags: Data Transforms. Get a list of data transforms. **Available Version:** 60.0 #### Parameters * `filterGroup` (query, string) Group on which to filter response results. Valid values are `Big`, `Medium`, and `Small`. * `Big` provides comprehensive results by returning properties whose filter group is `Big`, `Medium`, or `Small`. * `Medium` provides moderate results by returning properties whose filter group is `Medium` or `Small`. * `Small` provides essential results by returning only properties whose filter group is `Small`. The default is `Big`. **Available Version:** 60.0 * `limit` (query, integer) Maximum number of rows to return from `1` through `20`. If unspecified, the default number of rows is `20`. **Available Version:** 60.0 * `offset` (query, integer) Number of rows to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 60.0 * `orderBy` (query, string) Sort order for the result set. If unspecified, items are returned in the order they are retrieved. **Available Version:** 60.0 Allowed values: `DataTransformStatusAsc`, `DataTransformStatusDesc`, `LabelAsc`, `LabelDesc`, `LastRunStatusAsc`, `LastRunStatusDesc`, `LastRunTimeAsc`, `LastRunTimeDesc`, `MruAsc`, `MruDesc`, `NameAsc`, `NameDesc`, `TypeAsc`, `TypeDesc`. #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "/services/data/v63.0/ssot/data-transforms?limit=20&offset=0&orderBy=MruDesc", "dataTransforms": [ { "actionUrls": { "refreshStatusAction": "/services/data/v63.0/ssot/data-transforms/StreamingDataTransformTest/actions/rebuild", "retryAction": "/services/data/v63.0/ssot/data-transforms/StreamingDataTransformTest/actions/retry" }, "createdBy": { "id": "005AAA00000BT3VYBW", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-02-26T23:21:26.000Z", "creationType": "CUSTOM", "definition": { "expression": "SELECT\n Case_Home__dll.Id__c as Id__c,\n Case_Home__dll.Status__c as Status__c\nFrom Case_Home__dll", "outputDataObjects": [ { "category": "Profile", "createdDate": "2025-02-26T22:54:29.000Z", "fields": [ { "isPrimaryKey": true, "keyQualifierField": "KQ_Id", "label": "Case ID", "name": "Id__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_Status", "label": "Status", "name": "Status__c", "type": "Text" } ], "id": "0gOAAA0000006jm2BA", "label": "VIP_Cases", "lastModifiedDate": "2025-02-26T22:54:32.000Z", "name": "VIP_Cases__dll", "status": "active", "type": "dataLakeObject" } ], "targetDlo": "VIP_Cases__dll", "type": "SQL", "version": "63.0" }, "description": "Selects two fields from a Case DLO and outputs those to the target DLO. Does no real transformation: real-life data transforms have more complex payloads.", "id": "1dtAAA0000000KzYBI", "label": "StreamingDataTransformTest", "lastModifiedBy": { "id": "005AAA00000BT57YBG", "name": "Automated Process", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-02-26T23:21:27.000Z", "lastRunStatus": "NONE", "name": "StreamingDataTransformTest", "status": "ACTIVE", "type": "STREAMING", "url": "/services/data/v63.0/ssot/data-transforms/StreamingDataTransformTest" }, { "actionUrls": { "cancelAction": "/services/data/v63.0/ssot/data-transforms/BatchDataTransformTest/actions/cancel", "refreshStatusAction": "/services/data/v63.0/ssot/data-transforms/BatchDataTransformTest/actions/refresh-status", "retryAction": "/services/data/v63.0/ssot/data-transforms/BatchDataTransformTest/actions/retry", "runAction": "/services/data/v63.0/ssot/data-transforms/BatchDataTransformTest/actions/run" }, "createdBy": { "id": "005AAA00000BT3VYBW", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-02-26T23:00:29.000Z", "creationType": "CUSTOM", "definition": { "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "Case_Home__dll", "type": "dataLakeObject" }, "fields": [ "DataSourceObject__c", "KQ_Id__c", "Id__c", "Subject__c", "Status__c", "SystemModstamp__c", "DataSource__c", "SfdcOrganizationId__c", "cdp_sys_SourceVersion__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "fieldsMappings": [ { "sourceField": "Id__c", "targetField": "Id__c" }, { "sourceField": "Status__c", "targetField": "Status__c" }, { "sourceField": "SystemModstamp__c", "targetField": "SystemModstamp__c" }, { "sourceField": "SfdcOrganizationId__c", "targetField": "SfdcOrganizationId__c" }, { "sourceField": "cdp_sys_SourceVersion__c", "targetField": "cdp_sys_SourceVersion__c" } ], "name": "Case_Target__dll", "type": "dataLakeObject" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "createdDate": "2025-02-26T22:56:44.000Z", "fields": [ { "isPrimaryKey": false, "keyQualifierField": "KQ_cdp_sys_SourceVersion", "label": "cdp_sys_SourceVersion", "name": "cdp_sys_SourceVersion__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_Status", "label": "Status", "name": "Status__c", "type": "Text" }, { "isPrimaryKey": true, "keyQualifierField": "KQ_Id", "label": "Case ID", "name": "Id__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_SystemModstamp", "label": "System Modstamp", "name": "SystemModstamp__c", "type": "DateTime" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_SfdcOrganizationId", "label": "SfdcOrganizationId", "name": "SfdcOrganizationId__c", "type": "Text" } ], "id": "0gOAAA0000006mz2BA", "label": "Case Target", "lastModifiedDate": "2025-02-26T22:56:47.000Z", "name": "Case_Target__dll", "recordModifiedFieldName": "SystemModstamp", "status": "active", "type": "dataLakeObject" } ], "type": "STL", "ui": { "nodes": { "LOAD_DATASET0": { "label": "Case_Home", "type": "LOAD_DATASET", "top": 112, "left": 112, "parameters": { "sampleSize": 500 } }, "OUTPUT0": { "label": "Output 0", "type": "OUTPUT", "top": 112, "left": 252 } }, "connectors": [ { "source": "LOAD_DATASET0", "target": "OUTPUT0" } ], "hiddenColumns": [] }, "version": "56.0" }, "id": "1dtAAA0000000JNYBY", "label": "BatchDataTransformTest", "lastModifiedBy": { "id": "005AAA00000BT57YBG", "name": "Automated Process", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-02-26T23:18:44.000Z", "lastRunStatus": "NONE", "name": "BatchDataTransformTest", "status": "ACTIVE", "type": "BATCH", "url": "/services/data/v63.0/ssot/data-transforms/BatchDataTransformTest" } ], "errors": [], "totalSize": 2 } ``` * **401** Insufficient access. Development gate is closed or access check is false. * **404** User does not have read access to this data transform. ### POST Create data transform `POST /ssot/data-transforms` Tags: Data Transforms. Create a data transform. **Available Version:** 60.0 #### Parameters * `filterGroup` (query, string) Group on which to filter response results. Valid values are `Big`, `Medium`, and `Small`. * `Big` provides comprehensive results by returning properties whose filter group is `Big`, `Medium`, or `Small`. * `Medium` provides moderate results by returning properties whose filter group is `Medium` or `Small`. * `Small` provides essential results by returning only properties whose filter group is `Small`. The default is `Big`. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `DataTransformInputRepresentation`. _Example: Batch data transform request_ ``` { "definition": { "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "Account_Home__dll", "type": "dataLakeObject" }, "fields": [ "Id__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "fieldsMappings": [ { "sourceField": "Id__c", "targetField": "Id__c" } ], "name": "Account_Home_Clean__dll", "type": "dataLakeObject" }, "sources": [ "LOAD_DATASET0" ] } }, "type": "STL", "version": "56.0" }, "label": "Batch Account Cleaning", "name": "BatchAccountCleaning", "type": "BATCH" } ``` _Example: Batch data transform with schedule request_ ``` { "definitions": [ { "label": "Contact Profile Definition", "name": "ContactProfileDefinition", "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "SourceContact__dll", "type": "dataLakeObject" }, "fields": [ "MobilePhone__c", "IndividualId__c", "LastName__c", "FirstName__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "dedupOrder": [], "fieldsMappings": [ { "sourceField": "MobilePhone__c", "targetField": "MobilePhone__c" }, { "sourceField": "IndividualId__c", "targetField": "IndividualId__c" }, { "sourceField": "LastName__c", "targetField": "LastName__c" }, { "sourceField": "FirstName__c", "targetField": "FirstName__c" } ], "name": "ContactProfile__dll", "type": "dataLakeObject", "writeMode": "OVERWRITE" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "fields": [ { "isPrimaryKey": false, "keyQualifierField": "KQ_MobilePhone", "label": "Mobile Phone", "name": "MobilePhone__c", "type": "Phone" }, { "isPrimaryKey": true, "keyQualifierField": "KQ_IndividualId", "label": "Individual ID", "name": "IndividualId__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_LastName", "label": "Last Name", "name": "LastName__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_FirstName", "label": "First Name", "name": "FirstName__c", "type": "Text" } ], "label": "Contact Profile", "name": "ContactProfile__dll", "type": "dataLakeObject" } ], "type": "STL", "ui": { "nodes": { "LOAD_DATASET0": { "label": "Contact", "type": "LOAD_DATASET", "top": 112, "left": 112, "parameters": { "sampleSize": 500, "sampleDetails": { "type": "TopN", "dataspace": "default" } } }, "OUTPUT0": { "label": "ContactProfile__dll", "type": "OUTPUT", "top": 112, "left": 252 } }, "connectors": [ { "source": "LOAD_DATASET0", "target": "OUTPUT0" } ], "hiddenColumns": [] }, "version": "56.0" }, { "label": "Contact Profile Scheduled Definition", "name": "ContactProfileScheduledDefinition", "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "SourceContact__dll", "type": "dataLakeObject" }, "fields": [ "MobilePhone__c", "IndividualId__c", "LastName__c", "FirstName__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "dedupOrder": [], "fieldsMappings": [ { "sourceField": "MobilePhone__c", "targetField": "MobilePhone__c" }, { "sourceField": "IndividualId__c", "targetField": "IndividualId__c" }, { "sourceField": "LastName__c", "targetField": "LastName__c" }, { "sourceField": "FirstName__c", "targetField": "FirstName__c" } ], "name": "ContactProfileHourly__dll", "type": "dataLakeObject", "writeMode": "OVERWRITE" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "fields": [ { "isPrimaryKey": false, "keyQualifierField": "KQ_MobilePhone", "label": "Mobile Phone", "name": "MobilePhone__c", "type": "Phone" }, { "isPrimaryKey": true, "keyQualifierField": "KQ_IndividualId", "label": "Individual ID", "name": "IndividualId__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_LastName", "label": "Last Name", "name": "LastName__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_FirstName", "label": "First Name", "name": "FirstName__c", "type": "Text" } ], "label": "Contact Profile Hourly", "name": "ContactProfileHourly__dll", "type": "dataLakeObject" } ], "schedule": { "daysOfWeek": [ "Wednesday", "Thursday" ], "frequency": "Hourly", "interval": 6, "time": { "hour": 17, "minute": 0, "timeZone": "America/Los_Angeles" } }, "type": "STL", "ui": { "nodes": { "LOAD_DATASET0": { "label": "Contact", "type": "LOAD_DATASET", "top": 112, "left": 112, "parameters": { "sampleSize": 500, "sampleDetails": { "type": "TopN", "dataspace": "default" } } }, "OUTPUT0": { "label": "ContactProfileHourly__dll", "type": "OUTPUT", "top": 112, "left": 252 } }, "connectors": [ { "source": "LOAD_DATASET0", "target": "OUTPUT0" } ], "hiddenColumns": [] }, "version": "56.0" } ], "label": "Contact Profile Transform", "name": "ContactProfileTransform", "type": "BATCH" } ``` _Example: Streaming data transform request_ ``` { "definition": { "expression": "SELECT\nAccount_Home__dll.Id__c as Id__c, '***' as Name__c FROM Account_Home__dll", "targetDlo": "Account_Home_Annon__dll", "type": "SQL", "version": "63.0" }, "label": "AccountAnnon", "name": "AccountAnnon", "type": "STREAMING" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformRepresentation`. _Example: Batch data transform response_ ``` { "actionUrls": { "cancelAction": "/services/data/v63.0/ssot/data-transforms/BatchAccountCleaning/actions/cancel", "refreshStatusAction": "/services/data/v63.0/ssot/data-transforms/BatchAccountCleaning/actions/refresh-status", "retryAction": "/services/data/v63.0/ssot/data-transforms/BatchAccountCleaning/actions/retry", "runAction": "/services/data/v63.0/ssot/data-transforms/BatchAccountCleaning/actions/run" }, "createdBy": { "id": "005AAA00000BT3VYBW", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-03-03T19:08:37.000Z", "creationType": "CUSTOM", "definition": { "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "Account_Home__dll", "type": "dataLakeObject" }, "fields": [ "Id__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "fieldsMappings": [ { "sourceField": "Id__c", "targetField": "Id__c" } ], "name": "Account_Home_Clean__dll", "type": "dataLakeObject" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "createdDate": "2025-03-03T19:08:00.000Z", "fields": [ { "isPrimaryKey": true, "keyQualifierField": "KQ_Id", "label": "Account ID", "name": "Id__c", "type": "Text" } ], "id": "0gOAAA00000074j2BA", "label": "Account_Home_Clean", "lastModifiedDate": "2025-03-03T19:08:08.000Z", "name": "Account_Home_Clean__dll", "status": "processing", "type": "dataLakeObject" } ], "type": "STL", "version": "63.0" }, "id": "1dtAAA0000000MbYBI", "label": "Batch Account Cleaning", "lastModifiedBy": { "id": "005AAA00000BT3VYBW", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://orgfarm-33b0405cd1.perf2r.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-03-03T19:08:37.000Z", "lastRunStatus": "NONE", "name": "BatchAccountCleaning", "status": "PROCESSING", "type": "BATCH", "url": "/services/data/v63.0/ssot/data-transforms/BatchAccountCleaning" } ``` * **400** Bad request. For example: * Validation fails on _definition.nodes_. * Streaming data transform cannot have multiple definitions. * Batch data transform definition limit exceeded. * **401** Insufficient access. * **409** Developer name already exists. ### GET Get data transform `GET /ssot/data-transforms/{dataTransformNameOrId}` Tags: Data Transforms. Get a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to update. **Available Version:** 60.0 * `filterGroup` (query, string) Group on which to filter response results. Valid values are `Big`, `Medium`, and `Small`. * `Big` provides comprehensive results by returning properties whose filter group is `Big`, `Medium`, or `Small`. * `Medium` provides moderate results by returning properties whose filter group is `Medium` or `Small`. * `Small` provides essential results by returning only properties whose filter group is `Small`. The default is `Big`. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformRepresentation`. * **401** Insufficient access. * **404** User does not have read access to this data transform. ### PUT Update data transform `PUT /ssot/data-transforms/{dataTransformNameOrId}` Tags: Data Transforms. Update a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to update. **Available Version:** 60.0 * `filterGroup` (query, string) Group on which to filter response results. Valid values are `Big`, `Medium`, and `Small`. * `Big` provides comprehensive results by returning properties whose filter group is `Big`, `Medium`, or `Small`. * `Medium` provides moderate results by returning properties whose filter group is `Medium` or `Small`. * `Small` provides essential results by returning only properties whose filter group is `Small`. The default is `Big`. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `DataTransformInputRepresentation`. _Example: Batch data transform with schedule request_ ``` { "definitions": [ { "label": "Contact Profile Definition", "name": "ContactProfileDefinition", "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "SourceContact__dll", "type": "dataLakeObject" }, "fields": [ "MobilePhone__c", "IndividualId__c", "LastName__c", "FirstName__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "dedupOrder": [], "fieldsMappings": [ { "sourceField": "MobilePhone__c", "targetField": "MobilePhone__c" }, { "sourceField": "IndividualId__c", "targetField": "IndividualId__c" }, { "sourceField": "LastName__c", "targetField": "LastName__c" }, { "sourceField": "FirstName__c", "targetField": "FirstName__c" } ], "name": "ContactProfile__dll", "type": "dataLakeObject", "writeMode": "OVERWRITE" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "fields": [ { "isPrimaryKey": false, "keyQualifierField": "KQ_MobilePhone", "label": "Mobile Phone", "name": "MobilePhone__c", "type": "Phone" }, { "isPrimaryKey": true, "keyQualifierField": "KQ_IndividualId", "label": "Individual ID", "name": "IndividualId__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_LastName", "label": "Last Name", "name": "LastName__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_FirstName", "label": "First Name", "name": "FirstName__c", "type": "Text" } ], "label": "Contact Profile", "name": "ContactProfile__dll", "type": "dataLakeObject" } ], "type": "STL", "ui": { "nodes": { "LOAD_DATASET0": { "label": "Contact", "type": "LOAD_DATASET", "top": 112, "left": 112, "parameters": { "sampleSize": 500, "sampleDetails": { "type": "TopN", "dataspace": "default" } } }, "OUTPUT0": { "label": "ContactProfile__dll", "type": "OUTPUT", "top": 112, "left": 252 } }, "connectors": [ { "source": "LOAD_DATASET0", "target": "OUTPUT0" } ], "hiddenColumns": [] }, "version": "56.0" }, { "label": "Contact Profile Scheduled Definition", "name": "ContactProfileScheduledDefinition", "nodes": { "LOAD_DATASET0": { "action": "load", "parameters": { "dataset": { "name": "SourceContact__dll", "type": "dataLakeObject" }, "fields": [ "MobilePhone__c", "IndividualId__c", "LastName__c", "FirstName__c" ], "sampleDetails": { "sortBy": [], "type": "TopN" } }, "sources": [] }, "OUTPUT0": { "action": "outputD360", "parameters": { "dedupOrder": [], "fieldsMappings": [ { "sourceField": "MobilePhone__c", "targetField": "MobilePhone__c" }, { "sourceField": "IndividualId__c", "targetField": "IndividualId__c" }, { "sourceField": "LastName__c", "targetField": "LastName__c" }, { "sourceField": "FirstName__c", "targetField": "FirstName__c" } ], "name": "ContactProfileHourly__dll", "type": "dataLakeObject", "writeMode": "OVERWRITE" }, "sources": [ "LOAD_DATASET0" ] } }, "outputDataObjects": [ { "category": "Profile", "fields": [ { "isPrimaryKey": false, "keyQualifierField": "KQ_MobilePhone", "label": "Mobile Phone", "name": "MobilePhone__c", "type": "Phone" }, { "isPrimaryKey": true, "keyQualifierField": "KQ_IndividualId", "label": "Individual ID", "name": "IndividualId__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_LastName", "label": "Last Name", "name": "LastName__c", "type": "Text" }, { "isPrimaryKey": false, "keyQualifierField": "KQ_FirstName", "label": "First Name", "name": "FirstName__c", "type": "Text" } ], "label": "Contact Profile Hourly", "name": "ContactProfileHourly__dll", "type": "dataLakeObject" } ], "schedule": { "daysOfWeek": [ "Wednesday", "Thursday", "Friday" ], "frequency": "Hourly", "interval": 8, "time": { "hour": 17, "minute": 0, "timeZone": "America/Los_Angeles" } }, "type": "STL", "ui": { "nodes": { "LOAD_DATASET0": { "label": "Contact", "type": "LOAD_DATASET", "top": 112, "left": 112, "parameters": { "sampleSize": 500, "sampleDetails": { "type": "TopN", "dataspace": "default" } } }, "OUTPUT0": { "label": "ContactProfileHourly__dll", "type": "OUTPUT", "top": 112, "left": 252 } }, "connectors": [ { "source": "LOAD_DATASET0", "target": "OUTPUT0" } ], "hiddenColumns": [] }, "version": "56.0" } ], "label": "Contact Profile Transform", "name": "ContactProfileTransform", "type": "BATCH" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformRepresentation`. * **400** Bad request. For example: * Streaming data transform cannot have multiple definitions. * Batch data transform definition limit exceeded. * Multi-definition transform cannot be moved to single definition. ### DELETE Delete data transform `DELETE /ssot/data-transforms/{dataTransformNameOrId}` Tags: Data Transforms. Initiate the deletion of a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to update. **Available Version:** 60.0 #### Responses * **200** Success * **400** Delete not allowed. * **401** Insufficient access. ### POST Cancel data transform `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/cancel` Tags: Data Transforms. Cancel a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to cancel. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataTransformActionResponseRepresentation`. ### POST Rebuild data transform `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/rebuild` Tags: Data Transforms. Rebuild a streaming data transform. **Available Version:** 61.0 #### Parameters * `requestedBy` (query, string) ID of the user requesting the rebuild. **Available Version:** 61.0 * `dataTransformNameOrId` (path, string, required) Record ID or API name of the data transform. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `RebuildActionInputRepresentation`. _Example: example1_ ``` { "transforms": [ "CustomerDataTransform", "OrderHistoryTransform" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataTransformActionResponseRepresentation`. _Example: example1_ ``` { "success": true, "errors": [], "shouldForceFullRun": true } ``` ### POST Refresh data transform status `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/refresh-status` Tags: Data Transforms. Refresh the status of a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to refresh. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataTransformActionResponseRepresentation`. ### POST Retry data transform `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/retry` Tags: Data Transforms. Retry a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to retry. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataTransformActionResponseRepresentation`. ### POST Run data transform `POST /ssot/data-transforms/{dataTransformNameOrId}/actions/run` Tags: Data Transforms. Run a data transform. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform to run. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpDataTransformActionResponseRepresentation`. * **400** Bad request. For example: * Unable to run streaming transform. * Unable to run inactive transform. * Definition name is required for multi-definition transforms. ### GET Get data transform run history `GET /ssot/data-transforms/{dataTransformNameOrId}/run-history` Tags: Data Transforms. Get information about all the jobs that the batch or streaming data transform has run. Only information about completed jobs is returned. Return the history of each job, such as the job's duration and end time. For batch data transforms, return information about the output node such as the node's name and type. For more information about data transforms, see [Data Cleansing and Preparation](https://help.salesforce.com/s/articleView?id=data.c360_a_cleansing_data.htm&type=5). **Available Version:** 62.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Developer name or ID of the data transform to get run history for. **Available Version:** 62.0 * `limit` (query, integer) Maximum number of run jobs to return. **Available Version:** 62.0 * `offset` (query, integer) Number of run history records to skip before returning results. Must be an integer greater than zero. If unspecified, no rows are skipped. **Available Version:** 62.0 #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformRunHistoryCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "/services/data/v63.0/ssot/data-transforms/batch/run-history?limit=50&offset=0", "histories": [ { "duration": 43, "endTime": "2024-10-30T22:08:49.250Z", "isVersionChanged": false, "outputStatus": [ { "completedDate": "2024-10-30T22:08:43.458Z", "dataObjectName": "batchOut__dll", "dataObjectType": "dataLakeObject", "name": "OUTPUT0", "status": "SUCCESS", "totalRows": 4 } ], "processedRows": 4, "runMode": "full", "runModeParameters": [], "runModeReason": "FunctionsRequireFullRun", "startTime": "2024-10-30T22:08:06.579Z", "status": "SUCCESS" }, { "duration": 31, "endTime": "2024-10-30T21:06:58.483Z", "isVersionChanged": false, "outputStatus": [ { "completedDate": "2024-10-30T21:06:57.914Z", "dataObjectName": "batchOut__dll", "dataObjectType": "dataLakeObject", "name": "OUTPUT0", "status": "SUCCESS", "totalRows": 0 } ], "processedRows": 0, "runMode": "full", "runModeParameters": [], "runModeReason": "NOT_A_SCHEDULED_RUN", "startTime": "2024-10-30T21:06:27.307Z", "status": "SUCCESS" } ], "nextPageUrl": "/services/data/v63.0/ssot/data-transforms/batch/run-history?limit=50&offset=50", "totalSize": 2 } ``` ### GET Get data transform schedule `GET /ssot/data-transforms/{dataTransformNameOrId}/schedule` Tags: Data Transforms. Get a data transform's schedule. The response contains different fields depending on its frequency. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpScheduleBaseRepresentation`. * **400** Bad request. For example, the definition name is required for multi-definition transforms. * **403** Invalid input. ### PUT Update data transform schedule `PUT /ssot/data-transforms/{dataTransformNameOrId}/schedule` Tags: Data Transforms. Update a data transform's schedule. **Available Version:** 60.0 #### Parameters * `dataTransformNameOrId` (path, string, required) Name or ID of the data transform. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `CdpScheduleInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `CdpScheduleBaseRepresentation`. ### POST Validate data transform `POST /ssot/data-transforms-validation` Tags: Data Transforms. Validate your data transform before you create it. * If the data transform is valid, this request returns an example of the data structure of the target object's output. * If the data transform is invalid, this request returns a list of issues that contain information about errors and possible resolutions. **Available Version:** 62.0 #### Request body (required) Media type: `application/json`. Schema: `DataTransformInputRepresentation`. _Example: Example_ ``` { "name": "IndividualStreaming", "label": "IndividualStreaming", "description": "", "type": "Streaming", "definition": { "expression": "SELECT Individual__dll.id__c as id__c FROM Individual__dll", "targetDlo": "Individual_target__dll", "type": "SQL" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `DataTransformValidationRepresentation`. _Example: Example_ ``` { "issues": [ { "errorCode": "INVALID_DATA_TRANSFORM_DEFINITION", "errorMessage": "The Data Transform API name already exists. Please provide a unique Data Transform API name.", "errorSeverity": "ERROR" }, { "errorCode": "INVALID_TARGET_DLO", "errorMessage": "Another streaming data transform is using these input and output sources. Select a different input or output.", "errorSeverity": "ERROR" } ], "outputDataObjects": [] } ``` ### POST Detect Document AI schema `POST /ssot/document-processing/actions/detect-schema` Tags: Document AI. Detect which extraction schema best matches a document from PDF, image, Microsoft Word (.docx), PowerPoint (.pptx), Excel (.xlsx), markdown (.md), and text (.txt) files, using single or multi-schema mode. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 67.0 #### Parameters * `threshold` (query, number (double)) Minimum matching score (0-1) required for a schema to be returned in the response. If unspecified, the default value is `0.80`. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `IdpSchemaDetectionInputRepresentation`. _Example: Single schema detection request_ ``` { "schemaConfigurations": [ "Invoice_Schema_v1", "Receipt_Schema_v2" ], "mlModel": "llmgateway__VertexAIGemini25Flash001", "files": [ { "data": "", "mimeType": "application/pdf" } ], "mode": "Single" } ``` _Example: Multi schema detection request_ ``` { "schemaConfigurations": [ "Bank_Statement_Schema_v1", "Pay_Stub_Schema_v2", "Tax_Form_W2_Schema_v1" ], "mlModel": "llmgateway__VertexAIGemini25Flash001", "files": [ { "data": "", "mimeType": "application/pdf" } ], "mode": "Multi" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `IdpSchemaDetectionRepresentation`. _Example: Single schema detection response_ ``` { "data": [ { "schemaConfiguration": "Invoice_Schema_v1", "matchingScore": 0.95, "totalFieldsInSchema": 25, "matchingFieldsInSchema": 24 } ] } ``` _Example: Multi schema detection response_ ``` { "data": [ { "schemaConfiguration": "Bank_Statement_Schema_v1", "subdocuments": [ { "startPage": 1, "endPage": 5, "matchingScore": 0.93 } ] }, { "schemaConfiguration": "Pay_Stub_Schema_v2", "subdocuments": [ { "startPage": 6, "endPage": 7, "matchingScore": 0.89 } ] }, { "schemaConfiguration": "Tax_Form_W2_Schema_v1", "subdocuments": [ { "startPage": 8, "endPage": 12, "matchingScore": 0.96 } ] } ] } ``` ### POST Extract Document AI configuration data `POST /ssot/document-processing/actions/extract-data` Tags: Document AI. Extract structured data from PDF, image, Microsoft Word (.docx), PowerPoint (.pptx), Excel (.xlsx), markdown (.md), and text (.txt) files. You can specify a page range for extraction and assign confidence scores for each extracted field. For Excel files, specify the target sheet name in the request. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 63.0 #### Parameters * `endPage` (query, integer) Ending page number for data extraction. **Available Version:** 66.0 * `extractDataWithConfidenceScore` (query, boolean) Indicates whether to assign a confidence score to each field in the extracted data (`true`) or not (`false`). **Available Version:** 64.0 * `startPage` (query, integer) Starting page number for data extraction. **Available Version:** 66.0 #### Request body (required) Media type: `application/json`. Schema: `IdpExtractDataInputRepresentation`. _Example: Base64 file source request_ ``` { "idpConfigurationIdOrName": "example_config_ver1", "files": [ { "mimeType": "image/png", "data": "base64" } ] } ``` _Example: Base64 file source and a schema request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "mimeType": "image/png", "data": "base64" } ], "schemaConfig": "{}" } ``` _Example: Content document file source request_ ``` { "idpConfigurationIdOrName": "example_config_ver1", "files": [ { "fileId": "068xxxxxxxxxxxxxxx" } ] } ``` _Example: Content document file source and a schema request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "fileId": "068xxxxxxxxxxxxxxx" } ], "schemaConfig": "{}" } ``` _Example: Microsoft Office request_ ``` { "schemaConfig": "{}", "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "data": "<>", "additionalParams": { "sheetName": "Default" } } ] } ``` _Example: SF Drive file source request_ ``` { "idpConfigurationIdOrName": "example_config_ver1", "files": [ { "fileId": "sfdrive://$dc_file_upload$/path-to-file" } ] } ``` _Example: SF Drive file source and a schema request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "fileId": "sfdrive://$dc_file_upload$/path-to-file" } ], "schemaConfig": "{}" } ``` _Example: Schema config request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "fileId": "file-abc123456789" } ], "schemaConfig": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "AmazonInvoice", "description": "A schema representing a standard Amazon retail invoice including tax details and line items.", "type": "object", "required": [ "invoice_number", "order_id", "order_date", "seller_details", "billing_address", "items", "totals" ], "properties": { "invoice_number": { "type": "string", "description": "The unique legal identifier for the tax invoice." }, "order_id": { "type": "string", "pattern": "^\\d{3}-\\d{7}-\\d{7}$", "description": "The standard Amazon Order ID format (for example, 123-1234567-1234567)." }, "order_date": { "type": "string", "format": "date", "description": "The date the order was placed." }, "invoice_date": { "type": "string", "format": "date", "description": "The date the invoice was generated." }, "items": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "description": { "type": "string" }, "unit_price": { "type": "number", "minimum": 0 }, "quantity": { "type": "integer", "minimum": 1 }, "tax_rate": { "type": "number", "description": "Percentage of tax applied (for example, 18.0)." }, "tax_type": { "type": "string", "enum": [ "VAT", "GST", "Sales Tax" ] }, "total_price": { "type": "number" } }, "required": [ "description", "unit_price", "quantity", "total_price" ] } } } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `IdpExtractedDataRepresentation`. _Example: Example_ ``` { "data": [ { "data": "{\"Date of Test\": {\"type\": \"string\", \"value\": \"2025-03-13\", \"confidence_score\": 1.0}, \"Patient Age\": {\"type\": \"integer\", \"value\": 45, \"confidence_score\": 1.0}, \"Patient Gender\": {\"type\": \"string\", \"value\": \"Male\", \"confidence_score\": 1.0}, \"Patient ID\": {\"type\": \"string\", \"value\": \"JD123456\", \"confidence_score\": 1.0}, \"Patient Name\": {\"type\": \"string\", \"value\": \"John Doe\", \"confidence_score\": 1.0}, \"Referred By\": {\"type\": \"string\", \"value\": \"Dr. Smith\", \"confidence_score\": 1.0}, \"Test Results\": {\"type\": \"array\", \"value\": [{\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"70-99 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"126 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"Fasting Blood Sugar\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"<140 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"180 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"Postprandial Blood Sugar\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"<5.7%\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"7.5%\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"HbA1c\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"<200 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"210 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"Total Cholesterol\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"<100 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"130 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"LDL Cholesterol\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \">40 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"35 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"HDL Cholesterol\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"<150 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"180 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"Triglycerides\", \"confidence_score\": 1.0}}}, {\"type\": \"object\", \"value\": {\"Reference Range\": {\"type\": \"string\", \"value\": \"0.7-1.3 mg/dL\", \"confidence_score\": 1.0}, \"Result\": {\"type\": \"string\", \"value\": \"1.2 mg/dL\", \"confidence_score\": 1.0}, \"Test Name\": {\"type\": \"string\", \"value\": \"Creatinine\", \"confidence_score\": 1.0}}}]}}", "error": null } ] } ``` ### POST Generate Document AI schema `POST /ssot/document-processing/actions/generate-schema` Tags: Document AI. Generate a schema from a source of unstructured data. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 63.0 #### Request body (required) Media type: `application/json`. Schema: `IdpGenerateSchemaInputRepresentation`. _Example: Base64 file source request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "mimeType": "image/png", "data": "base64" } ] } ``` _Example: Content document file source request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "fileId": "068xxxxxxxxxxxxxxx" } ] } ``` _Example: SF Drive file source request_ ``` { "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "files": [ { "fileId": "sfdrive://$dc_file_upload$/path-to-file" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `IdpGeneratedSchemaRepresentation`. _Example: Example_ ``` { "error": null, "schema": "{\"schema\":{\"type\":\"object\",\"properties\":{\"invoiceNumber\":{\"type\":\"string\"},\"date\":{\"type\":\"string\",\"format\":\"date\"},\"amount\":{\"type\":\"number\"},\"vendor\":{\"type\":\"string\"}}}}" } ``` ### GET Get Document AI configurations `GET /ssot/document-processing/configurations` Tags: Document AI. Get all Document AI configurations. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 63.0 #### Parameters * `activationStatus` (query, string) Filter by activation status, either `Activated` or `Deactivated`. **Available Version:** 63.0 * `limit` (query, integer) Maximum number of records to return. **Available Version:** 63.0 * `offset` (query, integer) Number of records to skip. **Available Version:** 63.0 * `orderBy` (query, string) Return record sorted by a given field. Sort order is DESC by default. (for example, "Label DESC"). **Available Version:** 63.0 * `search` (query, string) Return only records that contain a specific search term. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `IdpConfigurationsCollectionRepresentation`. _Example: Example_ ``` { "id": "1OfVF00000003XN0AY", "name": "Vendor_Invoice", "label": "Vendor Invoice", "version": "1", "status": "Synced", "activationStatus": "Activated", "runtimeStatus": "Ready", "mlModel": "VertexAIGemini25Flash", "url": "/services/data/v65.0/ssot/document-processing/configurations?activationStatus=Activated", "dataspace": { "id": "0vhVF000000BUXRYA4", "name": "default", "label": "default" }, "fileConfig": { "fileTypes": [ "application/pdf", "image/png", "image/jpg", "image/jpeg" ] }, "extractedDloConfig": { "test DLO Doc AI": { "name": "test_DLO_Doc_AI", "label": "test DLO Doc AI", "category": null, "eventDateFieldName": null, "fields": { "Account name": { "name": "Account_name", "label": "Account name", "dataType": null }, "Seller Address": { "name": "Seller_Address", "label": "Seller Address", "dataType": null }, "Customer Address": { "name": "Customer_Address", "label": "Customer Address", "dataType": null }, "Item name/description": { "name": "Item_namedescription", "label": "Item name/description", "dataType": null }, "Item quantity": { "name": "Item_quantity", "label": "Item quantity", "dataType": null }, "Unit price": { "name": "Unit_price", "label": "Unit price", "dataType": null }, "Item total": { "name": "Item_total", "label": "Item total", "dataType": null }, "Invoice total": { "name": "Invoice_total", "label": "Invoice total", "dataType": null } } } }, "extractedDlos": [ { "dlo": { "id": "1dlVF000001IHkzYAG", "name": "test_DLO_Doc_AI__dll", "label": "test DLO Doc AI" }, "fields": [], "schemaName": null } ], "sourceDmo": { "id": "0gjVF000002ZCOaYAO", "name": "ssotContentDocumentVersiondlm", "label": "Content Document Version", "createdBy": { "id": "005VF000003dqZhYAI", "name": "Automated Process" }, "createdDate": "2026-05-21T18:35:54.000Z", "lastModifiedBy": { "id": "005VF000003dqZhYAI", "name": "Automated Process" }, "lastModifiedDate": "2026-05-21T20:02:41.000Z" }, "filterByDmo": { "id": "0gjVF000002ZCJwYAO", "name": "ssotAccountdlm", "label": "Account", "createdBy": { "id": "005VF000003dqZhYAI", "name": "Automated Process" }, "createdDate": "2026-05-21T18:35:54.000Z", "lastModifiedBy": { "id": "005VF000003dqZhYAI", "name": "Automated Process" }, "lastModifiedDate": "2026-05-21T18:59:18.000Z" }, "schemaConfig": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "test DLO Doc AI", "type": "object", "properties": { "Account name": { "type": "string", "description": "Name of the account" }, "Seller Address": { "type": "string", "description": "Address of the vendor" }, "Customer Address": { "type": "string", "description": "address of the customer" }, "Item name/description": { "type": "string", "description": "Item name & description" }, "Item quantity": { "type": "string", "description": "# units ordered" }, "Unit price": { "type": "string", "description": "per unit price" }, "Item total": { "type": "string", "description": "total price of each line item" }, "Invoice total": { "type": "string", "description": "Total invoiced amount" } }, "required": [ "Account name", "Seller Address", "Customer Address", "Item name/description", "Item quantity", "Unit price", "Item total", "Invoice total" ] }, "configMetadata": {}, "description": null, "externalServiceRegistrationId": null, "namespace": null, "createdBy": { "id": "005VF000003dqHxYAI" }, "createdDate": "2026-05-25T03:57:02.000Z", "lastModifiedBy": { "id": "005VF000003dqZhYAI" }, "lastModifiedDate": "2026-05-26T23:06:28.000Z", "lastRunOn": "2026-05-25T04:15:16.000Z" } ``` ### POST Create Document AI configuration `POST /ssot/document-processing/configurations` Tags: Document AI. Create a new Document AI configuration. **Available Version:** 63.0 #### Request body (required) Media type: `application/json`. Schema: `IdpConfigurationInputRepresentation`. _Example: Example_ ``` { "label": "My Document AI Config", "name": "My_Document AI_Config", "description": "Description of the config", "sourceDmoDeveloperName": "Receipts_DMO__dlm", "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "activationStatus": "ACTIVATED", "fileConfig": { "fileTypes": [ "image/jpg", "image/png" ] }, "schemaConfig": "{ ... ommitted for brevity }", "extractedDloConfig": { "sales_invoices": { "name": "SalesInvoices__dll", "label": "Sales Invoices", "category": "Engagement", "eventDateFieldName": "InvoiceDate__c", "fields": { "invoice_date": { "name": "InvoiceDate__c", "label": "Invoice Date", "dataType": "Date" }, "product": { "name": "ProductDescription__c", "label": "Product Description", "dataType": "Text" } } } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `IdpConfigurationDetailsRepresentation`. _Example: Example_ ``` { "id": "1Ofxx0000004C92CAE", "name": "My_Document AI_Config", "label": "My Document AI Config", "createdBy": { "id": "user_id", "name": "user" }, "createdDate": "2024-11-12T23:13:54.000Z", "lastModifiedBy": { "id": "user_id", "name": "user" }, "lastModifiedDate": "2024-11-12T23:13:54.000Z", "url": "/services/data/v63.0/ssot/document-processing/1Ofxx0000004C92CAE", "dataspace": { "id": "9gTxx0000004C92CAE", "label": "default" }, "description": "Some description", "sourceDmo": { "id": "0gjxx0000004C92CAE", "label": "Receipts DMO" }, "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", "version": 3, "activationStatus": "ACTIVATED", "status": "SYNCED", "runtimeStatus": "SUCCESS", "extractedDlos": [ { "schemaName": null, "dlo": { "id": "0gOxx0000004C92CAE", "name": "SalesQuote", "label": "SalesQuote" }, "Fields": [ { "schemaName": "postingDate", "dloField": { "id": "0gQxx0000004C92CAE", "name": "PostingName", "label": "Posting Date" } } ] }, { "schemaName": "salesQuoteItems", "dlo": { "id": "0gOxx0000004C92CAE", "name": "SalesQuote_Items", "label": "SalesQuote Items" }, "fields": [ { "schemaName": "product", "dloField": { "id": "0gQxx0000004C92CAF", "name": "ProductDescription", "label": "Product Description" } } ] } ], "fileConfig": { "fileTypes": [ "image/jpg", "image/png" ] }, "schemaConfig": "{ ... ommitted for brevity }" } ``` ### GET Get Document AI configuration `GET /ssot/document-processing/configurations/{idOrApiName}` Tags: Document AI. Get the details of a Document AI configuration. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 63.0 #### Parameters * `idOrApiName` (path, string, required) ID or API name of the Document AI configuration. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `IdpConfigurationDetailsRepresentation`. _Example: Example_ ``` { "id": "1Ofxx0000004C92CAE", "label": "Document AI Config 1", "name": "Document AI_Config_1", "description": "Configuration for processing documents", "url": "/services/data/v63.0/ssot/document-processing/1Ofxx0000004C92CAE" } ``` ### DELETE Delete Document AI configuration `DELETE /ssot/document-processing/configurations/{idOrApiName}` Tags: Document AI. Delete a Document AI configuration. **Available Version:** 63.0 #### Parameters * `idOrApiName` (path, string, required) ID or API name of the Document AI configuration. **Available Version:** 63.0 #### Responses * **200** Configuration successfully deleted. ### PATCH Update Document AI configuration `PATCH /ssot/document-processing/configurations/{idOrApiName}` Tags: Document AI. Update an existing Document AI configuration. **Available Version:** 63.0 #### Parameters * `idOrApiName` (path, string, required) ID or API name of the Document AI configuration. **Available Version:** 63.0 #### Request body (required) Media type: `application/json`. Schema: `IdpConfigurationPatchInputRepresentation`. _Example: Example_ ``` { "label": "My Document AI Config (updated)", "description": "Some description (updated)", "activationStatus": "ACTIVATED" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `IdpConfigurationDetailsRepresentation`. _Example Example: same as POST /ssot/document-processing/configurations 200 response._ ### POST Run Document AI process `POST /ssot/document-processing/configurations/{idOrApiName}/actions/run` Tags: Document AI. Run the Document AI configuration to process documents. **Available Version:** 63.0 #### Parameters * `idOrApiName` (path, string, required) ID or API name of the configuration. **Available Version:** 63.0 #### Responses * **200** A run is triggered. ### GET Get Document AI global configuration `GET /ssot/document-processing/global-config` Tags: Document AI. Get the global configurations for Document AI. > **Note:** Available in Data Cloud One. You can call the endpoint directly from a companion org. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `IdpGlobalConfigRepresentation`. _Example: Example_ ``` { "supportedContentTypes": [ { "isDefault": false, "label": "PDF", "maxFileSizeInMB": 20, "type": "application/pdf" }, { "isDefault": true, "label": "PNG", "maxFileSizeInMB": 20, "type": "image/png" }, { "isDefault": false, "label": "JPG", "maxFileSizeInMB": 20, "type": "image/jpg" }, { "isDefault": false, "label": "JPEG", "maxFileSizeInMB": 20, "type": "image/jpeg" } ], "supportedModels": [ { "id": "llmgateway__OpenAIGPT4Omni_08_06", "isDefault": true, "label": "GPT4Omni_08_06", "provider": "OpenAI", "status": "ENABLED" } ], "version": "1.0" } ``` ### GET Get identity resolution rulesets `GET /ssot/identity-resolutions` Tags: Identity Resolutions. Get identity resolution rulesets in Data 360. **Available Version:** 57.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpIdentityResolutionsOutputRepresentation`. _Example: Example_ ``` { "identityResolutions": [ { "id": "1irfj000000IWhWAAW", "label": "Individual Match", "configurationType": "individual", "dataSpaceName": "default", "objectApiName": "Individual", "doesRunAutomatically": true, "rulesetStatus": "PUBLISHED", "lastJobStatus": "SUCCESS", "lastJobCompleted": "2025-08-20T22:18:44.000Z", "consolidationRate": 0, "sourceProfiles": 0, "matchedSourceProfiles": 0, "knownUnifiedProfiles": 0, "anonymousUnifiedProfiles": 0, "totalUnifiedProfiles": 0, "secondaryDmo": "ssot__Individual__dlm", "matchRules": [ { "label": "Fuzzy Name and Normalized Email", "criteria": [ { "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "caseSensitiveMatch": false, "shouldMatchOnBlank": false }, { "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "caseSensitiveMatch": false, "shouldMatchOnBlank": false }, { "entityName": "ssot__ContactPointEmail__dlm", "fieldName": "ssot__EmailAddress__c", "matchMethodType": "exactnormalized", "caseSensitiveMatch": false, "shouldMatchOnBlank": false } ] } ], "reconciliationRules": [ { "entityName": "ssot__Individual__dlm", "linkDmoName": "IndividualIdentityLink__dlm", "unifiedDmoName": "UnifiedIndividual__dlm", "ruleType": "lastupdated", "shouldIgnoreEmptyValue": true, "sources": [], "fields": [ { "fieldName": "ssot__Id__c", "ruleType": "sourcesequence", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Contact_Home__dll" }, { "name": "Lead_Home__dll" } ] } ] }, { "entityName": "ssot__ContactPointEmail__dlm", "linkDmoName": "ContactPointEmailIdentityLink__dlm", "unifiedDmoName": "UnifiedContactPointEmail__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "fields": [] } ] }, { "id": "2irfj000000IWhWAAX", "label": "Account Match", "configurationType": "account", "dataSpaceName": "default", "objectApiName": "Account", "doesRunAutomatically": true, "rulesetStatus": "PUBLISHED", "lastJobStatus": "SUCCESS", "lastJobCompleted": "2025-08-20T22:20:15.000Z", "consolidationRate": 0, "sourceProfiles": 0, "matchedSourceProfiles": 0, "knownUnifiedProfiles": 0, "anonymousUnifiedProfiles": 0, "totalUnifiedProfiles": 0, "secondaryDmo": "ssot__Account__dlm", "matchRules": [ { "label": "Exact Account Name and Address", "criteria": [ { "entityName": "ssot__Account__dlm", "fieldName": "ssot__Name__c", "matchMethodType": "exact", "caseSensitiveMatch": false, "shouldMatchOnBlank": false }, { "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__AddressLine1__c", "matchMethodType": "exact", "caseSensitiveMatch": false, "shouldMatchOnBlank": false }, { "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CityId__c", "matchMethodType": "exact", "caseSensitiveMatch": false, "shouldMatchOnBlank": false } ] } ], "reconciliationRules": [ { "entityName": "ssot__Account__dlm", "linkDmoName": "AccountIdentityLink__dlm", "unifiedDmoName": "UnifiedAccount__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "fields": [] } ] } ] } ``` ### POST Create identity resolution ruleset `POST /ssot/identity-resolutions` Tags: Identity Resolutions. Create an identity resolution ruleset in Data 360. **Available Version:** 57.0 #### Request body (required) Media type: `application/json`. Schema: `CdpIdentityResolutionConfigInput`. _Example: Example_ ``` { "label": "some label", "description": "description", "configurationType": "Individual", "rulesetId": "sufx", "doesRunAutomatically": false, "matchRules": [ { "label": "Normalized Email", "criteria": [ { "entityName": "orgnamespace__*ContactPointEmail*MyDataSpace__dlm", "fieldName": "orgnamespace__*EmailAddress*__c", "matchMethodType": "EXACT_NORMALIZED", "shouldMatchOnBlank": false } ] }, { "label": "Last Name and PartyId", "criteria": [ { "entityName": "orgnamespace__*Individual*MyDataSpace__dlm", "fieldName": "orgnamespace__*LastName*__c", "matchMethodType": "EXACT", "shouldMatchOnBlank": false, "partyIdentificationInfo": { "partyName": "SomeID" } } ] } ], "reconciliationRules": [ { "entityName": "orgnamespace__*Individual*MyDataSpace__dlm", "ruleType": "LAST_UPDATED", "shouldIgnoreEmptyValue": true, "fields": [ { "fieldName": "orgnamespace__*Id*__c", "ruleType": "SOURCE_SEQUENCE", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Patients__dll" }, { "name": "SomeAnother__dll" } ] } ] }, { "entityName": "orgnamespace__*ContactPointEmail*MyDataSpace__dlm" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpIdentityResolutionOutputRepresentation`. _Example: Example_ ``` { "anonymousUnifiedProfiles": 0, "configurationType": "Individual", "consolidationRate": 0, "dataSpaceName": "MyDataSpace", "description": "description", "doesRunAutomatically": false, "id": "0IRxx0000000yyyAAA", "knownUnifiedProfiles": 0, "label": "some label", "lastJobCompleted": null, "lastJobStatus": "Never Run", "matchRules": [ { "criteria": [ { "caseSensitiveMatch": false, "entityName": "orgnamespace__*ContactPointEmail*MyDataSpace__dlm", "fieldName": "orgnamespace__*EmailAddress*__c", "matchMethodType": "EXACT_NORMALIZED", "partyIdentificationInfo": null, "shouldMatchOnBlank": false } ], "label": "Normalized Email" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "orgnamespace__*Individual*MyDataSpace__dlm", "fieldName": "orgnamespace__*LastName*__c", "matchMethodType": "EXACT", "partyIdentificationInfo": { "partyName": "SomeID", "partyType": null }, "shouldMatchOnBlank": false } ], "label": "Last Name and PartyId" } ], "matchedSourceProfiles": 0, "objectApiName": "Individual", "reconciliationRules": [ { "entityName": "orgnamespace__*Individual*MyDataSpace__dlm", "fields": [ { "fieldName": "orgnamespace__*Id*__c", "ruleType": "SOURCE_SEQUENCE", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Patients__dll" }, { "name": "SomeAnother__dll" } ] } ], "linkDmoName": null, "ruleType": "LAST_UPDATED", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": null }, { "entityName": "orgnamespace__*ContactPointEmail*MyDataSpace__dlm", "fields": [], "linkDmoName": null, "ruleType": "LAST_UPDATED", "shouldIgnoreEmptyValue": false, "sources": [], "unifiedDmoName": null } ], "rulesetId": "sufx", "rulesetStatus": "NEW", "sourceProfiles": 0, "totalUnifiedProfiles": 0 } ``` ### GET Get identity resolution ruleset `GET /ssot/identity-resolutions/{identityResolution}` Tags: Identity Resolutions. Get an identity resolution ruleset in Data 360. **Available Version:** 57.0 #### Parameters * `identityResolution` (path, string, required) Developer name or ID of the ruleset. **Available Version:** 57.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpIdentityResolutionOutputRepresentation`. _Example: Example_ ``` { "anonymousUnifiedProfiles": 0, "configurationType": "individual", "consolidationRate": 0, "dataSpaceName": "default", "doesRunAutomatically": true, "id": "1irfj000000IWhWAAW", "knownUnifiedProfiles": 0, "label": "Individual Match", "lastJobCompleted": "2025-08-20T22:18:44.000Z", "lastJobStatus": "SUCCESS", "matchRules": [ { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointEmail__dlm", "fieldName": "ssot__EmailAddress__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Email" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointPhone__dlm", "fieldName": "ssot__FormattedE164PhoneNumber__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Phone" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__AddressLine1__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CityId__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CountryId__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Address" } ], "matchedSourceProfiles": 0, "objectApiName": "Individual", "reconciliationRules": [ { "entityName": "ssot__Individual__dlm", "fields": [ { "fieldName": "ssot__Id__c", "ruleType": "sourcesequence", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Contact_Home__dll" }, { "name": "Lead_Home__dll" } ] } ], "linkDmoName": "IndividualIdentityLink__dlm", "ruleType": "lastupdated", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedIndividual__dlm" }, { "entityName": "ssot__ContactPointEmail__dlm", "fields": [], "linkDmoName": "ContactPointEmailIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointEmail__dlm" }, { "entityName": "ssot__ContactPointPhone__dlm", "fields": [], "linkDmoName": "ContactPointPhoneIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointPhone__dlm" }, { "entityName": "ssot__ContactPointAddress__dlm", "fields": [], "linkDmoName": "ContactPointAddressIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointAddress__dlm" } ], "rulesetStatus": "PUBLISHED", "secondaryDmo": "ssot__Individual__dlm", "sourceProfiles": 0, "totalUnifiedProfiles": 0 } ``` * **404** Identity resolution not found: _identityResolution_. ### DELETE Delete identity resolution ruleset `DELETE /ssot/identity-resolutions/{identityResolution}` Tags: Identity Resolutions. Delete an identity resolution ruleset in Data 360. **Available Version:** 57.0 #### Parameters * `identityResolution` (path, string, required) Developer name or ID of the ruleset. **Available Version:** 57.0 #### Responses * **204** Success * **404** Identity resolution not found: _identityResolution_. ### PATCH Update identity resolution ruleset `PATCH /ssot/identity-resolutions/{identityResolution}` Tags: Identity Resolutions. Update an identity resolution ruleset in Data 360. **Available Version:** 57.0 #### Parameters * `identityResolution` (path, string, required) Developer name or ID of the ruleset. **Available Version:** 57.0 #### Request body (required) Media type: `application/json`. Schema: `CdpIdentityResolutionConfigPatchInput`. _Example: Example_ ``` { "doesRunAutomatically": false, "label": "Individual Match Test", "matchRules": [ { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointEmail__dlm", "fieldName": "ssot__EmailAddress__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Email" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointPhone__dlm", "fieldName": "ssot__FormattedE164PhoneNumber__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Phone" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__AddressLine1__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CityId__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CountryId__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Address" } ], "reconciliationRules": [ { "entityName": "ssot__Individual__dlm", "fields": [ { "fieldName": "ssot__Id__c", "ruleType": "sourcesequence", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Contact_Home__dll" }, { "name": "Lead_Home__dll" } ] } ], "ruleType": "lastupdated", "shouldIgnoreEmptyValue": true, "sources": [] }, { "entityName": "ssot__ContactPointEmail__dlm", "fields": [], "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [] }, { "entityName": "ssot__ContactPointPhone__dlm", "fields": [], "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [] }, { "entityName": "ssot__ContactPointAddress__dlm", "fields": [], "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [] } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpIdentityResolutionOutputRepresentation`. _Example: Example_ ``` { "anonymousUnifiedProfiles": 0, "configurationType": "individual", "consolidationRate": 0, "dataSpaceName": "default", "doesRunAutomatically": false, "id": "1irfj000000IWhWAAW", "knownUnifiedProfiles": 0, "label": "Individual Match Test", "lastJobCompleted": "2025-08-20T22:18:44.000Z", "lastJobStatus": "SUCCESS", "matchRules": [ { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointEmail__dlm", "fieldName": "ssot__EmailAddress__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Email" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointPhone__dlm", "fieldName": "ssot__FormattedE164PhoneNumber__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Phone" }, { "criteria": [ { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__FirstName__c", "matchMethodType": "fuzzy", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__Individual__dlm", "fieldName": "ssot__LastName__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__AddressLine1__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CityId__c", "matchMethodType": "exact", "shouldMatchOnBlank": false }, { "caseSensitiveMatch": false, "entityName": "ssot__ContactPointAddress__dlm", "fieldName": "ssot__CountryId__c", "matchMethodType": "exactnormalized", "shouldMatchOnBlank": false } ], "label": "Fuzzy Name and Normalized Address" } ], "matchedSourceProfiles": 0, "objectApiName": "Individual", "reconciliationRules": [ { "entityName": "ssot__Individual__dlm", "fields": [ { "fieldName": "ssot__Id__c", "ruleType": "sourcesequence", "shouldIgnoreEmptyValue": true, "sources": [ { "name": "Contact_Home__dll" }, { "name": "Lead_Home__dll" } ] } ], "linkDmoName": "IndividualIdentityLink__dlm", "ruleType": "lastupdated", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedIndividual__dlm" }, { "entityName": "ssot__ContactPointEmail__dlm", "fields": [], "linkDmoName": "ContactPointEmailIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointEmail__dlm" }, { "entityName": "ssot__ContactPointPhone__dlm", "fields": [], "linkDmoName": "ContactPointPhoneIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointPhone__dlm" }, { "entityName": "ssot__ContactPointAddress__dlm", "fields": [], "linkDmoName": "ContactPointAddressIdentityLink__dlm", "ruleType": "mostfrequent", "shouldIgnoreEmptyValue": true, "sources": [], "unifiedDmoName": "UnifiedContactPointAddress__dlm" } ], "rulesetStatus": "PUBLISHING", "secondaryDmo": "ssot__Individual__dlm", "sourceProfiles": 0, "totalUnifiedProfiles": 0 } ``` * **404** Invalid input or item not found. For example: * Include input for the '_field name_' field and try again. * Identity resolution not found: _identityResolution_. ### POST Run identity resolution ruleset now `POST /ssot/identity-resolutions/{identityResolution}/actions/run-now` Tags: Identity Resolutions. Run an identity resolution ruleset job on demand in Data 360. **Available Version:** 57.0 #### Parameters * `identityResolution` (path, string, required) Developer name or ID of the ruleset. **Available Version:** 57.0 #### Request body (required) Media type: `application/json`. Schema: `CdpIdentityResolutionRunNowInput`. _Example: Example_ ``` { "callingApp": "Flow", "callingAppInfo": "10" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpIdentityResolutionRunNowOutputRepresentation`. ### GET Get calculated insight object `GET /ssot/insight/calculated-insights/{ciName}` Tags: Insights. Query a Calculated Insight object in Data 360. **Available Version:** 52.0 #### Parameters * `ciName` (path, string, required) Name of the calculated insight object. **Available Version:** 52.0 * `batchSize` (query, integer) Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `4999`. **Available Version:** 52.0 * `dimensions` (query, string) Comma-separated list of up to 10 dimensions, such as `GenderId__c`, to project. If unspecified, this parameter includes all of the available dimensions. **Available Version:** 52.0 * `filters` (query, string) Filter the result set to a more narrow scope or specific type, such as `[GenderId__c=Male,\u200BFirstName__c=Angel]`. **Available Version:** 52.0 * `measures` (query, string) Comma-separated list of up to five measures, such as `TotalSales__c,` to project. If unspecified, this parameter includes all of the available measures. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 52.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 52.0 * `timeGranularity` (query, string) Time range for the measures. Values are `HOUR`, `DAY`, `MONTH`, `QUARTER`, or `YEAR`. If unspecified, no time range is applied. **Available Version:** 54.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ {} ], "done": false, "endTime": "", "metadata": { "//": {} }, "queryId": "", "rowCount": 0, "startTime": "" } ``` ### GET Get insight metadata `GET /ssot/insight/metadata` Tags: Insights, Metadata. Get Insight metadata, including Calculated Insight objects, their dimensions, and their measures in Data 360. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataOutputRepresentation`. _Example: Example_ ``` { "metadata": [ { "name": "DailyPersonalizationRequests__cio", "displayName": "Daily Personalization Requests", "dimensions": [ { "name": "RequestDate__c", "displayName": "RequestDate", "type": "DATE", "businessType": "DATE" }, { "name": "PersonalizationPointId__c", "displayName": "PersonalizationPointId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationPointName__c", "displayName": "PersonalizationPointName", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationType__c", "displayName": "PersonalizationType", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationDecisionId__c", "displayName": "PersonalizationDecisionId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationDecisionName__c", "displayName": "PersonalizationDecisionName", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizerId__c", "displayName": "PersonalizerId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizerName__c", "displayName": "PersonalizerName", "type": "STRING", "businessType": "TEXT" } ], "measures": [ { "name": "NumRequests__c", "displayName": "NumRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumPersonalizationRequests__c", "displayName": "NumPersonalizationRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "TotalResponseTimeMilliseconds__c", "displayName": "TotalResponseTimeMilliseconds", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" }, { "name": "NumContentItems__c", "displayName": "NumContentItems", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" }, { "name": "TotalContentLength__c", "displayName": "TotalContentLength", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" } ], "relationships": [ { "fromEntity": "ssot__PersonalizationLog__dlm", "toEntity": "DailyPersonalizationRequests__cio" }, { "fromEntity": "ssot__PersonalizationPoint__dlm", "toEntity": "DailyPersonalizationRequests__cio" }, { "fromEntity": "ssot__PersonalizationDecision__dlm", "toEntity": "DailyPersonalizationRequests__cio" }, { "fromEntity": "ssot__Personalizer__dlm", "toEntity": "DailyPersonalizationRequests__cio" } ], "partitionBy": "PersonalizationPointId__c", "latestProcessTime": "1970-01-01T00:00:00.00000Z", "latestSuccessfulProcessTime": "1970-01-01T00:00:00.00000Z" }, { "name": "DailyPersonalizationRequests__cio_DAY", "displayName": "Daily Personalization Requests_DAY", "dimensions": [ { "name": "RequestDate__c", "displayName": "RequestDate", "type": "DATE", "businessType": "DATE" }, { "name": "PersonalizationPointId__c", "displayName": "PersonalizationPointId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationPointName__c", "displayName": "PersonalizationPointName", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationType__c", "displayName": "PersonalizationType", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationDecisionId__c", "displayName": "PersonalizationDecisionId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizationDecisionName__c", "displayName": "PersonalizationDecisionName", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizerId__c", "displayName": "PersonalizerId", "type": "STRING", "businessType": "TEXT" }, { "name": "PersonalizerName__c", "displayName": "PersonalizerName", "type": "STRING", "businessType": "TEXT" } ], "measures": [ { "name": "NumRequests__c", "displayName": "NumRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumPersonalizationRequests__c", "displayName": "NumPersonalizationRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "TotalResponseTimeMilliseconds__c", "displayName": "TotalResponseTimeMilliseconds", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" }, { "name": "NumContentItems__c", "displayName": "NumContentItems", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" }, { "name": "TotalContentLength__c", "displayName": "TotalContentLength", "type": "NUMBER", "rollupable": true, "businessType": "NUMBER" } ], "relationships": [ { "fromEntity": "ssot__PersonalizationLog__dlm", "toEntity": "DailyPersonalizationRequests__cio_DAY" }, { "fromEntity": "ssot__PersonalizationPoint__dlm", "toEntity": "DailyPersonalizationRequests__cio_DAY" }, { "fromEntity": "ssot__PersonalizationDecision__dlm", "toEntity": "DailyPersonalizationRequests__cio_DAY" }, { "fromEntity": "ssot__Personalizer__dlm", "toEntity": "DailyPersonalizationRequests__cio_DAY" } ], "partitionBy": "PersonalizationPointId__c" } ] } ``` ### GET Get calculated insight object metadata `GET /ssot/insight/metadata/{ciName}` Tags: Insights, Metadata. Get metadata for a Calculated Insight object in Data 360. Metadata includes dimensions and measures. **Available Version:** 52.0 #### Parameters * `ciName` (path, string, required) Name of the calculated insight object. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataOutputRepresentation`. _Example: Example_ ``` { "metadata": [ { "name": "DailyPersonalizationUniques__cio", "displayName": "Daily Personalization Uniques", "dimensions": [ { "name": "RequestDate__c", "displayName": "RequestDate", "type": "DATE", "businessType": "DATE" } ], "measures": [ { "name": "NumUniqueIndividuals__c", "displayName": "NumUniqueIndividuals", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumRequests__c", "displayName": "NumRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumPersonalizationRequests__c", "displayName": "NumPersonalizationRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumUniqueRecordTypes__c", "displayName": "NumUniqueRecordTypes", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumUniqueRecords__c", "displayName": "NumUniqueRecords", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" } ], "relationships": [ { "fromEntity": "ssot__PersonalizationLog__dlm", "toEntity": "DailyPersonalizationUniques__cio" } ], "partitionBy": "RequestDate__c", "latestProcessTime": "1970-01-01T00:00:00.00000Z", "latestSuccessfulProcessTime": "1970-01-01T00:00:00.00000Z" } ] } ``` * **404** The requested resource does not exist. ### GET Get knowledge spaces `GET /ssot/knowledge-space` Tags: Notebook AI. Get all knowledge spaces in the current data space. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AllKnowledgeSpaceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaces": [ { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "label": "My Knowledge Space", "developerName": "My_Knowledge_Space", "description": "Primary knowledge space", "dataSpace": "default" } ] } ``` ### POST Create knowledge space `POST /ssot/knowledge-space` Tags: Notebook AI. Create a knowledge space in the current data space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceInputRepresentation`. _Example: Example_ ``` { "label": "My Knowledge Space", "developerName": "My_Knowledge_Space", "description": "This is my personal space", "dataSpace": "default", "createDefaultLibrary": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "label": "My Knowledge Space", "developerName": "My_Knowledge_Space", "description": "This is my personal space", "dataSpace": "default" } ``` ### GET Get knowledge space `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` Tags: Notebook AI. Get a knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "knowledgeSpaceConfigId": "1T5xx0000004CguCAE", "knowledgeSpaceDefId": "1Tlxx0000004DY8CAM", "developerName": "My_Knowledge_Space", "label": "My Knowledge Space", "description": "This is my personal space", "dataSpace": "default" } ``` ### DELETE Delete knowledge space `DELETE /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` Tags: Notebook AI. Delete a knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 #### Responses * **200** Success ### PATCH Update knowledge space `PATCH /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}` Tags: Notebook AI. Update a knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceInputRepresentation`. _Example: Example_ ``` { "label": "Updated Knowledge Space", "description": "Updated description" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "label": "Updated Knowledge Space", "developerName": "My_Knowledge_Space", "description": "Updated description" } ``` ### GET Get knowledge space details `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/details` Tags: Notebook AI. Get detailed information about a specific knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004DEmCAM", "knowledgeSpaceConfigId": "1T5xx0000004CguCAE", "knowledgeSpaceDefId": "1Tlxx0000004DY8CAM", "developerName": "Knowledge_Space_001", "label": "Knowledge Space 001", "description": null, "dataSpace": "default", "libraries": [ { "knowledgeLibraryId": "1UDxx0000004DTIGA2", "knowledgeSpaceId": "1T8xx0000004DEmCAM", "developerName": "Knowledge_Space_001_Library", "label": "Main Library", "knowledgeCategory": "PERSONAL" } ] } ``` ### POST Provision knowledge space `POST /ssot/knowledge-space/provision` Tags: Notebook AI. Provision a knowledge space for the specified data spaces. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceProvisionInputRepresentation`. _Example: Example_ ``` { "dataSpaces": [ "default", "analytics" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceProvisionOutputRepresentation`. _Example: Example_ ``` { "success": true } ``` ### GET Get knowledge space configurations `GET /ssot/knowledge-space/config` Tags: Notebook AI. Get all knowledge space configuration details. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AllKnowledgeSpaceConfigOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceConfigs": [ { "knowledgeSpaceConfigId": "1T5xx0000004CguCAE", "developerName": "Default_Config", "label": "Default Configuration" } ] } ``` ### POST Create knowledge space configuration `POST /ssot/knowledge-space/config` Tags: Notebook AI. Create a knowledge space configuration. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceConfigInputRepresentation`. _Example: Example_ ``` { "developerName": "My_Config", "label": "My Configuration", "dataspace": "default" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceConfigOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceConfigId": "1T5xx0000004CguCAE", "developerName": "My_Config", "label": "My Configuration" } ``` ### GET Get knowledge space configuration `GET /ssot/knowledge-space/config/{knowledgeSpaceConfigApiNameOrId}` Tags: Notebook AI. Get the details of a specific knowledge space configuration record. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceConfigApiNameOrId` (path, string, required) API name or ID of the knowledge space configuration. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceConfigOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceConfigId": "1T5xx0000004CguCAE", "developerName": "My_Config", "label": "My Configuration", "dataspace": "default", "provisioningStatus": "ACTIVE" } ``` ### DELETE Delete knowledge space configuration `DELETE /ssot/knowledge-space/config/{knowledgeSpaceConfigApiNameOrId}` Tags: Notebook AI. Delete a knowledge space configuration. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceConfigApiNameOrId` (path, string, required) API name or ID of the knowledge space configuration. **Available Version:** 65.0 #### Responses * **200** Success ### GET Get knowledge libraries `GET /ssot/knowledge-space/library` Tags: Notebook AI. Get all knowledge libraries. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AllKnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceLibraries": [ { "knowledgeLibraryId": "1aQxx000000003FEAQ", "developerName": "My_Library", "label": "My Knowledge Library", "knowledgeCategory": "PERSONAL" } ] } ``` ### POST Create knowledge library `POST /ssot/knowledge-space/library` Tags: Notebook AI. Create a knowledge library in an existing knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceLibraryInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "developerName": "My_Library", "label": "My Knowledge Library", "description": "Library for technical documentation" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeLibraryId": "1aQxx00000000BJ", "developerName": "My_Library", "label": "My Knowledge Library", "knowledgeCategory": "PERSONAL", "sources": [] } ``` ### PATCH Update knowledge library `PATCH /ssot/knowledge-space/library/{id}` Tags: Notebook AI. Update a knowledge library. **Available Version:** 65.0 #### Parameters * `id` (path, string, required) ID of the knowledge library. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceLibraryInputRepresentation`. _Example: Example_ ``` { "label": "Updated Library Name", "description": "Updated description" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeLibraryId": "1aQxx00000000BJ", "label": "Updated Library Name", "description": "Updated description" } ``` ### GET Get knowledge library details `GET /ssot/knowledge-space/library/{libraryId}/details` Tags: Notebook AI. Get detailed information about a specific knowledge library. **Available Version:** 65.0 #### Parameters * `libraryId` (path, string, required) ID of the knowledge library. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeLibraryId": "1aQxx00000000BJ", "developerName": "My_Library", "label": "My Knowledge Library", "knowledgeSpaceId": "1T8xx0000004CYqCAM", "sources": [] } ``` ### POST Remove knowledge library `POST /ssot/knowledge-space/library/remove-library` Tags: Notebook AI. Remove a knowledge library from a knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceLibraryInputRepresentation`. _Example: Example_ ``` { "knowledgeLibraryId": "1aQxx00000000G9EAI", "knowledgeSpaceId": "1T8xx0000004CYqCAM" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeLibraryId": "1aQxx00000000G9EAI", "developerName": "Removed_Library", "label": "Removed Library" } ``` ### POST Search knowledge libraries `POST /ssot/knowledge-space/library/search` Tags: Notebook AI. Search for a knowledge library. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceLibraryInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "developerName": "Search_Term" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `AllKnowledgeSpaceLibraryOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceLibraries": [ { "knowledgeLibraryId": "1aQxx000000003FEAQ", "developerName": "Matching_Library", "label": "Matching Library" } ] } ``` ### POST Get presigned URLs `POST /ssot/knowledge-space/presigned-urls` Tags: Notebook AI. Get presigned URLs for uploading files to a knowledge library. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceUploadPresignedUrlInputRepresentation`. _Example: Example_ ``` { "libraryId": "1aQxx00000000BJ", "fileNames": [ "document1.pdf", "document2.pdf" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceUploadPresignedURLOutputRepresentation`. _Example: Example_ ``` { "presignedUrls": [ "https://s3.amazonaws.com/upload-url-1", "https://s3.amazonaws.com/upload-url-2" ] } ``` ### POST Index files `POST /ssot/knowledge-space/index-files` Tags: Notebook AI. Index uploaded files for a knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceIndexFilesInputRepresentation`. _Example: URL source_ ``` { "knowledgeArtifactId": "1aQxx00000000JNEAY", "knowledgeArtifactSource": "URL", "websiteUrl": "https://example.com/docs" } ``` _Example: File upload source_ ``` { "knowledgeArtifactId": "1aQxx00000000JNEAY", "knowledgeArtifactSource": "FILE_UPLOAD", "knowledgeSourceFilesList": [ { "fileName": "document.pdf", "filePath": "knowledge_space/collections/library/document.pdf", "fileType": "PDF" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceIndexFilesOutputRepresentation`. _Example: Example_ ``` { "knowledgeArtifactId": "1aQxx00000000JNEAY", "knowledgeArtifactSource": "FILE_UPLOAD", "knowledgeSourceId": "1aNxx00000000o1", "knowledgeSourceFilesList": [ { "fileRecordId": "1aIxx00000000RR", "fileName": "document.pdf", "filePath": "knowledge_space/collections/library/document.pdf", "fileStatus": "INDEXED" } ] } ``` ### POST Get file status `POST /ssot/knowledge-space/files/status` Tags: Notebook AI. Get the file status of a knowledge space for the specified file IDs. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceFileStatusInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "fileIds": [ "1Utxx0000004DJcCAM", "1Utxx0000004DJdCAM" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceFilesStatusOutputRepresentation`. _Example: Example_ ``` { "files": [ { "fileRecordId": "1Utxx0000004DJcCAM", "fileName": "document.pdf", "filePath": "knowledge_space/collections/library/document.pdf", "fileStatus": "INDEXED" } ] } ``` ### POST Remove files `POST /ssot/knowledge-space/remove-files` Tags: Notebook AI. Remove files from a knowledge library. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceIndexFilesInputRepresentation`. _Example: Example_ ``` { "knowledgeArtifactId": "1aQxx00000000JNEAY", "knowledgeArtifactSource": "FILE_UPLOAD", "knowledgeSourceFilesList": [ { "fileName": "old-document.pdf", "filePath": "knowledge_space/collections/library/old-document.pdf" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceIndexFilesOutputRepresentation`. _Example: Example_ ``` { "knowledgeArtifactId": "1aQxx00000000JNEAY", "knowledgeSourceFilesList": [] } ``` ### POST Get file chunks summary `POST /ssot/knowledge-space/summary` Tags: Notebook AI. Get all chunks for files in a knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceFileChunksInputRepresentation`. _Example: Example_ ``` { "searchIndexName": "KnowledgeIndex", "containerId": [ "container-1", "container-2" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceFileChunksOutputRepresentation`. _Example: Example_ ``` { "filepath": "knowledge_space/collections/library/document.pdf", "allChunks": "Chunk 1 text... Chunk 2 text..." } ``` ### POST Get knowledge for import `POST /ssot/knowledge-space/getKnowledgeForImport` Tags: Notebook AI. Get knowledge libraries and search indexes to import into the specified knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeModalInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeModalOutputRepresentation`. _Example: Example_ ``` { "knowledgeList": [ { "knowledgeLibraryId": "1aQxx000000003FEAQ", "developerName": "Shared_Library", "label": "Shared Knowledge", "knowledgeCategory": "ENTERPRISE" } ], "searchIndexes": [ { "id": "18lxx0000004C92AAE", "developerName": "KSpaceRTSI", "label": "KSpaceRTSI" } ] } ``` ### POST Import knowledge `POST /ssot/knowledge-space/importKnowledge` Tags: Notebook AI. Import selected knowledge libraries and search indexes into a target knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeModalInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "selectedList": { "knowledgeIds": [ "1aQxx000000003FEAQ" ], "searchIndexes": [ "18lxx0000004C92AAE" ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeModalOutputRepresentation`. _Example: Example_ ``` { "knowledgeList": [ { "knowledgeLibraryId": "1aQxx000000003FEAQ", "developerName": "Shared_Library", "label": "Shared Knowledge" } ] } ``` ### POST Run deep research `POST /ssot/knowledge-space/deep-research/{researchId}/run` Tags: Notebook AI. Run deep research for a research ID. **Available Version:** 67.0 #### Parameters * `researchId` (path, string, required) The unique identifier for the deep research job. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceDeepResRunResearchOutputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123" } ``` ### GET Get deep research status `GET /ssot/knowledge-space/deep-research/{researchId}` Tags: Notebook AI. Get the deep research status by research ID. **Available Version:** 67.0 #### Parameters * `researchId` (path, string, required) Unique identifier for the deep research job. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceRunResearchOutputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123", "status": "RUNNING", "query": "What are the latest trends in AI research?", "plan": { "title": "AI Research Trends Investigation", "estimatedDurationMinutes": 45, "steps": [ { "title": "Literature Review", "description": "Review recent publications and research papers" }, { "title": "Data Analysis", "description": "Analyze trends and patterns in the collected data" } ] }, "runDetails": { "startTime": "2026-07-29T10:00:00Z", "currentStep": "Literature Review", "progress": 0.33 } } ``` ### PATCH Update deep research plan `PATCH /ssot/knowledge-space/deep-research/{researchId}` Tags: Notebook AI. Update the deep research plan (instructions and/or steps) before execution. **Available Version:** 67.0 #### Parameters * `researchId` (path, string, required) Unique identifier for the deep research job. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceDeepResearchPlanPatchInputRepresentation`. _Example: Example_ ``` { "editInstructions": "Focus more on recent developments in the last 6 months", "plan": { "steps": [ { "title": "Literature Review", "description": "Review recent publications and research papers" }, { "title": "Data Analysis", "description": "Analyze trends and patterns in the collected data" }, { "title": "Expert Consultation", "description": "Synthesize findings from domain experts" } ] } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceRunResearchOutputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123", "status": "PENDING", "query": "What are the latest trends in AI research?", "plan": { "title": "AI Research Trends Investigation", "estimatedDurationMinutes": 45, "steps": [ { "title": "Literature Review", "description": "Review recent publications and research papers" }, { "title": "Data Analysis", "description": "Analyze trends and patterns in the collected data" }, { "title": "Expert Consultation", "description": "Synthesize findings from domain experts" } ] } } ``` ### POST Cancel running deep research job `POST /ssot/knowledge-space/deep-research/{researchId}/cancel` Tags: Notebook AI. Cancel a running deep research job, optionally requesting a partial report from completed steps. **Available Version:** 67.0 #### Parameters * `researchId` (path, string, required) Unique identifier for the deep research job to cancel. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `KnowledgeSpaceDeepResearchCancelInputRepresentation`. _Example: Example_ ``` { "partialReport": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceRunResearchOutputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123", "status": "CANCELLED", "query": "What are the latest trends in AI research?", "report": { "summary": "Partial findings from Literature Review step", "sections": [ { "title": "Key Findings", "content": "Preliminary analysis shows increased focus on multimodal AI..." } ] } } ``` ### POST Get deep research report `POST /ssot/knowledge-space/deep-research/{researchId}/report` Tags: Notebook AI. Get the deep research report for a research ID. **Available Version:** 67.0 #### Parameters * `researchId` (path, string, required) Unique identifier for the deep research job. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceDeepResReportInputRepresentation`. _Example: Example_ ``` { "outputFormat": "markdown" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceDeepResReportOutputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123", "report": "# AI Research Trends Report\n\n## Executive Summary\n\nThis report analyzes the latest trends in AI research...\n\n## Key Findings\n\n1. Multimodal AI systems are gaining prominence\n2. Focus on interpretability and explainability\n3. Increased attention to AI safety and alignment\n\n## Detailed Analysis\n\n### Literature Review\n\nRecent publications show...\n\n### Data Trends\n\nAnalysis reveals..." } ``` ### POST Add deep research as knowledge source `POST /ssot/knowledge-space/space/{knowledgeSpaceApiNameOrId}/deep-research/source` Tags: Notebook AI. Copy a completed deep research report into the knowledge space's GENERATED\_RESOURCES library and trigger indexing. This causes the research findings to be available for future queries. **Available Version:** 67.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 67.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceDeepResearchAddSourceInputRepresentation`. _Example: Example_ ``` { "researchId": "research-abc123", "reportFilePath": "/sfdrive/temp/research-abc123-report.md", "fileName": "AI_Research_Trends_Report.md" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceDeepResearchAddSourceOutputRepresentation`. _Example: Example_ ``` { "knowledgeSourceId": "1KSxx0000000042", "knowledgeSrcFileRefId": "1KFxx0000000128", "persistedFilePath": "/sfdrive/knowledge-space/reports/AI_Research_Trends_Report.md" } ``` ### GET Get knowledge space sessions `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/sessions` Tags: Notebook AI. Get all sessions for a knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 * `limit` (query, integer) Maximum number of sessions to return. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `AllKnowledgeSpaceSessionOutputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceSessions": [ { "sessionId": "session-123", "knowledgeSpaceId": "1T8xx0000004CYqCAM", "lastActiveTime": "2025-01-15T10:30:00Z" } ] } ``` ### POST Create knowledge space session `POST /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/sessions` Tags: Notebook AI. Create a new session for a knowledge space. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 #### Request body (required) Media type: `application/json`. Schema: `KnowledgeSpaceSessionInputRepresentation`. _Example: Example_ ``` { "knowledgeSpaceId": "1T8xx0000004CYqCAM", "sessionId": "session-123" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceSessionOutputRepresentation`. _Example: Example_ ``` { "sessionId": "session-123", "knowledgeSpaceId": "1T8xx0000004CYqCAM", "knowledgeSpaceSessionEntityId": "1KSxx0000000001", "agentType": "FILE_BASED" } ``` ### GET Get knowledge space session `GET /ssot/knowledge-space/session/{knowledgeSpaceSessionId}` Tags: Notebook AI. Get a knowledge space session. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceSessionId` (path, string, required) ID of the knowledge space session. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceSessionOutputRepresentation`. _Example: Example_ ``` { "sessionId": "session-123", "knowledgeSpaceId": "1T8xx0000004CYqCAM", "agentType": "FILE_BASED", "lastActiveTime": "2025-01-15T10:30:00Z" } ``` ### DELETE Delete knowledge space session `DELETE /ssot/knowledge-space/session/{knowledgeSpaceSessionId}` Tags: Notebook AI. Delete a knowledge space session. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceSessionId` (path, string, required) ID of the knowledge space session. **Available Version:** 65.0 #### Responses * **200** Success ### GET Get session conversation `GET /ssot/knowledge-space/{knowledgeSpaceApiNameOrId}/session/{knowledgeSpaceSessionId}/conversation` Tags: Notebook AI. Get conversation messages for a knowledge space session. **Available Version:** 65.0 #### Parameters * `knowledgeSpaceApiNameOrId` (path, string, required) API name or ID of the knowledge space. **Available Version:** 65.0 * `knowledgeSpaceSessionId` (path, string, required) ID of the knowledge space session. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `KnowledgeSpaceSessionConversationOutputRepresentation`. _Example: Example_ ``` { "messages": [ { "role": "user", "content": "What is the process for X?", "timestamp": "2025-01-15T10:30:00Z" } ] } ``` ### POST Create data alert `POST /ssot/machine-learning/alerts` Tags: Machine Learning. Create a new data alert within the data alert collection. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlDataAlertQueryInputRepresentation`. _Example: Example_ ``` { "asset": "12l000000000000", "assetType": "ModelArtifact", "sourceTypes": [ "ModelTraining" ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlDataAlertCollectionRepresentation`. _Example: Example_ ``` { "source": { "id": "ml3759v2", "label": "Churn_Prediction_Model_v2.1", "name": "Churn_v2", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/ml3759v2" }, "totalSize": 2, "dataAlerts": [ { "id": "alert_001_recommended_buckets", "alertType": "RecommendedBuckets", "sourceType": "ModelTraining", "dismissed": true, "accepted": false, "applicable": true, "lastStatusChangeDate": "2025-11-20T10:30:00Z", "lastStatusChangeBy": { "id": "005SG00000A1B2C", "name": "Jane Doe", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastStatusChangeVersion": 5, "subject": "RecommendedBucketsSubject", "message": "For Monthly Charges, consider using the following buckets. Determine whether grouping data in this way improves the interpretability of story insights.", "key": "key-RecommendedBuckets-MonthlyCharges", "directives": [ { "directiveKey": "fieldName", "previewText": "Apply the new buckets" }, { "directiveKey": "outcomeDisplayName", "previewText": "Remove outliers" }, { "directiveKey": "fieldName", "previewText": "Exclude all values for which the model only predicts one outcome" } ], "relatedData": { "recommendedBuckets": [ "0 to 500", "500 to 600", "600 to 750" ], "cutoffs": [ 0, 500, 600, 750 ] }, "url": "/services/data/v61.0/ssot/machine-learning/alerts/alert_001_recommended_buckets" }, { "id": "alert_002_data_leakage", "alertType": "DataLeakage", "sourceType": "ModelTraining", "dismissed": false, "accepted": false, "applicable": true, "lastStatusChangeDate": "2025-11-21T14:45:00Z", "lastStatusChangeBy": { "id": "005SG00000Z9Y8X", "name": "Automated System", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastStatusChangeVersion": 2, "subject": "DataLeakageSubject", "message": "Tenure:1 month the outcome is always Churn:TRUE. Investigate Tenure response for data leakage. If found, exclude Tenure response from the story.", "key": "key-DataLeakage-Tenure", "directives": [ { "directiveKey": "fieldName2", "previewText": "Exclude fieldName2" }, { "directiveKey": "fieldName2", "previewText": "Exclude all values for which the model only predicts one outcome." } ], "relatedData": { "fieldLabel": "Tenure", "outcomeFieldLabel": "Churn", "outcomeSuccessLabel": "FALSE", "outcomeFailureLabel": "TRUE", "values": [ { "label": "1 month", "meetsCriteria": "true", "percentSuccess": 100 } ] }, "url": "/services/data/v61.0/ssot/machine-learning/alerts/alert_002_data_leakage" } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### PATCH Update data alert `PATCH /ssot/machine-learning/alerts/{alertId}` Tags: Machine Learning. Partially update an existing data alert. **Available Version:** 61.0 #### Parameters * `alertId` (path, string, required) ID of the data alert. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlDataAlertInputRepresentation`. _Example: Example_ ``` { "accepted": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlDataAlertRepresentation`. _Example: Example_ ``` { "id": "alert_001_recommended_buckets", "alertType": "RecommendedBuckets", "sourceType": "ModelTraining", "dismissed": true, "accepted": false, "applicable": true, "lastStatusChangeDate": "2025-11-20T10:30:00Z", "lastStatusChangeBy": { "id": "005SG00000A1B2C", "name": "Jane Doe", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastStatusChangeVersion": 5, "subject": "RecommendedBucketsSubject", "message": "For Monthly Charges, consider using the following buckets. Determine whether grouping data in this way improves the interpretability of story insights.", "key": "key-RecommendedBuckets-MonthlyCharges", "directives": [ { "directiveKey": "fieldName", "previewText": "Apply the new buckets" }, { "directiveKey": "outcomeDisplayName", "previewText": "Remove outliers" }, { "directiveKey": "fieldName", "previewText": "Exclude all values for which the model only predicts one outcome." } ], "relatedData": { "recommendedBuckets": [ "0 to 500", "500 to 600", "600 to 750" ], "cutoffs": [ 0, 500, 600, 750 ] }, "url": "/services/data/v61.0/ssot/machine-learning/alerts/alert_001_recommended_buckets" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get configured models `GET /ssot/machine-learning/configured-models` Tags: Machine Learning. Get the set of configured models and their properties. **Available Version:** 61.0 #### Parameters * `assetIdOrName` (query, string) The model's name or ID. If not provided, information for all configured models is returned. **Available Version:** 61.0 * `assetType` (query, string) Whether the model is a configured model or a model artifact. **Available Version:** 61.0 Allowed values: `ModelArtifact`, `ModelSetup`. * `capabilities` (query, array of string) Model capability. **Available Version:** 61.0 Items: Allowed values: `BinaryClassification`, `ChatCompletion`, `Completion`, `Embedding`, `Generic`, `MulticlassClassification`, `Regression`. * `connectorType` (query, string) For models that are externally connected, indicates the type of connector. **Available Version:** 61.0 Allowed values: `Anthropic`, `AzureOpenAI`, `Bedrock`, `Databricks`, `Generic`, `InternalEmbedding`, `OpenAI`, `SageMaker`, `VertexAI`. * `limit` (query, integer) Maximum number of models to display on each page. **Available Version:** 61.0 * `modelType` (query, string) The type of model. **Available Version:** 61.0 Allowed values: `Generative`, `Predictive`, `Unknown`. * `offset` (query, integer) The number of models to skip, or offset, during pagination. **Available Version:** 61.0 * `outOfTheBox` (query, boolean) If `true`, the model is managed by Salesforce. **Available Version:** 61.0 * `search` (query, string) The search string to use when filtering the query. **Available Version:** 61.0 * `sourceType` (query, string) The model's source. * `OutOfTheBox` — a model managed by Salesforce. * `ModelConnector` — an external model exposed to Salesforce through a connector. * `EdcNoCode` — a model created using a no-code or low-code model builder. **Available Version:** 61.0 Allowed values: `EdcNoCode`, `ModelConnector`, `OutOfTheBox`. #### Responses * **200** Success Media type: `application/json`. Schema: `MlConfiguredModelCollectionRepresentation`. _Example: Example_ ``` { "configuredModels": [ { "actionableFields": [], "artifact": { "label": "Azure OpenAI GPT 4 Turbo", "name": "AzureOpenAIGPT4Turbo", "namespace": "llmgateway", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__AzureOpenAIGPT4Turbo" }, "capability": "ChatCompletion", "connectorType": "AzureOpenAI", "createdDate": "2023-12-08T00:00:00.000Z", "description": "Standard Azure OpenAI GPT 4 Turbo configured model.", "label": "Azure OpenAI GPT 4 Turbo", "modelType": "Generative", "name": "DefaultAzureOpenAIGPT4Turbo", "namespace": "sfdc_ai", "parameterOverrides": [], "setupType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/configured-models/sfdc_ai__DefaultAzureOpenAIGPT4Turbo" }, { "actionableFields": [], "artifact": { "label": "OpenAI GPT 4", "name": "OpenAIGPT4", "namespace": "llmgateway", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__OpenAIGPT4" }, "capability": "ChatCompletion", "connectorType": "OpenAI", "createdDate": "2023-11-01T00:00:00.000Z", "description": "Standard OpenAI GPT 4 configured model.", "label": "OpenAI GPT 4", "modelType": "Generative", "name": "DefaultOpenAIGPT4", "namespace": "sfdc_ai", "parameterOverrides": [], "setupType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/configured-models/sfdc_ai__DefaultOpenAIGPT4" } ], "currentPageUrl": "/services/data/v61.0/ssot/machine-learning/configured-models?limit=2&offset=0", "nextPageUrl": "/services/data/v61.0/ssot/machine-learning/configured-models?limit=2&offset=2", "totalSize": 2 } ``` ### GET Get configured model `GET /ssot/machine-learning/configured-models/{configuredModelIdOrName}` Tags: Machine Learning. Get the configured model. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. **Available Version:** 61.0 #### Parameters * `configuredModelIdOrName` (path, string, required) The model's fully qualified name or ID. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. **Available Version:** 61.0 * `filterGroup` (query, string) Group on which to filter response results. Valid values are `Big`, `Medium`, and `Small`. * `Big` provides comprehensive results by returning properties whose filter group is `Big`, `Medium`, or `Small`. * `Medium` provides moderate results by returning properties whose filter group is `Medium` or `Small`. * `Small` provides essential results by returning only properties whose filter group is `Small`. The default is `Big`. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlConfiguredModelRepresentation`. _Example: Example_ ``` { "actionableFields": [], "artifact": { "label": "Default GPT 3.5 Turbo", "name": "GPT35Turbo", "namespace": "llmgateway", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__GPT35Turbo" }, "capability": "ChatCompletion", "connectorType": "Generic", "createdDate": "2024-01-01T00:00:00.000Z", "description": "Default GPT 3.5 Turbo configured model", "label": "Default GPT 3.5 Turbo configured model", "modelType": "Generative", "name": "DefaultGPT35Turbo", "namespace": "sfdc_ai", "parameterOverrides": [], "setupType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/configured-models/sfdc_ai__DefaultGPT35Turbo" } ``` ### DELETE Delete configured model `DELETE /ssot/machine-learning/configured-models/{configuredModelIdOrName}` Tags: Machine Learning. Delete a configured model. **Available Version:** 61.0 #### Parameters * `configuredModelIdOrName` (path, string, required) The model's fully qualified name or ID. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. **Available Version:** 61.0 #### Responses * **200** Success ### PATCH Update configured model `PATCH /ssot/machine-learning/configured-models/{configuredModelIdOrName}` Tags: Machine Learning. Update a configured model. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. **Available Version:** 61.0 #### Parameters * `configuredModelIdOrName` (path, string, required) The model's fully qualified name or ID. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. **Available Version:** 61.0 #### Request body (required) Media type: `application/json`. Schema: `MlConfiguredModelInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `MlConfiguredModelRepresentation`. _Example Example: same as GET /ssot/machine-learning/configured-models/{configuredModelIdOrName} 200 response._ ### GET Get predict jobs `GET /ssot/machine-learning/jobs` Tags: Machine Learning. Get a list of predict jobs. **Available Version:** 59.0 #### Parameters * `jobIdOrName` (query, string) ID or API name of the predict job. **Available Version:** 59.0 * `limit` (query, integer) Maximum number of predict jobs to return. **Available Version:** 59.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 59.0 * `type` (query, string) Type of job. **Available Version:** 59.0 Allowed values: `Prediction`, `Training`. #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlJobCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "/services/data/v66.0/ssot/machine-learning/jobs?limit=25&offset=0&type=Training", "jobs": [ { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:13.000Z", "description": null, "endTime": "2026-06-04T00:20:14.000Z", "id": "14qSB0000005jCbYAI", "input": { "id": "14kSB000000C8Y5YAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:15.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-04T00:15:16.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI/tasks", "totalRowsProcessed": 32212, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-02T04:19:57.000Z", "description": null, "endTime": "2026-06-02T04:24:17.000Z", "id": "14qSB0000005hYzYAI", "input": { "id": "14kSB000000C6ODYA0" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-02T04:24:19.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-02T04:19:58.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hYzYAI/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hYzYAI" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-02T04:04:02.000Z", "description": null, "endTime": "2026-06-02T04:08:03.000Z", "id": "14qSB0000005hXNYAY", "input": { "id": "14kSB000000C6MbYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-02T04:08:11.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-02T04:04:04.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hXNYAY/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hXNYAY" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-01T22:59:41.000Z", "description": null, "endTime": "2026-06-01T23:06:33.000Z", "id": "14qSB0000005hU9YAI", "input": { "id": "14kSB000000C6JNYA0" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-01T23:06:38.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-01T22:59:43.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hU9YAI/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hU9YAI" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-01T21:59:14.000Z", "description": null, "endTime": "2026-06-01T22:04:15.000Z", "id": "14qSB0000005hSXYAY", "input": { "id": "14kSB000000C6HlYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-01T22:04:16.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-01T21:59:16.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hSXYAY/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hSXYAY" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-01T21:50:09.000Z", "description": null, "endTime": "2026-06-01T21:55:49.000Z", "id": "14qSB0000005hQvYAI", "input": { "id": "14kSB000000C6G9YAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-01T21:55:50.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-01T21:50:10.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hQvYAI/tasks", "totalRowsProcessed": 1462, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hQvYAI" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-01T21:28:25.000Z", "description": null, "endTime": "2026-06-01T21:33:28.000Z", "id": "14qSB0000005hPJYAY", "input": { "id": "14kSB000000C6EXYA0" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-01T21:33:31.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-01T21:28:27.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hPJYAY/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hPJYAY" }, { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-01T20:48:58.000Z", "description": null, "endTime": "2026-06-01T20:54:20.000Z", "id": "14qSB0000005hNhYAI", "input": { "id": "14kSB000000C6CvYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-01T20:54:22.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-01T20:48:59.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hNhYAI/tasks", "totalRowsProcessed": 1470, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005hNhYAI" } ], "nextPageUrl": null, "totalSize": 8 } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get a predict job `GET /ssot/machine-learning/jobs/{jobId}` Tags: Machine Learning. Get a specific predict job. **Available Version:** 59.0 #### Parameters * `jobId` (path, string, required) ID of the predict job. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlJobBaseRepresentation`. _Example: example1_ ``` { "type": "Training", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:13.000Z", "description": null, "endTime": "2026-06-04T00:20:14.000Z", "id": "14qSB0000005jCbYAI", "input": { "id": "14kSB000000C8Y5YAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:15.000Z", "message": null, "name": null, "namespace": null, "numberOfTasks": 1, "startTime": "2026-06-04T00:15:16.000Z", "status": "Success", "tasksUrl": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI/tasks", "totalRowsProcessed": 32212, "triggerType": "User", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get predict job tasks `GET /ssot/machine-learning/jobs/{jobId}/tasks` Tags: Machine Learning. Get a list of tasks associated with a specific predict job. **Available Version:** 59.0 #### Parameters * `jobId` (path, string, required) ID of the predict job. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlTaskCollection`. _Example: example1_ ``` { "tasks": [ { "configurationResult": { "type": "EdcNoCode", "active": false, "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:12.000Z", "description": "true=10086,false=22126", "fieldRelationships": [], "fieldSelection": "Automatic", "fields": [ { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": false, "ignored": false, "label": "Amount", "max": 1335411, "min": 489, "name": "Amount__c", "sensitive": false, "source": null }, { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": false, "ignored": false, "label": "Discount", "max": 50, "min": 0, "name": "Discount__c", "sensitive": false, "source": null }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Competitor", "name": "Competitor__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Product Name", "name": "Product_Name__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Promotion", "name": "Promotion__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Region", "name": "Region__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Vertical", "name": "Vertical__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Date", "highCardinality": false, "ignored": false, "label": "Date", "max": "2015-04-01T00:00:00.000Z", "min": "2015-01-01T00:00:00.000Z", "name": "Date__c", "sensitive": false, "source": null } ], "filter": null, "id": "14kSB000000C8Y5YAK", "input": null, "job": { "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:13.000Z", "id": "14qSB0000005jCbYAI", "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:15.000Z", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI" }, "joins": [], "label": null, "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-04T00:22:03.000Z", "modelConfiguration": { "algorithmType": "Catboost" }, "name": null, "namespace": null, "numberOfPartitions": null, "outcomes": [ { "type": "Binary", "failureValue": "FALSE", "failureValueCount": null, "goal": "Maximize", "label": "Opportunity_Won", "name": "Opportunity_Won__c", "source": null, "successValue": "TRUE", "successValueCount": null } ], "partitionsUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1MTYA0/setup-versions/14kSB000000C8Y5YAK/partitions", "runtimeType": "InternalV2", "status": "Published", "transformations": [ { "type": "ExtractMonthOfYear", "postTransformationFilter": null, "source": null, "sourceFieldName": null, "sourceFieldSource": null, "targetFieldName": null } ], "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1MTYA0/setup-versions/14kSB000000C8Y5YAK", "validationConfiguration": null, "version": 1 }, "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-04T00:20:14.000Z", "endTime": "2026-06-04T00:20:14.000Z", "errorCode": null, "id": "14rSB0000007CZ7YAM", "input": { "id": "14lSB000000BvKjYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:14.000Z", "message": null, "name": null, "namespace": null, "resultArtifact": { "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-04T00:20:15.000Z", "id": "12lSB000000UiejYAC", "label": "model artifact label", "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-05T23:22:01.000Z", "name": "model_artifact_label_MA_12l_t1d4de5c954", "url": "/services/data/v66.0/ssot/machine-learning/model-artifacts/12lSB000000UiejYAC" }, "startTime": null, "status": "Published", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI/tasks/14rSB0000007CZ7YAM" }, { "configurationResult": { "type": "EdcNoCode", "active": true, "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-05T14:30:45.000Z", "description": "true=8542,false=18934", "fieldRelationships": [], "fieldSelection": "Manual", "fields": [ { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 5 }, "highCardinality": false, "ignored": false, "label": "Revenue", "max": 2500000, "min": 1000, "name": "Revenue__c", "sensitive": false, "source": null }, { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": false, "ignored": false, "label": "Contract Value", "max": 500000, "min": 5000, "name": "Contract_Value__c", "sensitive": false, "source": null }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Industry", "name": "Industry__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Lead Source", "name": "Lead_Source__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Account Type", "name": "Account_Type__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Date", "highCardinality": false, "ignored": false, "label": "Close Date", "max": "2015-12-31T00:00:00.000Z", "min": "2015-06-01T00:00:00.000Z", "name": "Close_Date__c", "sensitive": false, "source": null } ], "filter": null, "id": "14kSB000000C9ABYA0", "input": null, "job": { "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-05T14:30:46.000Z", "id": "14qSB0000005jDmYAI", "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-05T14:35:22.000Z", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jDmYAI" }, "joins": [], "label": null, "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-05T14:37:18.000Z", "modelConfiguration": { "algorithmType": "XGBoost" }, "name": null, "namespace": null, "numberOfPartitions": null, "outcomes": [ { "type": "Binary", "failureValue": "FALSE", "failureValueCount": null, "goal": "Maximize", "label": "Deal_Closed", "name": "Deal_Closed__c", "source": null, "successValue": "TRUE", "successValueCount": null } ], "partitionsUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1NXYA0/setup-versions/14kSB000000C9ABYA0/partitions", "runtimeType": "InternalV2", "status": "InProgress", "transformations": [ { "type": "ExtractDayOfWeek", "postTransformationFilter": null, "source": null, "sourceFieldName": null, "sourceFieldSource": null, "targetFieldName": null } ], "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1NXYA0/setup-versions/14kSB000000C9ABYA0", "validationConfiguration": null, "version": 2 }, "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-05T14:35:21.000Z", "endTime": "2026-06-05T14:35:21.000Z", "errorCode": null, "id": "14rSB0000007CaBYAU", "input": { "id": "14lSB000000BvLpYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-05T14:35:21.000Z", "message": null, "name": null, "namespace": null, "resultArtifact": { "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-05T14:35:22.000Z", "id": "12lSB000000UikFYAS", "label": "revenue prediction artifact", "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-06T10:15:33.000Z", "name": "revenue_prediction_artifact_MA_12l_t1d4f8a2b71", "url": "/services/data/v66.0/ssot/machine-learning/model-artifacts/12lSB000000UikFYAS" }, "startTime": null, "status": "InProgress", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jDmYAI/tasks/14rSB0000007CaBYAU" } ] } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get a predict job task `GET /ssot/machine-learning/jobs/{jobId}/tasks/{taskId}` Tags: Machine Learning. Get a task associated with a specific predict job. **Available Version:** 59.0 #### Parameters * `jobId` (path, string, required) ID of the predict job. **Available Version:** 59.0 * `taskId` (path, string, required) ID of the task. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlTaskBase`. _Example: example1_ ``` { "configurationResult": { "type": "EdcNoCode", "active": false, "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:12.000Z", "description": "true=10086,false=22126", "fieldRelationships": [], "fieldSelection": "Automatic", "fields": [ { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": false, "ignored": false, "label": "Amount", "max": 1335411, "min": 489, "name": "Amount__c", "sensitive": false, "source": null }, { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": false, "ignored": false, "label": "Discount", "max": 50, "min": 0, "name": "Discount__c", "sensitive": false, "source": null }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Competitor", "name": "Competitor__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Product Name", "name": "Product_Name__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Promotion", "name": "Promotion__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Region", "name": "Region__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Vertical", "name": "Vertical__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [] }, { "type": "Date", "highCardinality": false, "ignored": false, "label": "Date", "max": "2015-04-01T00:00:00.000Z", "min": "2015-01-01T00:00:00.000Z", "name": "Date__c", "sensitive": false, "source": null } ], "filter": null, "id": "14kSB000000C8Y5YAK", "input": null, "job": { "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "createdDate": "2026-06-04T00:15:13.000Z", "id": "14qSB0000005jCbYAI", "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:15.000Z", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI" }, "joins": [], "label": null, "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-04T00:22:03.000Z", "modelConfiguration": { "algorithmType": "Catboost" }, "name": null, "namespace": null, "numberOfPartitions": null, "outcomes": [ { "type": "Binary", "failureValue": "FALSE", "failureValueCount": null, "goal": "Maximize", "label": "Opportunity_Won", "name": "Opportunity_Won__c", "source": null, "successValue": "TRUE", "successValueCount": null } ], "partitionsUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1MTYA0/setup-versions/14kSB000000C8Y5YAK/partitions", "runtimeType": "InternalV2", "status": "Published", "transformations": [ { "type": "ExtractMonthOfYear", "postTransformationFilter": null, "source": null, "sourceFieldName": null, "sourceFieldSource": null, "targetFieldName": null } ], "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSB000000D1MTYA0/setup-versions/14kSB000000C8Y5YAK", "validationConfiguration": null, "version": 1 }, "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-04T00:20:14.000Z", "endTime": "2026-06-04T00:20:14.000Z", "errorCode": null, "id": "14rSB0000007CZ7YAM", "input": { "id": "14lSB000000BvKjYAK" }, "label": null, "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "lastModifiedDate": "2026-06-04T00:20:14.000Z", "message": null, "name": null, "namespace": null, "resultArtifact": { "createdBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process" }, "createdDate": "2026-06-04T00:20:15.000Z", "id": "12lSB000000UiejYAC", "label": "model artifact label", "lastModifiedBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin" }, "lastModifiedDate": "2026-06-05T23:22:01.000Z", "name": "model_artifact_label_MA_12l_t1d4de5c954", "url": "/services/data/v66.0/ssot/machine-learning/model-artifacts/12lSB000000UiejYAC" }, "startTime": null, "status": "Published", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSB0000005jCbYAI/tasks/14rSB0000007CZ7YAM" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get model artifacts `GET /ssot/machine-learning/model-artifacts` Tags: Machine Learning. Get model artifacts. **Available Version:** 61.0 #### Parameters * `limit` (query, integer) Maximum number of artifacts to return. **Available Version:** 61.0 * `modelType` (query, string) Type of artifacts to return. **Available Version:** 61.0 Allowed values: `Generative`, `Predictive`, `Unknown`. * `offset` (query, integer) The number of models to skip, or offset, during pagination. **Available Version:** 61.0 * `sourceType` (query, string) The model's source. * `OutOfTheBox` — a model managed by Salesforce. * `ModelConnector` — an external model exposed to Salesforce through a connector. * `EdcNoCode` — a model created using a no-code or low-code model builder. **Available Version:** 61.0 Allowed values: `EdcNoCode`, `ModelConnector`, `OutOfTheBox`. #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlModelArtifactCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "/services/data/v61.0/ssot/machine-learning/model-artifacts?limit=2&offset=0", "modelArtifacts": [ { "createdDate": "2024-01-01T00:00:00.000Z", "description": "Default GPT 3.5 Turbo", "foundationalModel": { "deprecationDate": null, "foundationalModelName": "GPT35Turbo", "internalVersionNumber": null, "majorVersionName": "GenericGPT35Turbo", "minorVersionName": null, "modelIdentifier": null, "modelProviderName": "Generic" }, "generativeModelType": "Text", "inputFields": [], "label": "Default GPT 3.5 Turbo", "modelCapabilities": [ "ChatCompletion" ], "modelCount": 1, "modelType": "Generative", "name": "GPT35Turbo", "namespace": "llmgateway", "outputFields": [], "parameters": [ { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0.5, "description": "The sampling temperature, from 0 to 2. Higher values, such as 0.8, make the output more random, while lower values, such as 0.2, make the output more focused and deterministic. ", "maxValue": 2, "minValue": 0, "overridable": true, "parameterName": "temperature", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "description": "The maximum number of tokens to generate in the completion.", "maxValue": 4096, "minValue": 1, "overridable": true, "parameterName": "max_tokens", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "frequency_penalty", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. Behaves similarly to `frequency_penalty`, except that this penalty is applied equally to all tokens that have already appeared, regardless of their exact frequencies.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "presence_penalty", "type": "Continuous" } ], "runtimeType": "External", "sourceType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__GPT35Turbo" }, { "createdDate": "2024-01-01T00:00:00.000Z", "description": "Default GPT 3.5 Turbo 16k", "foundationalModel": { "deprecationDate": null, "foundationalModelName": "GPT35Turbo_16k", "internalVersionNumber": null, "majorVersionName": "GenericGPT35Turbo_16k", "minorVersionName": null, "modelIdentifier": null, "modelProviderName": "Generic" }, "generativeModelType": "Text", "inputFields": [], "label": "Default GPT 3.5 Turbo 16k", "modelCapabilities": [ "ChatCompletion" ], "modelCount": 1, "modelType": "Generative", "name": "GPT35Turbo_16k", "namespace": "llmgateway", "outputFields": [], "parameters": [ { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0.5, "description": "The sampling temperature, from 0 to 2. Higher values, such as 0.8, make the output more random, while lower values, such as 0.2, make the output more focused and deterministic. ", "maxValue": 2, "minValue": 0, "overridable": true, "parameterName": "temperature", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "description": "The maximum number of tokens to generate in the completion.", "maxValue": 16384, "minValue": 1, "overridable": true, "parameterName": "max_tokens", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "frequency_penalty", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. Behaves similarly to `frequency_penalty`, except that this penalty is applied equally to all tokens that have already appeared, regardless of their exact frequencies.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "presence_penalty", "type": "Continuous" } ], "runtimeType": "External", "sourceType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__GPT35Turbo_16k" } ], "nextPageUrl": "/services/data/v61.0/ssot/machine-learning/model-artifacts?limit=2&offset=2", "totalSize": 114 } ``` ### GET Get model artifact `GET /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` Tags: Machine Learning. Get the model artifact. **Available Version:** 61.0 #### Parameters * `modelArtifactIdOrName` (path, string, required) The artifact's name or ID. If using the artifact's name, use `__`. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlModelArtifactBaseRepresentation`. _Example: Example_ ``` { "createdDate": "2024-01-01T00:00:00.000Z", "description": "Default GPT 3.5 Turbo", "foundationalModel": { "deprecationDate": null, "foundationalModelName": "GPT35Turbo", "internalVersionNumber": null, "majorVersionName": "GenericGPT35Turbo", "minorVersionName": null, "modelIdentifier": null, "modelProviderName": "Generic" }, "generativeModelType": "Text", "inputFields": [], "label": "Default GPT 3.5 Turbo", "modelCapabilities": [ "ChatCompletion" ], "modelCount": 1, "modelType": "Generative", "name": "GPT35Turbo", "namespace": "llmgateway", "outputFields": [], "parameters": [ { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0.5, "description": "Sampling temperature, from 0 to 2. Higher values, such as 0.8, make the output more random, while lower values, such as 0.2, make the output more focused and deterministic. ", "maxValue": 2, "minValue": 0, "overridable": true, "parameterName": "temperature", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "description": "The maximum number of tokens to generate in the completion.", "maxValue": 4096, "minValue": 1, "overridable": true, "parameterName": "max_tokens", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "frequency_penalty", "type": "Continuous" }, { "applicableCapabilities": [ "ChatCompletion" ], "defaultValue": 0, "description": "Can reduce the repetitiveness of generated tokens. Behaves similarly to `frequency_penalty`, except that this penalty is applied equally to all tokens that have already appeared, regardless of their exact frequencies.", "maxValue": 2, "minValue": -2, "overridable": true, "parameterName": "presence_penalty", "type": "Continuous" } ], "runtimeType": "External", "sourceType": "OutOfTheBox", "status": "Enabled", "url": "/services/data/v61.0/ssot/machine-learning/model-artifacts/llmgateway__GPT35Turbo" } ``` ### DELETE Delete model artifact `DELETE /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` Tags: Machine Learning. Delete the model artifact. **Available Version:** 61.0 #### Parameters * `modelArtifactIdOrName` (path, string, required) The artifact's name or ID. If using the artifact's name, use `__`. **Available Version:** 61.0 #### Responses * **200** Success ### PATCH Update model artifact `PATCH /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}` Tags: Machine Learning. Update the model artifact. **Available Version:** 61.0 #### Parameters * `modelArtifactIdOrName` (path, string, required) The artifact's name or ID. If using the artifact's name, use `__`. **Available Version:** 61.0 #### Request body (required) Media type: `application/json`. Schema: `CdpMlModelArtifactInputRepresentation`. _Example: Example_ ``` { "label": "", "description": "", "status": "Disabled" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlModelArtifactBaseRepresentation`. _Example Example: same as GET /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName} 200 response._ ### GET Get model setup versions `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions` Tags: Machine Learning. Retrieve a list of model setup versions. **Available Version:** 59.0 #### Parameters * `modelSetupIdOrName` (path, string, required) ID or developer name of the model setup. **Available Version:** 59.0 * `active` (query, boolean) Indicates whether the model setup is active (`true`) or not (`false`). **Available Version:** 59.0 * `limit` (query, integer) Maximum number of model setup versions to return. **Available Version:** 59.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupVersionCollectionRepresentation`. _Example: Example_ ``` { "currentPageUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions?limit=-1&offset=0", "nextPageUrl": null, "totalSize": 1, "versions": [ { "type": "EdcNoCode", "active": true, "createdBy": { "id": "005SG000003tVpRYAU", "name": "OrgFarm Epic", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-09-05T21:41:36.000Z", "description": null, "fieldRelationships": [], "fieldSelection": "Automatic", "fields": [], "filter": null, "id": "14kSG0000001NAfYAM", "input": { "type": "DataModelObject", "dataSpace": null, "primary": null, "source": { "id": "0gjSG000000qnO1YAI", "label": "Memory", "name": "Memory__dlm" } }, "job": { "createdBy": { "id": "005SG000003tVpRYAU", "name": "OrgFarm Epic", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-09-05T21:41:37.000Z", "id": "14qSG0000000QQjYAM", "lastModifiedBy": { "id": "005SG000003tVr3YAE", "name": "Automated Process", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-09-05T21:45:16.000Z", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSG0000000QQjYAM" }, "joins": [], "label": null, "lastModifiedBy": { "id": "005SG000003tVr3YAE", "name": "Automated Process", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-09-05T21:45:16.000Z", "modelConfiguration": { "algorithmType": "Xgboost" }, "name": null, "namespace": null, "numberOfPartitions": null, "outcomes": [], "partitionsUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions", "status": "Published", "transformations": [], "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM", "validationConfiguration": null, "version": 1 } ] } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create model setup version `POST /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions` Tags: Machine Learning. Create a new model setup version. **Available Version:** 59.0 #### Parameters * `modelSetupIdOrName` (path, string, required) ID or developer name of the model setup. **Available Version:** 59.0 #### Request body Media type: `application/json`. Schema: `CdpMlSetupBaseInputRepresentation`. _Example: Example_ ``` { "description": "Initial version of the Customer Churn Prediction model setup.", "type": "EdcNoCode" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupBaseRepresentation`. _Example: Example_ ``` { "type": "EdcNoCode", "active": true, "createdBy": { "id": "005SG000003tVpRYAU", "name": "OrgFarm Epic", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-09-05T21:41:36.000Z", "description": null, "fieldRelationships": [], "fieldSelection": "Automatic", "fields": [ { "type": "Text", "balanced": false, "dataType": "Boolean", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Churn", "name": "churn__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [ { "count": null, "ignored": false, "label": "true", "name": "TRUE" }, { "count": null, "ignored": false, "label": "false", "name": "FALSE" } ] }, { "type": "Number", "bucketingStrategy": { "type": "Percentile", "numberOfBuckets": 10 }, "highCardinality": null, "ignored": false, "label": "Tenure", "max": 72, "min": 0, "name": "tenure__c", "sensitive": false, "source": null }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Marital Status", "name": "marital_status__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [ { "count": null, "ignored": false, "label": "Widowed", "name": "Widowed" }, { "count": null, "ignored": false, "label": "Divorced", "name": "Divorced" }, { "count": null, "ignored": false, "label": "Separated", "name": "Separated" }, { "count": null, "ignored": false, "label": "Married", "name": "Married" }, { "count": null, "ignored": false, "label": "Never married", "name": "Never married" } ] }, { "type": "Text", "balanced": false, "dataType": "Categorical", "highCardinality": false, "ignored": false, "includeOther": true, "label": "Contact ID", "name": "contact_id__c", "ordering": "Occurrence", "sensitive": false, "source": null, "values": [ { "count": null, "ignored": false, "label": "003B000000DTGZMIA5", "name": "003B000000DTGZMIA5" }, { "count": null, "ignored": false, "label": "003B000000DTHCyIAP", "name": "003B000000DTHCyIAP" }, { "count": null, "ignored": false, "label": "003B000000DTI46IAH", "name": "003B000000DTI46IAH" } ] } ], "filter": null, "id": "14kSG0000001NAfYAM", "input": { "type": "DataModelObject", "dataSpace": null, "primary": null, "source": { "id": "0gjSG000000qnO1YAI", "label": "Memory", "name": "Memory__dlm" } }, "job": { "createdBy": { "id": "005SG000003tVpRYAU", "name": "OrgFarm Epic", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2025-09-05T21:41:37.000Z", "id": "14qSG0000000QQjYAM", "lastModifiedBy": { "id": "005SG000003tVr3YAE", "name": "Automated Process", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-09-05T21:45:16.000Z", "url": "/services/data/v66.0/ssot/machine-learning/jobs/14qSG0000000QQjYAM" }, "joins": [], "label": null, "lastModifiedBy": { "id": "005SG000003tVr3YAE", "name": "Automated Process", "profilePhotoUrl": "https://test1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2025-09-05T21:45:16.000Z", "modelConfiguration": { "algorithmType": "Xgboost" }, "name": null, "namespace": null, "numberOfPartitions": null, "outcomes": [ { "type": "Binary", "failureValue": "TRUE", "failureValueCount": null, "goal": "Minimize", "label": "Churn", "name": "churn__c", "source": null, "successValue": "FALSE", "successValueCount": null } ], "partitionsUrl": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions", "status": "Published", "transformations": [], "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM", "validationConfiguration": null, "version": 1 } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get model setup version `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}` Tags: Machine Learning. Retrieve a specific model setup version. **Available Version:** 59.0 #### Parameters * `modelSetupIdOrName` (path, string, required) ID or developer name of the model setup. **Available Version:** 59.0 * `modelSetupVersionId` (path, string, required) ID of the model setup version. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupBaseRepresentation`. _Example Example: same as POST /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### PATCH Update model setup version `PATCH /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}` Tags: Machine Learning. Partially update an existing model setup version. **Available Version:** 59.0 #### Parameters * `modelSetupIdOrName` (path, string, required) ID or developer name of the model setup. **Available Version:** 59.0 * `modelSetupVersionId` (path, string, required) ID of the model setup version. **Available Version:** 59.0 #### Request body Media type: `application/json`. Schema: `MlSetupBaseUpdateInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupBaseRepresentation`. _Example Example: same as POST /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions 200 response._ * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get model setup version partitions `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions` Tags: Machine Learning. Retrieve all partitions of a specific model setup version. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupVersionPartitionCollectionRepresentation`. _Example: Example_ ``` { "partitions": [ { "type": "EdcNoCode", "description": "Partition for Training Data.", "id": "14kSG0000001PART1YAM", "label": "Training Partition", "name": "Training_Partition", "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions/14kSG0000001PART1YAM" }, { "type": "EdcNoCode", "description": "Partition for Test Data.", "id": "14kSG0000001PART2YAM", "label": "Test Partition", "name": "Test_Partition", "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions/14kSG0000001PART2YAM" } ], "totalSize": 2, "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get model setup version partition `GET /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}` Tags: Machine Learning. Retrieve a partition of a specific model setup version. **Available Version:** 59.0 #### Parameters * `modelSetupIdOrName` (path, string, required) ID or developer name of the model setup. **Available Version:** 59.0 * `modelSetupVersionId` (path, string, required) ID of the model setup version. **Available Version:** 59.0 * `modelSetupPartitionId` (path, string, required) ID of the model setup partition. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlSetupPartitionBaseRepresentation`. _Example: Example_ ``` { "type": "EdcNoCode", "description": "Partition for Training Data.", "id": "14kSG0000001PART1YAM", "label": "Training Partition", "name": "Training_Partition", "url": "/services/data/v66.0/ssot/machine-learning/model-setups/24sSG0000001iOnYAI/setup-versions/14kSG0000001NAfYAM/partitions/14kSG0000001PART1YAM" } ``` * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Get prediction `POST /ssot/machine-learning/predict` Tags: Machine Learning. Make a prediction using the specified model and parameters. This request is synchronous. **Available Version:** 61.0 #### Request body (required) Media type: `application/json`. Schema: `CdpMlPredictInputBaseRepresentation`. _Example: Example_ ``` { "model": { "name": "titanic_simple" }, "type": "RawData", "fieldNames": [ "sibsp__c", "pclass__c", "body__c", "home_dest__c" ], "rows": [ [ 3, 3, 3, "Other" ] ], "settings": { "maxPrescriptions": 3, "maxTopFactors": 3 } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpMlPredictResultRepresentation`. _Example: Max top factors response_ ``` { "aggregatePredictions": [], "model": { "id": "titanic_simple" }, "predictionType": "Regression", "predictions": [ { "factors": [ { "fields": [ { "customText": null, "inputValue": "3", "label": null, "name": "sibsp__c", "prescribedValue": "" }, { "customText": null, "inputValue": "3", "label": null, "name": "pclass__c", "prescribedValue": "" } ], "value": -6.326304223287199 }, { "fields": [ { "customText": null, "inputValue": "3", "label": null, "name": "sibsp__c", "prescribedValue": "" } ], "value": -3.1489014239591206 }, { "fields": [ { "customText": null, "inputValue": "3", "label": null, "name": "pclass__c", "prescribedValue": "" }, { "customText": null, "inputValue": "3", "label": null, "name": "body__c", "prescribedValue": "" } ], "value": 1.8612328772995461 } ], "partition": { "id": "titanic_simple" }, "predictedValue": 18.591355276051015, "prescriptions": [ { "fields": [ { "customText": null, "inputValue": "", "label": null, "name": "sibsp__c", "prescribedValue": "0 to 1" } ], "value": 12.944458626566139 }, { "fields": [ { "customText": null, "inputValue": "", "label": null, "name": "pclass__c", "prescribedValue": "1 to 2" } ], "value": 7.759102718162897 } ], "status": "Success", "type": "Regression", "warnings": { "missingFieldNames": [], "outOfBoundsFields": [] } } ], "settings": { "aggregateFunctions": [], "maxPrescriptions": 3, "maxTopFactors": 3, "prescriptionImpactPercentage": 0 } } ``` _Example: Binary classification response_ ``` { "aggregatePredictions": [], "model": { "id": "Vin_Predicted_survived_Before_MDS_CM_12l_8wDdb39f158" }, "predictionType": "BinaryClassification", "predictions": [ { "factors": [ { "fields": [ { "customText": null, "inputValue": "21.0", "label": null, "name": "age__c", "prescribedValue": "" } ], "value": 3.4928865725274605 }, { "fields": [ { "customText": null, "inputValue": "21.0", "label": null, "name": "age__c", "prescribedValue": "" }, { "customText": null, "inputValue": "11.1", "label": null, "name": "fare__c", "prescribedValue": "" } ], "value": 0.6613757708595074 } ], "partition": { "id": "Vin_Predicted_survived_Before_MDS_CM_12l_8wDdb39f158" }, "predictedValue": 43.17096792080847, "prescriptions": [ { "fields": [ { "customText": null, "inputValue": "", "label": null, "name": "fare__c", "prescribedValue": "78.2118 to 512.3292" } ], "value": 26.184310354233283 }, { "fields": [ { "customText": null, "inputValue": "", "label": null, "name": "fare__c", "prescribedValue": "21.8316 to 27.0568" } ], "value": 18.078637127875282 } ], "status": "Success", "type": "BinaryClassification", "warnings": { "missingFieldNames": [], "outOfBoundsFields": [] } } ], "settings": { "aggregateFunctions": [], "maxPrescriptions": 2, "maxTopFactors": 2, "prescriptionImpactPercentage": 0 } } ``` ### GET Get prediction job definitions `GET /ssot/machine-learning/prediction-job-definitions` Tags: Machine Learning. Get a list of existing prediction job definitions. **Available Version:** 59.0 #### Parameters * `modelId` (query, string) ID of the machine learning model. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlPredictionJobDefCollectionRepresentation`. _Example: example1_ ``` { "predictionJobDefinitions": [ { "activationStatus": "Active", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin", "profilePhotoUrl": "https://lovi-may2025-cdptest1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2026-05-20T22:13:42.000Z", "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "description": "big query", "id": "106SB00000IR6i5YAD", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM852AF", "label": "ResponseTimeFromAssignment", "name": "responsetimefromassignment__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008UovYAE", "label": "ResponseTimeFromAssignment", "name": "responsetimefromassignment__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM832AF", "label": "ResponseTimefromCreation", "name": "responsetimefromcreation__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008UowYAE", "label": "ResponseTimefromCreation", "name": "responsetimefromcreation__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8E2AV", "label": "UniqueId", "name": "uniqueid__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008UoxYAE", "label": "UniqueId", "name": "uniqueid__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM812AF", "label": "Company", "name": "company__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008UoyYAE", "label": "Company", "name": "company__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8C2AV", "label": "Industry", "name": "industry__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008UozYAE", "label": "Industry", "name": "industry__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM882AF", "label": "LeadSource", "name": "leadsource__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008Up0YAE", "label": "LeadSource", "name": "leadsource__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8D2AV", "label": "Title", "name": "title__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008Up1YAE", "label": "Title", "name": "title__c", "namespace": "" }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM862AF", "label": "Converted", "name": "converted__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xmSB0000008Up2YAE", "label": "Converted", "name": "converted__c", "namespace": "" }, "updateScore": false } ] }, "label": "cschoett-predict-job1", "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process", "profilePhotoUrl": "https://lovi-may2025-cdptest1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-01T19:08:46.000Z", "lastRunDate": "2026-06-01T19:08:45.000Z", "lastRunStatus": "Success", "model": { "id": "12lSB000000UWdZYAW", "label": "cschoett big query Predicted NumOfEmployees", "name": "cschoett_big_query_Predicted_NumOfEmployees_CM_12l_t1dd4f0c469", "url": "/services/data/v66.0/ssot/machine-learning/configured-models/12lSB000000UWdZYAW" }, "name": "cschoett_predict_job1", "namespace": "", "outputConfig": { "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksO2AR", "label": "Internal Organization", "name": "InternalOrganization__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM872AF", "label": "Internal Organization", "name": "InternalOrganization__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksR2AR", "label": "Data Source", "name": "DataSource__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8G2AV", "label": "Data Source", "name": "DataSource__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksM2AR", "label": "Data Source Object", "name": "DataSourceObject__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM822AF", "label": "Data Source Object", "name": "DataSourceObject__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksP2AR", "label": "Primary Object PK", "name": "PrimaryObjectPk__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8E2AV", "label": "UniqueId", "name": "uniqueid__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksQ2AR", "label": "NumOfEmployees", "name": "numofemployees__c", "namespace": "", "relationshipPath": [] }, "modelField": { "id": "0xnSB000000CtLhYAK", "label": "NumOfEmployees", "name": "numofemployees__c", "namespace": "" } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SR4x6YAD", "label": "cschoett-predict-job1", "name": "cschoett_predict_job1__dlm", "namespace": "" }, "id": "0gYSB00006XxksT2AR", "label": "Key Qualifier Primary Object PK", "name": "KQ_PrimaryObjectPk__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "cschoett-big-query-1", "name": "cschoett_big_query_1__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Key Qualifier UniqueId", "name": "KQ_uniqueid__c", "namespace": "", "relationshipPath": [] } } ] }, "scoringMode": "Batch", "type": "Regression", "url": "/services/data/v66.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD" }, { "activationStatus": "Active", "createdBy": { "id": "005SB00000eyXenYAE", "name": "EDC Admin", "profilePhotoUrl": "https://lovi-may2025-cdptest1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "createdDate": "2026-05-28T20:58:00.000Z", "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "id": "106SB00000IZyADYA1", "inputConfig": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "textFields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U192AF", "label": "Work Life Balance", "name": "Work_Life_Balance__c", "namespace": "", "relationshipPath": [] }, "updateScore": false }, { "mappedField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U1I2AV", "label": "Job Satisfaction", "name": "Job_Satisfaction__c", "namespace": "", "relationshipPath": [] }, "updateScore": false } ] }, "label": "cschoett-sentiment-attr1", "lastModifiedBy": { "id": "005SB00000eyY1NYAU", "name": "Automated Process", "profilePhotoUrl": "https://lovi-may2025-cdptest1.test1.file.pc-rnd.force.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-01T19:20:17.000Z", "lastRunDate": "2026-06-01T19:20:15.000Z", "lastRunStatus": "Success", "model": { "name": "sfdc_ai__DefaultSalesforceSentimentAnalysis" }, "name": "cschoett_sentiment_attr1", "namespace": "", "outputConfig": { "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "cschoett-sentitment-attr", "name": "cschoett_sentitment_attr__dlm", "namespace": "" }, "id": "0gYSB00006cWRYw2AO", "label": "Primary Object PK", "name": "PrimaryObjectPk__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U132AF", "label": "Employee Number", "name": "Employee_Number__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "cschoett-sentitment-attr", "name": "cschoett_sentitment_attr__dlm", "namespace": "" }, "id": "0gYSB00006cWRYu2AO", "label": "Data Source Object", "name": "DataSourceObject__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Data Source Object", "name": "DataSourceObject__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "cschoett-sentitment-attr", "name": "cschoett_sentitment_attr__dlm", "namespace": "" }, "id": "0gYSB00006cWRYq2AO", "label": "Internal Organization", "name": "InternalOrganization__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U172AF", "label": "Internal Organization", "name": "InternalOrganization__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "cschoett-sentitment-attr", "name": "cschoett_sentitment_attr__dlm", "namespace": "" }, "id": "0gYSB00006cWRYs2AO", "label": "Data Source", "name": "DataSource__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U1E2AV", "label": "Data Source", "name": "DataSource__c", "namespace": "", "relationshipPath": [] } }, { "mappedField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "cschoett-sentitment-attr", "name": "cschoett_sentitment_attr__dlm", "namespace": "" }, "id": "0gYSB00006cWRYx2AO", "label": "Key Qualifier Primary Object PK", "name": "KQ_PrimaryObjectPk__c", "namespace": "", "relationshipPath": [] }, "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Attrition", "name": "Attrition__dlm", "namespace": "" }, "id": "0gYSB00006W3U1S2AV", "label": "Key Qualifier Employee Number", "name": "KQ_Employee_Number__c", "namespace": "", "relationshipPath": [] } } ] }, "scoringMode": "Batch", "type": "SentimentDetection", "url": "/services/data/v66.0/ssot/machine-learning/prediction-job-definitions/106SB00000IZyADYA1" } ], "totalSize": 2, "url": "/services/data/v66.0/ssot/machine-learning/prediction-job-definitions" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### POST Create a prediction job definition `POST /ssot/machine-learning/prediction-job-definitions` Tags: Machine Learning. Create a new prediction job definition. **Available Version:** 59.0 #### Request body Media type: `application/json`. Schema: `MlPredictionJobDefBaseInputRepresentation`. _Example: Binary request_ ``` { "type": "BinaryClassification", "label": "Binary Classification Job", "description": "Binary classification prediction job", "model": { "id": "12lSB000000UWdZYAW" }, "outputConfig": { "objectName": "Customer_Segments", "description": "Output description" }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD" }, "fields": [ { "modelField": { "id": "0xmSB0000008UovYAE" }, "mappedField": { "id": "0gYSB00006XqM852AF", "dataObject": { "id": "0gjSB00000SQccbYAD" }, "relationshipPath": [ { "sourceField": { "id": "0gYSB00006XqM8F2AV", "dataObject": { "id": "0gjSB00000SQccbYAD" } }, "targetField": { "id": "0gYSB00006W3U0t2AF", "dataObject": { "id": "0gjSB00000SJ2xFYAT" } } } ] }, "updateScore": true } ] }, "binaryClassificationSettings": { "maxTopContributors": 3, "maxPrescriptions": 3, "prescriptionThreshold": 22, "showClassProbabilities": true } } ``` _Example: Clustering request_ ``` { "type": "Clustering", "label": "Clustering Prediction Job", "description": "Clustering prediction job for segmentation", "model": { "id": "12lSB000000UWdZYAW" }, "outputConfig": { "objectName": "Customer_Segments", "description": "Output description" }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD" }, "fields": [ { "modelField": { "id": "0xmSB0000008UovYAE" }, "mappedField": { "id": "0gYSB00006XqM852AF", "dataObject": { "id": "0gjSB00000SQccbYAD" }, "relationshipPath": [ { "sourceField": { "id": "0gYSB00006XqM8F2AV", "dataObject": { "id": "0gjSB00000SQccbYAD" } }, "targetField": { "id": "0gYSB00006W3U0t2AF", "dataObject": { "id": "0gjSB00000SJ2xFYAT" } } } ] }, "updateScore": true } ] }, "clusteringSettings": { "clusterIdFieldLabel": "Cluster ID", "clusterLabelFieldLabel": "Cluster Label", "maxTopContributors": 3 } } ``` _Example: Multiclass request_ ``` { "type": "MulticlassClassification", "label": "Multiclass Classification Job", "description": "Multiclass classification prediction job", "multiclassClassificationSettings": { "maxTopContributors": 3, "numberOfClasses": 4 }, "model": { "id": "12lSB000000UccXYAS" }, "outputConfig": { "objectName": "Product_Category_Predictions", "description": "Output description" }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "fields": [ { "modelField": { "id": "0xmSB0000008WM5YAM" }, "mappedField": { "id": "0gYSB00006W3U0r2AF", "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "relationshipPath": [ { "sourceField": { "id": "0gYSB00006W3U132AF", "dataObject": { "id": "0gjSB00000SJ2xFYAT" } }, "targetField": { "id": "0gYSB00006W3U0t2AF", "dataObject": { "id": "0gjSB00000SklF7YAJ" } } } ] }, "updateScore": true } ] } } ``` _Example: Sentiment request_ ``` { "type": "SentimentDetection", "inputConfig": { "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "textFields": [ { "mappedField": { "id": "0gYSB00006W3U192AF", "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "relationshipPath": [ { "sourceField": { "id": "0gYSB00006W3U1S2AV", "dataObject": { "id": "0gjSB00000SJ2xFYAT" } }, "targetField": { "id": "0gYSB00006cWRYw2AO", "dataObject": { "id": "0gjSB00000SklF7YAJ" } } } ] }, "updateScore": false } ] } } ``` _Example: Topic request_ ``` { "type": "TopicClassification", "inputConfig": { "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "textFields": [ { "mappedField": { "id": "0gYSB00006W3U1I2AV", "dataObject": { "id": "0gjSB00000SJ2xFYAT" }, "relationshipPath": [ { "sourceField": { "id": "0gYSB00006W3U1S2AV", "dataObject": { "id": "0gjSB00000SJ2xFYAT" } }, "targetField": { "id": "0gYSB00006cWRYw2AO", "dataObject": { "id": "0gjSB00000SklF7YAJ" } } } ] }, "updateScore": false } ], "topicLabels": { "type": "Static", "values": [ "Technology", "Business", "Healthcare", "Education" ] } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlPredictionJobDefBaseRepresentation`. _Example: Binary response_ ``` { "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "type": "BinaryClassification", "label": "Binary Classification Job", "name": "customer_prediction_job", "id": "106SB00000IR6i5YAD", "description": "Binary classification prediction job", "model": { "id": "12lSB000000UWdZYAW", "label": "Customer Churn Prediction Model", "name": "customer_churn_prediction_model", "url": "/services/data/67.0/ssot/machine-learning/configured-models/12lSB000000UWdZYAW" }, "outputConfig": { "dataObject": { "label": "Prediction_Results", "name": "Prediction_Results" }, "fields": [] }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "id": "0gYSB00006XqM852AF", "label": "Total_Purchase_Amount", "name": "Total_Purchase_Amount__c", "namespace": "", "relationshipPath": [ { "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Account", "name": "Account__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Account_Id", "name": "Account_Id__c", "namespace": "" }, "targetField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "Contact", "name": "Contact__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Contact_Id", "name": "Contact_Id__c", "namespace": "" } } ] }, "modelField": { "id": "0xmSB0000008UovYAE", "label": "Annual Revenue", "name": "annual_revenue__c", "namespace": "" }, "updateScore": true } ] }, "url": "/services/data/67.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD", "binaryClassificationSettings": { "maxTopContributors": 3, "maxPrescriptions": 3, "prescriptionThreshold": 22, "showClassProbabilities": true }, "namespace": "" } ``` _Example: Clustering response_ ``` { "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "type": "Clustering", "label": "Clustering Prediction Job", "name": "customer_prediction_job", "id": "106SB00000IR6i5YAD", "description": "Clustering prediction job for segmentation", "model": { "id": "12lSB000000UWdZYAW", "label": "Customer Churn Prediction Model", "name": "customer_churn_prediction_model", "url": "/services/data/67.0/ssot/machine-learning/configured-models/12lSB000000UWdZYAW" }, "outputConfig": { "dataObject": { "label": "Prediction_Results", "name": "Prediction_Results" }, "fields": [] }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "id": "0gYSB00006XqM852AF", "label": "Total_Purchase_Amount", "name": "Total_Purchase_Amount__c", "namespace": "", "relationshipPath": [ { "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Account", "name": "Account__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Account_Id", "name": "Account_Id__c", "namespace": "" }, "targetField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "Contact", "name": "Contact__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Contact_Id", "name": "Contact_Id__c", "namespace": "" } } ] }, "modelField": { "id": "0xmSB0000008UovYAE", "label": "Annual Revenue", "name": "annual_revenue__c", "namespace": "" }, "updateScore": true } ] }, "url": "/services/data/67.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD", "clusteringSettings": { "clusterIdFieldLabel": "Cluster ID", "clusterLabelFieldLabel": "Cluster Label", "maxTopContributors": 3 }, "namespace": "" } ``` _Example: Multiclass response_ ``` { "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "type": "MulticlassClassification", "label": "Multiclass Classification Job", "description": "Multiclass classification prediction job", "multiclassClassificationSettings": { "maxTopContributors": 3, "numberOfClasses": 4 }, "name": "customer_prediction_job", "id": "106SB00000IR6i5YAD", "model": { "id": "12lSB000000UWdZYAW", "label": "Customer Churn Prediction Model", "name": "customer_churn_prediction_model", "url": "/services/data/67.0/ssot/machine-learning/configured-models/12lSB000000UWdZYAW" }, "outputConfig": { "dataObject": { "label": "Prediction_Results", "name": "Prediction_Results" }, "fields": [] }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "fields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "id": "0gYSB00006XqM852AF", "label": "Total_Purchase_Amount", "name": "Total_Purchase_Amount__c", "namespace": "", "relationshipPath": [ { "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Account", "name": "Account__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Account_Id", "name": "Account_Id__c", "namespace": "" }, "targetField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "Contact", "name": "Contact__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Contact_Id", "name": "Contact_Id__c", "namespace": "" } } ] }, "modelField": { "id": "0xmSB0000008UovYAE", "label": "Annual Revenue", "name": "annual_revenue__c", "namespace": "" }, "updateScore": true } ] }, "url": "/services/data/67.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD", "namespace": "" } ``` _Example: Sentiment response_ ``` { "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "type": "SentimentDetection", "label": "Sentiment Detection Job", "name": "customer_prediction_job", "id": "106SB00000IR6i5YAD", "description": "Sentiment detection prediction job", "model": { "name": "sfdc_ai__DefaultSalesforceSentimentAnalysis" }, "outputConfig": { "dataObject": { "label": "Prediction_Results", "name": "Prediction_Results" }, "fields": [] }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "textFields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "id": "0gYSB00006W3U192AF", "label": "Customer_Feedback", "name": "Customer_Feedback__c", "namespace": "", "relationshipPath": [ { "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Account", "name": "Account__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Account_Id", "name": "Account_Id__c", "namespace": "" }, "targetField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "Contact", "name": "Contact__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Contact_Id", "name": "Contact_Id__c", "namespace": "" } } ] }, "updateScore": false } ] }, "url": "/services/data/67.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD", "namespace": "" } ``` _Example: Topic response_ ``` { "dataSpace": { "id": "0wSSB000002L2FN2A0", "label": "default", "name": "default" }, "type": "TopicClassification", "label": "Topic Classification Job", "name": "customer_prediction_job", "id": "106SB00000IR6i5YAD", "description": "Topic classification prediction job", "model": { "name": "sfdc_ai__DefaultSalesforceTopicClassification" }, "outputConfig": { "dataObject": { "label": "Prediction_Results", "name": "Prediction_Results" }, "fields": [] }, "scoringMode": "Batch", "inputConfig": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "textFields": [ { "mappedField": { "dataObject": { "id": "0gjSB00000SQccbYAD", "label": "Customer_Data", "name": "Customer_Data__dlm", "namespace": "" }, "id": "0gYSB00006XqM852AF", "label": "Total_Purchase_Amount", "name": "Total_Purchase_Amount__c", "namespace": "", "relationshipPath": [ { "sourceField": { "dataObject": { "id": "0gjSB00000SJ2xFYAT", "label": "Account", "name": "Account__dlm", "namespace": "" }, "id": "0gYSB00006XqM8F2AV", "label": "Account_Id", "name": "Account_Id__c", "namespace": "" }, "targetField": { "dataObject": { "id": "0gjSB00000SklF7YAJ", "label": "Contact", "name": "Contact__dlm", "namespace": "" }, "id": "0gYSB00006W3U0t2AF", "label": "Contact_Id", "name": "Contact_Id__c", "namespace": "" } } ] }, "updateScore": true } ], "topicLabels": { "type": "Static", "values": [ "Technology", "Business", "Healthcare", "Education" ] } }, "url": "/services/data/67.0/ssot/machine-learning/prediction-job-definitions/106SB00000IR6i5YAD", "namespace": "" } ``` * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get a prediction job definition `GET /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` Tags: Machine Learning. Get a specific prediction job definition. **Available Version:** 59.0 #### Parameters * `predictionJobDefIdOrName` (path, string, required) ID or API name of the prediction job definition. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlPredictionJobDefBaseRepresentation`. _Example Binary response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Clustering response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Multiclass response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Sentiment response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Topic response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### DELETE Delete a prediction job definition `DELETE /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` Tags: Machine Learning. Delete a specific prediction job definition. **Available Version:** 59.0 #### Parameters * `predictionJobDefIdOrName` (path, string, required) ID or API name of the prediction job definition. **Available Version:** 59.0 #### Responses * **200** Success * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### PATCH Update a prediction job definition `PATCH /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}` Tags: Machine Learning. Update a specific prediction job definition. **Available Version:** 59.0 #### Parameters * `predictionJobDefIdOrName` (path, string, required) ID or API name of the prediction job definition. **Available Version:** 59.0 #### Request body Media type: `application/json`. Schema: `MlPredictionJobDefBaseInputRepresentation`. _Example: example1_ ``` { "label": "cschoett-pattr-2", "inputConfig": { "dataObject": { "name": "titanic_cschoett_v11csv__dlm" }, "fields": [ { "mappedField": { "dataObject": { "name": "titanic_cschoett_v11csv__dlm" }, "name": "age__c", "relationshipPath": [] }, "modelField": { "name": "Age__c" }, "updateScore": false }, { "mappedField": { "dataObject": { "name": "titanic_cschoett_v11csv__dlm" }, "name": "fare__c", "relationshipPath": [] }, "modelField": { "name": "Monthly_Rate__c" }, "updateScore": false } ] }, "scoringMode": "Batch", "binaryClassificationSettings": { "maxTopContributors": 0, "maxPrescriptions": 0, "showClassProbabilities": false }, "type": "BinaryClassification" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlPredictionJobDefBaseRepresentation`. _Example Binary response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Clustering response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Multiclass response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Sentiment response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ _Example Topic response: same as POST /ssot/machine-learning/prediction-job-definitions 200 response._ * **400** Bad request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. ### GET Get retrievers `GET /ssot/machine-learning/retrievers` Tags: Machine Learning. Get a paginated list of retrievers. Out-of-the-box retrievers are returned first. **Available Version:** 61.0 #### Parameters * `dataCloudOneVisibility` (query, string) Filter retrievers by visibility across organizations in Data Cloud One. **Available Version:** 61.0 Allowed values: `All`, `Consumable`, `Local`, `Remote`. * `detailLevel` (query, string) Response detail level. If unspecified, the default value is `Detailed`. **Available Version:** 61.0 Allowed values: `Basic`, `Detailed`. * `isActive` (query, boolean) Indicates whether to return only active retrievers (`true`) or not (`false`). **Available Version:** 61.0 * `isDefault` (query, boolean) Indicates whether to return only default retrievers (`true`) or not (`false`). **Available Version:** 61.0 * `limit` (query, integer) Maximum number of retrievers to return. Values are from `1` through `200`. `-1` is no limit. If unspecified, `25` retrievers are returned. **Available Version:** 61.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 61.0 * `queryType` (query, array of string) Filter by query type. **Available Version:** 61.0 Items: Allowed values: `CustomSql`, `Ensemble`, `NoCode`. * `search` (query, string) Search keyword to match against label or API name. **Available Version:** 61.0 * `sortBy` (query, array of string) Field to sort results by. If unspecified, items are returned in `CreatedDate DESC` order. **Available Version:** 61.0 Items: Allowed values: `CreatedDate`, `DataSourceType`, `Label`, `LastModifiedBy`, `LastModifiedDate`, `OwnerType`, `QueryType`, `Status`. * `sortOrder` (query, array of string) Sort order. If unspecified, the default value is `Ascending`. **Available Version:** 61.0 Items: Allowed values: `Ascending`, `Descending`. * `sourceDmo` (query, string) Filter by source data model object (DMO) ID or API name. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverCollectionRepresentation`. _Example: example1_ ``` { "currentPageUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers?detailLevel=Basic&limit=25&offset=0&search=CustomSql%20retriever%20for%20ADL%20knowledge", "retrievers": [ { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:12:13.000Z", "id": "1Cyxx0000004Ck8CAE", "isActive": true, "isCitationEnabled": true, "label": "CustomSql retriever for ADL knowledge.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:12:15.000Z", "name": "CustomSql_retriever_for_ADL_knowledge_1Cy_tGW0f744801", "numberOfResults": 5, "retrievalMode": "Basic", "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU/configurations/1Cyxx0000004Ck8CAE", "version": 1 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:12:11.000Z", "dataSourceType": "DataCloudAsset", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "CustomSql retriever matching ADL knowledge internally created retriever.", "id": "1Cxxx0000004CaSCAU", "isDefault": false, "isVirtual": false, "label": "CustomSql retriever for ADL knowledge.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:12:16.000Z", "name": "CustomSql_retriever_for_ADL_knowledge_1Cx_tGW0563cdc2", "ownerType": "Customer", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "CustomSql", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU" } ], "totalSize": 1 } ``` * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Create retriever `POST /ssot/machine-learning/retrievers` Tags: Machine Learning. Create a retriever to query and retrieve data from Data 360 objects or search indexes. See [AI Retrievers Overview](https://help.salesforce.com/s/articleView?id=data.c360_a_ai_retriever.htm&type=5) for more information about retrievers. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlRetrieverInputRepresentation`. _Example: NoCode request_ ``` { "label": "Enriched Search Index UDMO Retriever", "description": "A NoCode retriever from a search index with enriched index configured. The search index source DMO is unstructured for a document file.", "ownerType": "Api", "dataSpaces": [ "default" ], "configuration": { "queryType": "NoCode", "isActive": true, "input": { "name": "Enriched_UDMO", "type": "SearchIndexConfiguration" }, "queryFilter": { "conjunctiveOperator": "Custom", "criteria": [ { "field": { "name": "FilePath__c" }, "operator": "EqualTo", "values": [ { "value": "{!$File_Path}", "type": "Placeholder" } ] }, { "field": { "name": "ChunkProcessingType__c" }, "operator": "EqualTo", "values": [ { "value": "PLAIN", "type": "Constant" } ] } ], "customBooleanExpression": "{!$0} AND {!$1}" }, "outputFields": [ { "label": "Chunk", "relatedDmoName": "Enriched_UDMO_chunk__dlm", "relatedDmoFieldName": "Chunk__c", "relationships": [ { "relationSourceDmoName": "Enriched_UDMO_chunk__dlm", "relationSourceDmoFieldName": "SourceRecordId__c", "relationTargetDmoName": "RagFileUDMO__dlm", "relationTargetDmoFieldName": "FilePath__c" } ] }, { "label": "File Path", "relatedDmoName": "Enriched_UDMO_index__dlm", "relatedDmoFieldName": "FilePath__c", "relationships": [ { "relationSourceDmoName": "Enriched_UDMO_index__dlm", "relationSourceDmoFieldName": "SourceRecordId__c", "relationTargetDmoName": "Enriched_UDMO_chunk__dlm", "relationTargetDmoFieldName": "RecordId__c" }, { "relationSourceDmoName": "Enriched_UDMO_chunk__dlm", "relationSourceDmoFieldName": "SourceRecordId__c", "relationTargetDmoName": "RagFileUDMO__dlm", "relationTargetDmoFieldName": "FilePath__c" } ] }, { "label": "AI Grounding File Reference Name", "relatedDmoName": "AiGroundingFileRefCustom__dlm", "relatedDmoFieldName": "Name__c", "relationships": [ { "relationSourceDmoName": "AiGroundingFileRefCustom__dlm", "relationSourceDmoFieldName": "FilePath__c", "relationTargetDmoName": "RagFileUDMO__dlm", "relationTargetDmoFieldName": "FilePath__c" } ] }, { "label": "Content Type", "relatedDmoName": "RagFileUDMO__dlm", "relatedDmoFieldName": "ContentType__c", "relationships": [] } ], "retrievalMode": "Advanced", "citationConfiguration": { "type": "Default" }, "isCitationEnabled": true } } ``` _Example: Custom SQL request_ ``` { "label": "CustomSql retriever for ADL knowledge.", "description": "CustomSql retriever matching ADL knowledge internally created retriever.", "ownerType": "AiAgent", "dataSpaces": [ "default" ], "configuration": { "queryType": "CustomSql", "isActive": true, "numberOfResults": 5, "isCitationEnabled": true, "isCitationSupported": true, "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "retrieverQueryTemplate": "SELECT\n \"v\".\"hybrid_score__c\" AS \"Score\",\n \"c\".\"Chunk__c\" AS \"Chunk\",\n \"c\".\"SourceRecordId__c\" AS \"SourceRecordId\",\n \"c\".\"RecordId__c\" AS \"RecordId\",\n \"c\".\"DataSource__c\" AS \"DataSource\",\n \"c\".\"DataSourceObject__c\" AS \"DataSourceObject\"\nFROM\n hybrid_search(\n TABLE(\"KA_kav_index__dlm\"),\n :\"UserQuery\",\n 'Language__c = :\"Language\" AND KnowledgePublicationStatus__c = ''Online'' AND DataSource__c IN (''Answer_c__c'',''Question_c__c'',''ssot__Description__c'',''Detail_c__c'')',\n :\"NumOfResults\"\n ) AS \"v\"\n INNER JOIN \"KA_kav_chunk__dlm\" AS \"c\" ON \"c\".\"RecordId__c\" = \"v\".\"RecordId__c\"\n INNER JOIN \"ssot__KnowledgeArticleVersion__dlm\" AS \"kav\" ON \"c\".\"SourceRecordId__c\" = \"kav\".\"ssot__Id__c\"\nORDER BY \"Score\" DESC\n LIMIT :\"NumOfResults", "searchOverallScoreColumnName": "Score", "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": ":\"UserQuery\"", "placeholderDescription": "UserQuery" }, { "placeholderDataType": "Number", "placeholderName": ":\"NumOfResults\"", "placeholderValue": "10", "placeholderDescription": "NumOfResults" }, { "placeholderDataType": "Text", "placeholderName": ":\"Language\"", "placeholderValue": "en_US", "placeholderDescription": "Language" } ], "queryCitationDefinition": { "citationType": "Default", "sourceObjectApiName": "ssot__KnowledgeArticleVersion__dlm", "sourceRecordIdColumnName": "SourceRecordId", "customLabelColumnName": "SourceRecordId" } } } } ``` _Example: Ensemble request_ ``` { "label": "Ensemble retriever", "description": "Ensemble retriever referencing 2 NoCode retrievers.", "ownerType": "Api", "configuration": { "queryType": "Ensemble", "referencedRetrievers": [ { "name": "File_UDMO_retriever_1Cx_tGW8e28c6ed" }, { "id": "1Cxxx0000004CFUCA2" } ], "outputFields": [ "File Path", "Chunk" ], "numberOfResults": 20, "retrievalMode": "Basic", "isCitationEnabled": true } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverRepresentation`. _Example: NoCode response_ ``` { "activeConfiguration": { "citationConfiguration": { "type": "Default" }, "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2026-06-03T22:38:42.000Z", "dataSpace": { "label": "default", "name": "default" }, "fieldPlaceholders": [ { "field": { "id": "0gYSB000037ZzzX2AS", "label": "Pre-filter: AiGroundingFileRefCustom__dlm.File Path Equal", "name": "FilePath__c" }, "fieldDataType": "Text", "placeholderName": "{!$File_Path}" } ], "id": "1CySB000000DUY90AO", "input": { "id": "18lSB0000007RczYAE", "label": "Enriched UDMO" }, "isActive": true, "isCitationEnabled": true, "label": "Enriched Search Index UDMO Retriever", "lastModifiedBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-03T22:38:50.000Z", "name": "Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55", "numberOfResults": 20, "outputFields": [ { "id": "1CzSB000000CU5Z0AW", "label": "Chunk", "name": "Chunk", "relatedDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9O2AR", "label": "Chunk", "name": "Chunk__c" }, "relationshipPathId": "0xjSB000000BuGbYAK", "relationships": [ { "id": "0xjSB000000BuGbYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f0_r0", "relationSourceDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9R2AR", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5a0AG", "label": "File Path", "name": "File_Path", "relatedDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9z2AB", "label": "File Path", "name": "FilePath__c" }, "relationshipPathId": "0xjSB000000BuGcYAK", "relationships": [ { "id": "0xjSB000000BuGcYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f1_r0", "relationSourceDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9x2AB", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationTargetDmoField": { "id": "0gYSB00003Gqh9S2AR", "label": "Record Id", "name": "RecordId__c" } }, { "id": "0xjSB000000BuGdYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f1_r1", "parentRelationshipId": "0xjSB000000BuGcYAK", "relationSourceDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9R2AR", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5b0AG", "label": "AI Grounding File Reference Name", "name": "AI_Grounding_File_Reference_Name", "relatedDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzR2AS", "label": "AI Grounding File Reference Name", "name": "Name__c" }, "relationshipPathId": "0xjSB000000BuGeYAK", "relationships": [ { "id": "0xjSB000000BuGeYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f2_r0", "relationSourceDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relationSourceDmoField": { "id": "0gYSB000037ZzzX2AS", "label": "File Path", "name": "FilePath__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5c0AG", "label": "Content Type", "name": "Content_Type", "relatedDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzD2AS", "label": "Content Type", "name": "ContentType__c" }, "relationships": [] } ], "queryFilter": { "conjunctiveOperator": "Custom", "criteria": [ { "field": { "id": "17iSB000005ScAkYAK", "name": "FilePathVectorEmbedding1", "relatedDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzX2AS", "label": "File Path", "name": "FilePath__c" }, "relationshipPathId": "0xjSB0000007gSMYAY", "subtype": "Retriever" }, "operator": "EqualTo", "type": "SemanticSearchVectorEmbedRelatedField", "values": [ { "type": "Placeholder", "value": "{!$File_Path}" } ] }, { "field": { "id": "17iSB000005ScAtYAK", "name": "ChunkProcessingTypeVectorEmbedding10", "relatedDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9q2AB", "label": "Chunk Processing Type", "name": "ChunkProcessingType__c" }, "subtype": "Retriever" }, "operator": "EqualTo", "type": "SemanticSearchVectorEmbedRelatedField", "values": [ { "type": "Constant", "value": "PLAIN" } ] } ], "customBooleanExpression": "{!$0} AND {!$1}" }, "referencedRetrievers": [], "retrievalMode": "Advanced", "searchIndexConfiguration": { "id": "18FSB000000mMPd2AM", "label": "Enriched UDMO", "name": "Enriched_UDMO" }, "semanticSearchType": "Vector", "sourceDmo": { "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-06-20T16:11:06.000Z", "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2025-06-20T16:11:22.000Z", "name": "RagFileUDMO__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1CxSB000000HBS50AO/configurations/1CySB000000DUY90AO", "vectorDmo": { "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-07-08T17:17:01.000Z", "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2025-07-08T17:17:43.000Z", "name": "Enriched_UDMO_index__dlm" }, "version": 1 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1CxSB000000HBS50AO/configurations", "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2026-06-03T22:38:40.000Z", "dataSourceType": "SearchIndex", "dataSpaces": [ { "id": "0vhSB000002E2iLYAS", "label": "default", "name": "default" } ], "description": "A NoCode retriever from a search index with enriched index configured. The search index source DMO is unstructured for a document file.", "id": "1CxSB000000HBS50AO", "isDefault": false, "isVirtual": false, "label": "Enriched Search Index UDMO Retriever", "lastModifiedBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-03T22:38:48.000Z", "latestConfiguration": { "citationConfiguration": { "type": "Default" }, "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2026-06-03T22:38:42.000Z", "dataSpace": { "label": "default", "name": "default" }, "fieldPlaceholders": [ { "field": { "id": "0gYSB000037ZzzX2AS", "label": "Pre-filter: AiGroundingFileRefCustom__dlm.File Path Equal", "name": "FilePath__c" }, "fieldDataType": "Text", "placeholderName": "{!$File_Path}" } ], "id": "1CySB000000DUY90AO", "input": { "id": "18lSB0000007RczYAE", "label": "Enriched UDMO" }, "isActive": true, "isCitationEnabled": true, "label": "Enriched Search Index UDMO Retriever", "lastModifiedBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-03T22:38:50.000Z", "name": "Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55", "numberOfResults": 20, "outputFields": [ { "id": "1CzSB000000CU5Z0AW", "label": "Chunk", "name": "Chunk", "relatedDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9O2AR", "label": "Chunk", "name": "Chunk__c" }, "relationshipPathId": "0xjSB000000BuGbYAK", "relationships": [ { "id": "0xjSB000000BuGbYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f0_r0", "relationSourceDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9R2AR", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5a0AG", "label": "File Path", "name": "File_Path", "relatedDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9z2AB", "label": "File Path", "name": "FilePath__c" }, "relationshipPathId": "0xjSB000000BuGcYAK", "relationships": [ { "id": "0xjSB000000BuGcYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f1_r0", "relationSourceDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9x2AB", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationTargetDmoField": { "id": "0gYSB00003Gqh9S2AR", "label": "Record Id", "name": "RecordId__c" } }, { "id": "0xjSB000000BuGdYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f1_r1", "parentRelationshipId": "0xjSB000000BuGcYAK", "relationSourceDmo": { "id": "0gjSB00000EMC0rYAH", "label": "Enriched UDMO chunk", "name": "Enriched_UDMO_chunk__dlm" }, "relationSourceDmoField": { "id": "0gYSB00003Gqh9R2AR", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5b0AG", "label": "AI Grounding File Reference Name", "name": "AI_Grounding_File_Reference_Name", "relatedDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzR2AS", "label": "AI Grounding File Reference Name", "name": "Name__c" }, "relationshipPathId": "0xjSB000000BuGeYAK", "relationships": [ { "id": "0xjSB000000BuGeYAK", "name": "rtvrCfg_Enriched_Search_Index_UDMO_Retriever_1Cy_tE0f4db4a55_f2_r0", "relationSourceDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relationSourceDmoField": { "id": "0gYSB000037ZzzX2AS", "label": "File Path", "name": "FilePath__c" }, "relationTargetDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037Zzz72AC", "label": "File Path", "name": "FilePath__c" } } ] }, { "id": "1CzSB000000CU5c0AG", "label": "Content Type", "name": "Content_Type", "relatedDmo": { "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "name": "RagFileUDMO__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzD2AS", "label": "Content Type", "name": "ContentType__c" }, "relationships": [] } ], "queryFilter": { "conjunctiveOperator": "Custom", "criteria": [ { "field": { "id": "17iSB000005ScAkYAK", "name": "FilePathVectorEmbedding1", "relatedDmo": { "id": "0gjSB00000DiPRSYA3", "label": "AiGroundingFileRefCustom__dlm", "name": "AiGroundingFileRefCustom__dlm" }, "relatedDmoField": { "id": "0gYSB000037ZzzX2AS", "label": "File Path", "name": "FilePath__c" }, "relationshipPathId": "0xjSB0000007gSMYAY", "subtype": "Retriever" }, "operator": "EqualTo", "type": "SemanticSearchVectorEmbedRelatedField", "values": [ { "type": "Placeholder", "value": "{!$File_Path}" } ] }, { "field": { "id": "17iSB000005ScAtYAK", "name": "ChunkProcessingTypeVectorEmbedding10", "relatedDmo": { "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "name": "Enriched_UDMO_index__dlm" }, "relatedDmoField": { "id": "0gYSB00003Gqh9q2AB", "label": "Chunk Processing Type", "name": "ChunkProcessingType__c" }, "subtype": "Retriever" }, "operator": "EqualTo", "type": "SemanticSearchVectorEmbedRelatedField", "values": [ { "type": "Constant", "value": "PLAIN" } ] } ], "customBooleanExpression": "{!$0} AND {!$1}" }, "referencedRetrievers": [], "retrievalMode": "Advanced", "searchIndexConfiguration": { "id": "18FSB000000mMPd2AM", "label": "Enriched UDMO", "name": "Enriched_UDMO" }, "semanticSearchType": "Vector", "sourceDmo": { "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-06-20T16:11:06.000Z", "id": "0gjSB00000DiPRRYA3", "label": "RagFileUDMO", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2025-06-20T16:11:22.000Z", "name": "RagFileUDMO__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1CxSB000000HBS50AO/configurations/1CySB000000DUY90AO", "vectorDmo": { "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-07-08T17:17:01.000Z", "id": "0gjSB00000EMC0tYAH", "label": "Enriched UDMO index", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2025-07-08T17:17:43.000Z", "name": "Enriched_UDMO_index__dlm" }, "version": 1 }, "name": "Enriched_Search_Index_UDMO_Retriever_1Cx_tE0e0d848ca", "ownerType": "Api", "ownership": { "id": "00DSB00000WctE02AJ", "label": "EPIC OrgFarm HOME", "name": "EPIC OrgFarm HOME" }, "queryType": "NoCode", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1CxSB000000HBS50AO" } ``` _Example: Custom SQL response_ ``` { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:12:13.000Z", "fieldPlaceholders": [], "id": "1Cyxx0000004Ck8CAE", "isActive": true, "isAdvancedModeSupported": false, "isCitationEnabled": true, "isCitationSupported": true, "isEnrichedIndexSupported": false, "label": "CustomSql retriever for ADL knowledge.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:12:15.000Z", "name": "CustomSql_retriever_for_ADL_knowledge_1Cy_tGW0f744801", "numberOfResults": 5, "outputFields": [ { "label": "Score", "name": "Score", "relationships": [] }, { "label": "Chunk", "name": "Chunk", "relationships": [] }, { "label": "SourceRecordId", "name": "SourceRecordId", "relationships": [] }, { "label": "RecordId", "name": "RecordId", "relationships": [] }, { "label": "DataSource", "name": "DataSource", "relationships": [] }, { "label": "DataSourceObject", "name": "DataSourceObject", "relationships": [] } ], "referencedRetrievers": [], "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "dataCloudAssets": [ { "assetApiName": "ssot__KnowledgeArticleVersion__dlm", "assetType": "DataModelObject" } ], "queryCitationDefinition": { "citationType": "Default", "customLabelColumnName": "SourceRecordId", "sourceObjectApiName": "ssot__KnowledgeArticleVersion__dlm", "sourceRecordIdColumnName": "SourceRecordId" }, "queryTemplate": "SELECT\n "v"."hybrid_score__c" AS "Score",\n "c"."Chunk__c" AS "Chunk",\n "c"."SourceRecordId__c" AS "SourceRecordId",\n "c"."RecordId__c" AS "RecordId",\n "c"."DataSource__c" AS "DataSource",\n "c"."DataSourceObject__c" AS "DataSourceObject"\nFROM\n hybrid_search(\n TABLE("KA_kav_index__dlm"),\n :"UserQuery",\n 'Language__c = :"Language" AND KnowledgePublicationStatus__c = ''Online'' AND DataSource__c IN (''Answer_c__c'',''Question_c__c'',''ssot__Description__c'',''Detail_c__c'')',\n :"NumOfResults"\n ) AS "v"\n INNER JOIN "KA_kav_chunk__dlm" AS "c" ON "c"."RecordId__c" = "v"."RecordId__c"\n INNER JOIN "ssot__KnowledgeArticleVersion__dlm" AS "kav" ON "c"."SourceRecordId__c" = "kav"."ssot__Id__c"\nORDER BY "Score" DESC\n LIMIT :"NumOfResults"", "queryTemplateMetadata": { "selectColumns": [ { "fieldAlias": "Score", "fieldName": "Score" }, { "fieldAlias": "Chunk", "fieldName": "Chunk" }, { "fieldAlias": "SourceRecordId", "fieldName": "SourceRecordId" }, { "fieldAlias": "RecordId", "fieldName": "RecordId" }, { "fieldAlias": "DataSource", "fieldName": "DataSource" }, { "fieldAlias": "DataSourceObject", "fieldName": "DataSourceObject" } ] }, "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": ":\"UserQuery\"", "placeholderType": "NamedParameter", "placeholderDescription": "UserQuery" }, { "placeholderDataType": "Number", "placeholderName": ":\"NumOfResults\"", "placeholderType": "NamedParameter", "placeholderValue": "10", "placeholderDescription": "NumOfResults" }, { "placeholderDataType": "Text", "placeholderName": ":\"Language\"", "placeholderType": "NamedParameter", "placeholderValue": "en_US", "placeholderDescription": "Language" } ], "queryTemplateVersionNumber": "V3PARAM", "searchOverallScoreColumnName": "Score" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU/configurations/1Cyxx0000004Ck8CAE", "version": 1 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:12:11.000Z", "dataSourceType": "DataCloudAsset", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "CustomSql retriever matching ADL knowledge internally created retriever.", "id": "1Cxxx0000004CaSCAU", "isDefault": false, "isVirtual": false, "label": "CustomSql retriever for ADL knowledge.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:12:16.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:12:13.000Z", "fieldPlaceholders": [], "id": "1Cyxx0000004Ck8CAE", "isActive": true, "isAdvancedModeSupported": false, "isCitationEnabled": true, "isCitationSupported": true, "isEnrichedIndexSupported": false, "label": "CustomSql retriever for ADL knowledge.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:12:15.000Z", "name": "CustomSql_retriever_for_ADL_knowledge_1Cy_tGW0f744801", "numberOfResults": 5, "outputFields": [ { "label": "Score", "name": "Score", "relationships": [] }, { "label": "Chunk", "name": "Chunk", "relationships": [] }, { "label": "SourceRecordId", "name": "SourceRecordId", "relationships": [] }, { "label": "RecordId", "name": "RecordId", "relationships": [] }, { "label": "DataSource", "name": "DataSource", "relationships": [] }, { "label": "DataSourceObject", "name": "DataSourceObject", "relationships": [] } ], "referencedRetrievers": [], "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "dataCloudAssets": [ { "assetApiName": "ssot__KnowledgeArticleVersion__dlm", "assetType": "DataModelObject" } ], "queryCitationDefinition": { "citationType": "Default", "customLabelColumnName": "SourceRecordId", "sourceObjectApiName": "ssot__KnowledgeArticleVersion__dlm", "sourceRecordIdColumnName": "SourceRecordId" }, "queryTemplate": "SELECT\n "v"."hybrid_score__c" AS "Score",\n "c"."Chunk__c" AS "Chunk",\n "c"."SourceRecordId__c" AS "SourceRecordId",\n "c"."RecordId__c" AS "RecordId",\n "c"."DataSource__c" AS "DataSource",\n "c"."DataSourceObject__c" AS "DataSourceObject"\nFROM\n hybrid_search(\n TABLE("KA_kav_index__dlm"),\n :"UserQuery",\n 'Language__c = :"Language" AND KnowledgePublicationStatus__c = ''Online'' AND DataSource__c IN (''Answer_c__c'',''Question_c__c'',''ssot__Description__c'',''Detail_c__c'')',\n :"NumOfResults"\n ) AS "v"\n INNER JOIN "KA_kav_chunk__dlm" AS "c" ON "c"."RecordId__c" = "v"."RecordId__c"\n INNER JOIN "ssot__KnowledgeArticleVersion__dlm" AS "kav" ON "c"."SourceRecordId__c" = "kav"."ssot__Id__c"\nORDER BY "Score" DESC\n LIMIT :"NumOfResults"", "queryTemplateMetadata": { "selectColumns": [ { "fieldAlias": "Score", "fieldName": "Score" }, { "fieldAlias": "Chunk", "fieldName": "Chunk" }, { "fieldAlias": "SourceRecordId", "fieldName": "SourceRecordId" }, { "fieldAlias": "RecordId", "fieldName": "RecordId" }, { "fieldAlias": "DataSource", "fieldName": "DataSource" }, { "fieldAlias": "DataSourceObject", "fieldName": "DataSourceObject" } ] }, "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": ":\"UserQuery\"", "placeholderType": "NamedParameter", "placeholderDescription": "UserQuery" }, { "placeholderDataType": "Number", "placeholderName": ":\"NumOfResults\"", "placeholderType": "NamedParameter", "placeholderValue": "10", "placeholderDescription": "NumOfResults" }, { "placeholderDataType": "Text", "placeholderName": ":\"Language\"", "placeholderType": "NamedParameter", "placeholderValue": "en_US", "placeholderDescription": "Language" } ], "queryTemplateVersionNumber": "V3PARAM", "searchOverallScoreColumnName": "Score" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU/configurations/1Cyxx0000004Ck8CAE", "version": 1 }, "name": "CustomSql_retriever_for_ADL_knowledge_1Cx_tGW0563cdc2", "ownerType": "AiAgent", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "CustomSql", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CaSCAU" } ``` _Example: Ensemble response_ ``` { "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CXECA2/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:53:11.000Z", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "Ensemble retriever referencing 2 NoCode retrievers.", "id": "1Cxxx0000004CXECA2", "isDefault": false, "isVirtual": false, "label": "Ensemble retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:53:11.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:53:13.000Z", "fieldPlaceholders": [], "id": "1Cyxx0000004CdgCAE", "isActive": false, "isCitationEnabled": true, "label": "Ensemble retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:53:20.000Z", "name": "Ensemble_retriever_1Cy_tGW54491ff5", "numberOfResults": 20, "outputFields": [ { "id": "1Czxx0000004CLwCAM", "label": "File Path", "name": "File_Path", "relationships": [] }, { "id": "1Czxx0000004CLxCAM", "label": "Chunk", "name": "Chunk", "relationships": [] } ], "referencedRetrievers": [ { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:50.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004CaSCAU", "input": { "id": "18lxx0000004CAeAAM", "label": "ADL_file_test" }, "isActive": true, "isCitationEnabled": true, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:48:59.000Z", "name": "File_UDMO_retriever_1Cy_tGW92e0548f", "numberOfResults": 5, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004CAeEAM", "label": "ADL_file_test", "name": "ADL_file_test" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:11:42.000Z", "id": "0gjxx000000018zAAA", "label": "ADL_file_test", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:22.000Z", "name": "ADL_file_test__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations/1Cyxx0000004CaSCAU", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:13:03.000Z", "id": "0gjxx00000001AcAAI", "label": "ADL_file_test index", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:15:52.000Z", "name": "ADL_file_test_index__dlm" }, "version": 1 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:46.000Z", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "NoCode retriever from a search index with a source DMO ingested from a unstructured document file.", "id": "1Cxxx0000004CVcCAM", "isDefault": false, "isVirtual": false, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:49:19.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:50.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004CaSCAU", "input": { "id": "18lxx0000004CAeAAM", "label": "ADL_file_test" }, "isActive": true, "isCitationEnabled": true, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:48:59.000Z", "name": "File_UDMO_retriever_1Cy_tGW92e0548f", "numberOfResults": 5, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004CAeEAM", "label": "ADL_file_test", "name": "ADL_file_test" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:11:42.000Z", "id": "0gjxx000000018zAAA", "label": "ADL_file_test", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:22.000Z", "name": "ADL_file_test__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations/1Cyxx0000004CaSCAU", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:13:03.000Z", "id": "0gjxx00000001AcAAI", "label": "ADL_file_test index", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:15:52.000Z", "name": "ADL_file_test_index__dlm" }, "version": 1 }, "name": "File_UDMO_retriever_1Cx_tGW8e28c6ed", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "NoCode", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM" }, { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:50:46.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004Cc4CAE", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": true, "isCitationEnabled": true, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:50:59.000Z", "name": "Knowledge_article_NoCode_retriever_1Cy_tGW74226a5d", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004Cc4CAE", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 2 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-28T00:07:11.000Z", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "NoCode retriever using a search index from knowledge article version DMO.", "id": "1Cxxx0000004CFUCA2", "isDefault": false, "isVirtual": false, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:51:31.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:50:46.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004Cc4CAE", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": true, "isCitationEnabled": true, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:50:59.000Z", "name": "Knowledge_article_NoCode_retriever_1Cy_tGW74226a5d", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004Cc4CAE", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 2 }, "name": "knowledge_no_code_retriever_1Cx_tGW8aac95be", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "NoCode", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2" } ], "retrievalMode": "Basic", "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CXECA2/configurations/1Cyxx0000004CdgCAE", "version": 1 }, "name": "Ensemble_retriever_1Cx_tGW8a38dd03", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "ownerType": "Api", "queryType": "Ensemble", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CXECA2" } ``` * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Review retriever `POST /ssot/machine-learning/retrievers/actions/review` Tags: Machine Learning. Reviews a Custom SQL retriever input and returns findings with errors and suggestions. Use this endpoint to validate the SQL query before creating or updating the retriever configuration. **Available Version:** 67.0 #### Request body Media type: `application/json`. Schema: `MlRetrieverReviewInputRepresentation`. _Example: example1_ ``` { "retrieverInput": { "label": "CustomSql retriever for ADL knowledge.", "description": "CustomSql retriever matching ADL knowledge internally created retriever.", "ownerType": "Api", "dataSpaces": [ "default" ], "configuration": { "queryType": "CustomSql", "isActive": true, "numberOfResults": 5, "isCitationEnabled": false, "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "retrieverQueryTemplate": "SELECT\n \"v\".\"hybrid_score__c\" AS \"Score\",\n \"c\".\"Chunk__c\" AS \"Chunk\",\n \"c\".\"SourceRecordId__c\" AS \"SourceRecordId\",\n \"c\".\"RecordId__c\" AS \"RecordId\",\n \"c\".\"DataSource__c\" AS \"DataSource\",\n \"c\".\"DataSourceObject__c\" AS \"DataSourceObject\"\nFROM\n hybrid_search(\n TABLE(\"KA_kav_index__dlm\"),\n :\"SearchString\",\n 'Language__c = :\"Language\" AND KnowledgePublicationStatus__c = ''Online'' AND DataSource__c IN (''Answer_c__c'',''Question_c__c'',''ssot__Description__c'',''Detail_c__c'')',\n :\"NumOfResults\"\n ) AS \"v\"\n INNER JOIN \"KA_kav_chunk__dlm\" AS \"c\" ON \"c\".\"RecordId__c\" = \"v\".\"RecordId__c\"\n INNER JOIN \"ssot__KnowledgeArticleVersion__dlm\" AS \"kav\" ON \"c\".\"SourceRecordId__c\" = \"kav\".\"ssot__Id__c\"\nORDER BY \"Score\" DESC\n LIMIT :\"NumOfResults\"", "mainUserQueryParameterName": "NoMatchParamName", "searchOverallScoreColumnName": "Score", "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": ":\"SearchString\"", "placeholderDescription": "SearchString" }, { "placeholderDataType": "Number", "placeholderName": ":\"NumOfResults\"", "placeholderValue": "10", "placeholderDescription": "NumOfResults" }, { "placeholderDataType": "Text", "placeholderName": ":\"Language\"", "placeholderValue": "en_US", "placeholderDescription": "Language" } ] } } }, "existingRetrieverAsset": { "name": "knowledge_customsql_retriever_1Cx_tGW8aac9aec" } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverReviewRepresentation`. _Example: example1_ ``` { "extractedSelectColumns": [ { "fieldName": "Score", "type": "numeric" }, { "fieldName": "Chunk", "type": "varchar" }, { "fieldName": "SourceRecordId", "type": "varchar" }, { "fieldName": "RecordId", "type": "varchar" }, { "fieldName": "DataSource", "type": "varchar" }, { "fieldName": "DataSourceObject", "type": "varchar" } ], "findings": [ { "code": "MainUserQueryParamNotInTemplate", "fieldPath": "mainUserQueryParameterName", "message": "mainUserQueryParameterName :"NotFound" was not found in the query template.", "messageKey": "MainUserQueryParamNotInTemplate", "messageParams": [ ":"NoMatchParamName"" ], "severity": "Error" }, { "code": "ScoreColumnSuggestedForMonitoring", "fieldPath": "searchOverallScoreColumnName", "message": "Your query uses a search function. Consider specifying searchOverallScoreColumnName to enable search score performance monitoring.", "messageKey": "ScoreColumnSuggestedForMonitoring", "messageParams": [], "severity": "Info" }, { "code": "AdvancedModeSuggested", "fieldPath": "isAdvancedModeSupported", "message": "Your query uses a search function. If you'd like to use Advanced Retrieval mode, consider specifying isAdvancedModeSupported=true to enable.", "messageKey": "AdvancedModeSuggested", "messageParams": [], "severity": "Info" }, { "code": "CitationSuggested", "fieldPath": "isCitationSupported", "message": "Consider specifying isCitationSupported=true if you'd like to enable citation support.", "messageKey": "CitationSuggested", "messageParams": [], "severity": "Info" }, { "code": "EnrichedIndexSuggested", "fieldPath": "isEnrichedIndexSupported", "message": "Your query uses a search function. If the search function is using an enriched search index, consider specifying enrichedSearchIndexDefinition and isEnrichedIndexSupported=true to enable.", "messageKey": "EnrichedIndexSuggested", "messageParams": [], "severity": "Info" } ], "hasErrors": true } ``` * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get retriever `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}` Tags: Machine Learning. Get a retriever with its latest and active configurations. **Available Version:** 61.0 #### Parameters * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverRepresentation`. _Example NoCode response: same as POST /ssot/machine-learning/retrievers 200 response._ _Example Custom SQL response: same as POST /ssot/machine-learning/retrievers 200 response._ _Example Ensemble response: same as POST /ssot/machine-learning/retrievers 200 response._ * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### DELETE Delete retriever `DELETE /ssot/machine-learning/retrievers/{retrieverIdOrName}` Tags: Machine Learning. Delete a retriever and all its configuration versions. The retriever must not be used by other entities. **Available Version:** 61.0 #### Parameters * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Responses * **200** Success * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### PATCH Update retriever `PATCH /ssot/machine-learning/retrievers/{retrieverIdOrName}` Tags: Machine Learning. Update a retriever label or description. To change the retrieval behavior, create a new configuration version. **Available Version:** 61.0 #### Parameters * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlRetrieverUpdateInputRepresentation`. _Example: example1_ ``` { "label": "Enriched Search Index UDMO Retriever", "description": "A NoCode retriever from a search index with enriched index configured. The search index source DMO is unstructured for a document file." } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverRepresentation`. _Example NoCode response: same as POST /ssot/machine-learning/retrievers 200 response._ _Example Custom SQL response: same as POST /ssot/machine-learning/retrievers 200 response._ _Example Ensemble response: same as POST /ssot/machine-learning/retrievers 200 response._ * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get retriever configurations `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations` Tags: Machine Learning. Get all configuration versions for the retriever. **Available Version:** 61.0 #### Parameters * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 * `limit` (query, integer) Maximum number of configurations to return. Values are `1` through `200`. `-1` is no limit. If unspecified, `25` configurations are returned. **Available Version:** 61.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverConfigurationCollectionRepresentation`. _Example: example1_ ``` { "configurations": [ { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:50:46.000Z", "id": "1Cyxx0000004Cc4CAE", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": true, "isCitationEnabled": true, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:50:59.000Z", "name": "Knowledge_article_NoCode_retriever_1Cy_tGW74226a5d", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004Cc4CAE", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 2 }, { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-28T00:07:13.000Z", "id": "1Cyxx0000004CDsCAM", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": false, "isCitationEnabled": true, "label": "knowledge no code retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-05-28T00:07:28.000Z", "name": "knowledge_no_code_retriever_1Cy_tGW2725a89b", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004CDsCAM", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 1 } ], "currentPageUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations?limit=-1&offset=0", "totalSize": 2 } ``` * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### POST Create retriever configuration `POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations` Tags: Machine Learning. Create a new configuration version for the retriever. Set `isActive` to `true` to activate immediately. At most one configuration can be active at a time. The `NoCode` retriever type internally generates a Data 360 SQL query template from the configuration. The `CustomSql` retriever type uses a user-specified Data 360 SQL query template. The `Ensemble` retriever type combines results from multiple sub-retrievers with reranking. **Available Version:** 61.0 #### Parameters * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlRetrieverConfigurationBaseInputRepresentation`. _Example: NoCode request_ ``` { "queryType": "NoCode", "input": { "id": "18lSB0000007HDpYAM", "type": "SearchIndex" }, "queryFilter": { "conjunctiveOperator": "And", "criteria": [ { "field": { "id": "17iSB000005LtQ2YAK" }, "operator": "EqualTo", "values": [ { "value": "{!$Language}", "type": "Placeholder" } ] } ] }, "numberOfResults": 10, "outputFields": [ { "label": "Chunk", "relatedDmoName": "KA_KA_ADL_chunk__dlm", "relatedDmoFieldName": "Chunk__c", "relationships": [ { "relationSourceDmoName": "KA_KA_ADL_chunk__dlm", "relationSourceDmoFieldName": "SourceRecordId__c", "relationTargetDmoName": "ssot__KnowledgeArticleVersion__dlm", "relationTargetDmoFieldName": "ssot__Id__c" } ] }, { "label": "Name", "relatedDmoName": "ssot__KnowledgeArticleVersion__dlm", "relatedDmoFieldName": "ssot__Name__c", "relationships": [] } ], "retrievalMode": "Basic", "citationConfiguration": { "type": "Custom", "baseUrl": "https://my-test-domain.com", "mappedLabelField": { "relatedDmoName": "ssot__KnowledgeArticleVersion__dlm", "relatedDmoFieldName": "ssot__Name__c" }, "mappedUrlField": { "relatedDmoName": "ssot__KnowledgeArticleVersion__dlm", "relatedDmoFieldName": "ssot__URL__c" } }, "isCitationEnabled": true } ``` _Example: Custom SQL request_ ``` { "queryType": "CustomSql", "isActive": true, "numberOfResults": 5, "isCitationEnabled": true, "isAdvancedModeSupported": true, "isCitationSupported": true, "isEnrichedIndexSupported": true, "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "retrieverQueryTemplate": "SELECT\n \"v\".\"score__c\" AS \"Score\",\n \"c\".\"Chunk__c\",\n \"c\".\"RecordId__c\" AS \"ChunkRecordId\",\n \"s\".\"Content_ID__c\" AS \"Content_ID\",\n \"s\".\"DataSource__c\" AS \"SourceDmoDataSource\"\nFROM (\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''QUESTION'')', :\"numOfResults\")\n UNION\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''METADATA'')', :\"numOfResults\")\n UNION\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''PLAIN'')', :\"numOfResults\")\n ) AS \"v\"\n INNER JOIN \"HudmoSearchIndex_chunk__dlm\" AS \"c\" ON \"c\".\"RecordId__c\" = \"v\".\"RecordId__c\"\n INNER JOIN \"HudmoFile__dlm\" AS \"s\" ON \"c\".\"SourceRecordId__c\" = \"s\".\"ssot__Id__c\"\nORDER BY \"Score\" DESC\nLIMIT :\"limit\"", "mainUserQueryParameterName": ":\"userQuery\"", "searchOverallScoreColumnName": "Score", "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": ":\"userQuery\"", "placeholderDescription": "The user query to search." }, { "placeholderDataType": "Text", "placeholderName": ":\"prefilter1Name\"", "placeholderDescription": "The prefilter1Name to use in the search function prefilter" }, { "placeholderDataType": "Number", "placeholderName": ":\"numOfResults\"", "placeholderValue": "10", "placeholderDescription": "The number of results to use in the search function" }, { "placeholderDataType": "Number", "placeholderName": ":\"limit\"", "placeholderDescription": "Limit the number of SQL query results" } ], "enrichedSearchIndexDefinition": { "searchIndexApiName": "HudmoSearchIndex", "chunkColumnName": "Chunk__c", "chunkRecordIdColumnName": "ChunkRecordId" }, "queryCitationDefinition": { "citationType": "Default", "sourceObjectApiName": "HudmoFile__dlm", "sourceRecordIdColumnName": "Content_ID", "customLabelColumnName": "SourceDmoDataSource", "chunkObjectApiName": "HudmoSearchIndex_chunk__dlm", "chunkRecordIdColumnName": "ChunkRecordId" } } } ``` _Example: Ensemble request_ ``` { "queryType": "Ensemble", "numberOfResults": 5, "retrievalMode": "Basic", "referencedRetrievers": [ { "name": "File_UDMO_retriever_1Cx_tGW8e28c6ed" }, { "id": "1Cxxx0000004CFUCA2" } ], "outputFields": [ "Chunk", "Article Number" ], "isCitationEnabled": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverConfigurationDetailRepresentation`. _Example: NoCode response_ ``` { "citationConfiguration": { "baseUrl": "https://my-test-domain.com", "mappedLabelField": { "label": "ssot__Name__c", "name": "ssot_Name_c", "relatedDmo": { "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "name": "ssot__KnowledgeArticleVersion__dlm" }, "relatedDmoField": { "id": "0gYSB000037BiIM2A0", "label": "Name", "name": "ssot__Name__c" } }, "mappedUrlField": { "label": "ssot__URL__c", "name": "ssot_URL_c", "relatedDmo": { "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "name": "ssot__KnowledgeArticleVersion__dlm" }, "relatedDmoField": { "id": "0gYSB000037BiIQ2A0", "label": "URL", "name": "ssot__URL__c" } }, "type": "Custom" }, "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2026-06-03T23:00:03.000Z", "dataSpace": { "label": "default", "name": "default" }, "fieldPlaceholders": [ { "field": { "id": "0gYSB000037BiIJ2A0", "label": "Pre-filter: Knowledge Article Version.Language Equal", "name": "ssot__Language__c", "namespace": "ssot" }, "fieldDataType": "Text", "placeholderName": "{!$Language}" } ], "id": "1CySB000000DUZl0AO", "input": { "id": "18lSB0000007HDpYAM", "label": "KA_KA_ADL" }, "isActive": false, "isCitationEnabled": true, "label": "NoCode retriever custom citation", "lastModifiedBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2026-06-03T23:00:12.000Z", "name": "NoCode_retriever_custom_citation_1Cy_tE0b0095ed9", "numberOfResults": 10, "outputFields": [ { "id": "1CzSB000000CU7B0AW", "label": "Chunk", "name": "Chunk", "relatedDmo": { "id": "0gjSB00000DiMOmYAN", "label": "KA_KA_ADL_chunk__dlm", "name": "KA_KA_ADL_chunk__dlm" }, "relatedDmoField": { "id": "0gYSB000037Z6902AC", "label": "Chunk", "name": "Chunk__c" }, "relationshipPathId": "0xjSB000000BuIDYA0", "relationships": [ { "id": "0xjSB000000BuIDYA0", "name": "rtvrCfg_NoCode_retriever_custom_citation_1Cy_tE0b0095ed9_f0_r0", "relationSourceDmo": { "id": "0gjSB00000DiMOmYAN", "label": "KA_KA_ADL_chunk__dlm", "name": "KA_KA_ADL_chunk__dlm" }, "relationSourceDmoField": { "id": "0gYSB000037Z6912AC", "label": "Source Record Id", "name": "SourceRecordId__c" }, "relationTargetDmo": { "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "name": "ssot__KnowledgeArticleVersion__dlm" }, "relationTargetDmoField": { "id": "0gYSB000037BiI82AK", "label": "Knowledge Article Version Id", "name": "ssot__Id__c", "namespace": "ssot" } } ] }, { "id": "1CzSB000000CU7C0AW", "label": "Name", "name": "Name", "relatedDmo": { "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "name": "ssot__KnowledgeArticleVersion__dlm" }, "relatedDmoField": { "id": "0gYSB000037BiIM2A0", "label": "Name", "name": "ssot__Name__c", "namespace": "ssot" }, "relationships": [] } ], "queryFilter": { "conjunctiveOperator": "And", "criteria": [ { "field": { "id": "17iSB000005LtQ2YAK", "name": "Language", "relatedDmo": { "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "name": "ssot__KnowledgeArticleVersion__dlm" }, "relatedDmoField": { "id": "0gYSB000037BiIJ2A0", "label": "Language", "name": "ssot__Language__c" }, "subtype": "Retriever" }, "operator": "EqualTo", "type": "SemanticSearchVectorEmbedRelatedField", "values": [ { "type": "Placeholder", "value": "{!$Language}" } ] } ] }, "referencedRetrievers": [], "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "queryTemplate": "SELECT \"searchFunc\".\"vector_score__c\" AS \"vector_score__c\", \"searchFunc\".\"keyword_score__c\" AS \"keyword_score__c\", \"searchFunc\".\"hybrid_score__c\" AS \"hybrid_score__c\", \"KA_KA_ADL_chunk\".\"SourceRecordId__c\" AS \"ChunkDmoSourceRecordId\", \"KA_KA_ADL_chunk\".\"RecordId__c\" AS \"RecordId\", \"KA_KA_ADL_chunk\".\"Chunk__c\" AS \"Chunk\", \"KnowledgeArticleVersion\".\"ssot__Name__c\" AS \"Name\", \"KnowledgeArticleVersion\".\"ssot__Name__c\" AS \"MappedCitationLabel\", \"KnowledgeArticleVersion\".\"ssot__URL__c\" AS \"MappedCitationUrl\" FROM hybrid_search(TABLE(\"KA_KA_ADL_index__dlm\"), :\"_SEARCH_STRING\", :\"_PREFILTER_EXPRESSION\", :\"_NUM_OF_RESULTS\") AS \"searchFunc\" INNER JOIN \"KA_KA_ADL_chunk__dlm\" AS \"KA_KA_ADL_chunk\" ON \"KA_KA_ADL_chunk\".\"RecordId__c\" = \"searchFunc\".\"RecordId__c\" INNER JOIN \"ssot__KnowledgeArticleVersion__dlm\" AS \"KnowledgeArticleVersion\" ON \"KnowledgeArticleVersion\".\"ssot__Id__c\" = \"KA_KA_ADL_chunk\".\"SourceRecordId__c\" AND \"KnowledgeArticleVersion\".\"KQ_Id__c\" IS NOT DISTINCT FROM \"KA_KA_ADL_chunk\".\"KQ_SourceRecordId__c\" ORDER BY \"searchFunc\".\"hybrid_score__c\" DESC LIMIT {!$_NUM_OF_RESULTS}", "queryTemplateMetadata": { "selectColumns": [ { "fieldAlias": "vector_score__c", "fieldName": "vector_score__c", "tableAlias": "searchFunc", "tableName": "searchFunc" }, { "fieldAlias": "keyword_score__c", "fieldName": "keyword_score__c", "tableAlias": "searchFunc", "tableName": "searchFunc" }, { "fieldAlias": "hybrid_score__c", "fieldName": "hybrid_score__c", "tableAlias": "searchFunc", "tableName": "searchFunc" }, { "fieldAlias": "ChunkDmoSourceRecordId", "fieldName": "SourceRecordId__c", "tableAlias": "KA_KA_ADL_chunk", "tableName": "KA_KA_ADL_chunk__dlm" }, { "fieldAlias": "RecordId", "fieldName": "RecordId__c", "tableAlias": "KA_KA_ADL_chunk", "tableName": "KA_KA_ADL_chunk__dlm" }, { "fieldAlias": "Chunk", "fieldName": "Chunk__c", "tableAlias": "KA_KA_ADL_chunk", "tableName": "KA_KA_ADL_chunk__dlm" }, { "fieldAlias": "Name", "fieldName": "ssot__Name__c", "tableAlias": "KnowledgeArticleVersion", "tableName": "ssot__KnowledgeArticleVersion__dlm" }, { "fieldAlias": "MappedCitationLabel", "fieldName": "ssot__Name__c", "tableAlias": "KnowledgeArticleVersion", "tableName": "ssot__KnowledgeArticleVersion__dlm" }, { "fieldAlias": "MappedCitationUrl", "fieldName": "ssot__URL__c", "tableAlias": "KnowledgeArticleVersion", "tableName": "ssot__KnowledgeArticleVersion__dlm" } ] }, "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderName": "{!$Language}", "placeholderType": "Placeholder", "placeholderValue": "" }, { "placeholderDataType": "Text", "placeholderName": ":\"_PREFILTER_EXPRESSION\"", "placeholderType": "NamedParameter", "placeholderValue": "Language__c = '{!$Language}'" }, { "placeholderDataType": "Text", "placeholderName": ":\"_SEARCH_STRING\"", "placeholderType": "NamedParameter", "placeholderValue": "" }, { "placeholderDataType": "Number", "placeholderName": ":\"_NUM_OF_RESULTS\"", "placeholderType": "NamedParameter", "placeholderValue": "" }, { "placeholderDataType": "Number", "placeholderName": "{!$_NUM_OF_RESULTS}", "placeholderType": "Placeholder", "placeholderValue": "" } ], "queryTemplateVersionNumber": "V3PARAM" }, "searchIndexConfiguration": { "id": "18FSB000000lnlF2AQ", "label": "KA_KA_ADL", "name": "KA_KA_ADL" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-06-19T06:00:25.000Z", "id": "0gjSB00000DgfZMYAZ", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2026-04-22T21:18:25.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1CxSB0000009ma50AA/configurations/1CySB000000DUZl0AO", "vectorDmo": { "createdBy": { "id": "005SB00000OgKanYAF", "name": "OrgFarm EPIC", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "createdDate": "2025-06-20T14:59:41.000Z", "id": "0gjSB00000DiMOnYAN", "label": "KA_KA_ADL_index__dlm", "lastModifiedBy": { "id": "005SB00000OgKKgYAN", "name": "Automated Process", "profilePhotoUrl": "https://my-test-salesforce.com/profilephoto/005/T" }, "lastModifiedDate": "2025-06-20T15:00:08.000Z", "name": "KA_KA_ADL_index__dlm" }, "version": 5 } ``` _Example: Custom SQL response_ ``` { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T05:30:00.000Z", "fieldPlaceholders": [], "id": "1Cyxx0000004CHUDMO", "isActive": true, "isAdvancedModeSupported": true, "isCitationEnabled": true, "isCitationSupported": true, "isEnrichedIndexSupported": true, "label": "CustomSql retriever with enriched search index from harminized unstructured DMO.", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T05:30:05.000Z", "name": "HUDMO_file_CustomSql_retriever_1Cy_tGWa3b8c4f1", "numberOfResults": 5, "outputFields": [ { "label": "Score", "name": "Score", "relationships": [] }, { "label": "Chunk__c", "name": "Chunk__c", "relationships": [] }, { "label": "ChunkRecordId", "name": "ChunkRecordId", "relationships": [] }, { "label": "Content_ID", "name": "Content_ID", "relationships": [] }, { "label": "SourceDmoDataSource", "name": "SourceDmoDataSource", "relationships": [] } ], "referencedRetrievers": [], "retrievalMode": "Basic", "retrieverQueryTemplateDefinition": { "dataCloudAssets": [ { "assetApiName": "HudmoSearchIndex", "assetType": "SearchIndex" }, { "assetApiName": "HudmoFile__dlm", "assetType": "DataModelObject" }, { "assetApiName": "HudmoSearchIndex_chunk__dlm", "assetType": "DataModelObject" } ], "enrichedSearchIndexDefinition": { "searchIndexApiName": "HudmoSearchIndex", "chunkColumnName": "Chunk__c", "chunkRecordIdColumnName": "ChunkRecordId" }, "mainUserQueryParameterName": ":\"userQuery\"", "queryCitationDefinition": { "citationType": "Default", "chunkObjectApiName": "HudmoSearchIndex_chunk__dlm", "chunkRecordIdColumnName": "ChunkRecordId", "customLabelColumnName": "SourceDmoDataSource", "sourceObjectApiName": "HudmoFile__dlm", "sourceRecordIdColumnName": "Content_ID" }, "queryTemplate": "SELECT\n \"v\".\"score__c\" AS \"Score\",\n \"c\".\"Chunk__c\",\n \"c\".\"RecordId__c\" AS \"ChunkRecordId\",\n \"s\".\"Content_ID__c\" AS \"Content_ID\",\n \"s\".\"DataSource__c\" AS \"SourceDmoDataSource\"\nFROM (\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''QUESTION'')', :\"numOfResults\")\n UNION\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''METADATA'')', :\"numOfResults\")\n UNION\n SELECT * FROM vector_search(TABLE(\"HudmoSearchIndex_index__dlm\"), :\"userQuery\", '(DataSourceObject__c = :\"prefilter1Name\" AND ChunkProcessingType__c=''PLAIN'')', :\"numOfResults\")\n ) AS \"v\"\n INNER JOIN \"HudmoSearchIndex_chunk__dlm\" AS \"c\" ON \"c\".\"RecordId__c\" = \"v\".\"RecordId__c\"\n INNER JOIN \"HudmoFile__dlm\" AS \"s\" ON \"c\".\"SourceRecordId__c\" = \"s\".\"ssot__Id__c\"\nORDER BY \"Score\" DESC\nLIMIT :\"limit\"", "queryTemplateMetadata": { "selectColumns": [ { "fieldAlias": "Score", "fieldName": "Score" }, { "fieldAlias": "Chunk__c", "fieldName": "Chunk__c" }, { "fieldAlias": "ChunkRecordId", "fieldName": "ChunkRecordId" }, { "fieldAlias": "Content_ID", "fieldName": "Content_ID" }, { "fieldAlias": "SourceDmoDataSource", "fieldName": "SourceDmoDataSource" } ] }, "queryTemplatePlaceholders": [ { "placeholderDataType": "Text", "placeholderDescription": "The user query to search.", "placeholderName": ":\"userQuery\"", "placeholderType": "NamedParameter" }, { "placeholderDataType": "Text", "placeholderDescription": "The prefilter1Name to use in the search function prefilter", "placeholderName": ":\"prefilter1Name\"", "placeholderType": "NamedParameter" }, { "placeholderDataType": "Number", "placeholderDescription": "The number of results to use in the search function", "placeholderName": ":\"numOfResults\"", "placeholderType": "NamedParameter", "placeholderValue": "10" }, { "placeholderDataType": "Number", "placeholderDescription": "Limit the number of SQL query results", "placeholderName": ":\"limit\"", "placeholderType": "NamedParameter" } ], "queryTemplateVersionNumber": "V3PARAM", "searchOverallScoreColumnName": "Score" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CHUDMO/configurations/1Cyxx0000004CHUDMO", "version": 1 } ``` _Example: Ensemble response_ ``` { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T03:10:15.000Z", "fieldPlaceholders": [], "id": "1Cyxx0000004CguCAE", "isActive": false, "isCitationEnabled": true, "label": "Ensemble retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T03:10:20.000Z", "name": "Ensemble_retriever_1Cy_tGW7cca0056", "numberOfResults": 5, "outputFields": [ { "id": "1Czxx0000004CPACA2", "label": "Article Number", "name": "Article_Number", "relationships": [] }, { "id": "1Czxx0000004CPBCA2", "label": "Chunk", "name": "Chunk", "relationships": [] } ], "referencedRetrievers": [ { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:50.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004CaSCAU", "input": { "id": "18lxx0000004CAeAAM", "label": "ADL_file_test" }, "isActive": true, "isCitationEnabled": true, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:48:59.000Z", "name": "File_UDMO_retriever_1Cy_tGW92e0548f", "numberOfResults": 5, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004CAeEAM", "label": "ADL_file_test", "name": "ADL_file_test" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:11:42.000Z", "id": "0gjxx000000018zAAA", "label": "ADL_file_test", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:22.000Z", "name": "ADL_file_test__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations/1Cyxx0000004CaSCAU", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:13:03.000Z", "id": "0gjxx00000001AcAAI", "label": "ADL_file_test index", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:15:52.000Z", "name": "ADL_file_test_index__dlm" }, "version": 1 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:46.000Z", "dataSourceType": "SearchIndex", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "NoCode retriever from a search index with a source DMO ingested from a unstructured document file.", "id": "1Cxxx0000004CVcCAM", "isDefault": false, "isVirtual": false, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:49:19.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:48:50.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004CaSCAU", "input": { "id": "18lxx0000004CAeAAM", "label": "ADL_file_test" }, "isActive": true, "isCitationEnabled": true, "label": "File UDMO retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:48:59.000Z", "name": "File_UDMO_retriever_1Cy_tGW92e0548f", "numberOfResults": 5, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004CAeEAM", "label": "ADL_file_test", "name": "ADL_file_test" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:11:42.000Z", "id": "0gjxx000000018zAAA", "label": "ADL_file_test", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:22.000Z", "name": "ADL_file_test__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM/configurations/1Cyxx0000004CaSCAU", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:13:03.000Z", "id": "0gjxx00000001AcAAI", "label": "ADL_file_test index", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:15:52.000Z", "name": "ADL_file_test_index__dlm" }, "version": 1 }, "name": "File_UDMO_retriever_1Cx_tGW8e28c6ed", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "NoCode", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CVcCAM" }, { "activeConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:50:46.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004Cc4CAE", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": true, "isCitationEnabled": true, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:50:59.000Z", "name": "Knowledge_article_NoCode_retriever_1Cy_tGW74226a5d", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004Cc4CAE", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 2 }, "configurationsUrl": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations", "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-28T00:07:11.000Z", "dataSourceType": "SearchIndex", "dataSpaces": [ { "id": "0vhxx000000001dAAA", "label": "default", "name": "default" } ], "description": "NoCode retriever using a search index from knowledge article version DMO.", "id": "1Cxxx0000004CFUCA2", "isDefault": false, "isVirtual": false, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:51:31.000Z", "latestConfiguration": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-06-04T02:50:46.000Z", "dataSpace": { "label": "default", "name": "default" }, "id": "1Cyxx0000004Cc4CAE", "input": { "id": "18lxx0000004C92AAE", "label": "KA_kav" }, "isActive": true, "isCitationEnabled": true, "label": "Knowledge article NoCode retriever", "lastModifiedBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "lastModifiedDate": "2026-06-04T02:50:59.000Z", "name": "Knowledge_article_NoCode_retriever_1Cy_tGW74226a5d", "numberOfResults": 20, "retrievalMode": "Basic", "searchIndexConfiguration": { "id": "18Fxx0000004C92EAE", "label": "KA_kav", "name": "KA_kav" }, "semanticSearchType": "Hybrid", "sourceDmo": { "createdBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "createdDate": "2026-05-27T22:10:07.000Z", "id": "0gjxx00000000YvAAI", "label": "Knowledge Article Version", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:06:51.000Z", "name": "ssot__KnowledgeArticleVersion__dlm" }, "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2/configurations/1Cyxx0000004Cc4CAE", "vectorDmo": { "createdBy": { "id": "005xx000001X7oXAAS", "name": "OrgFarm EPIC" }, "createdDate": "2026-05-27T23:10:51.000Z", "id": "0gjxx000000017RAAQ", "label": "KA_kav_index__dlm", "lastModifiedBy": { "id": "005xx000001X7oYAAS", "name": "Automated Process" }, "lastModifiedDate": "2026-05-27T23:12:07.000Z", "name": "KA_kav_index__dlm" }, "version": 2 }, "name": "knowledge_no_code_retriever_1Cx_tGW8aac95be", "ownership": { "id": "00Dxx00oXlODtGWEI1", "label": "EPIC OrgFarm", "name": "EPIC OrgFarm" }, "queryType": "NoCode", "references": [], "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CFUCA2" } ], "retrievalMode": "Basic", "url": "https://my-test-salesforce.com/services/data/v67.0/ssot/machine-learning/retrievers/1Cxxx0000004CXECA2/configurations/1Cyxx0000004CguCAE", "version": 2 } ``` * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get retriever configuration `GET /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` Tags: Machine Learning. Get a retriever configuration. **Available Version:** 61.0 #### Parameters * `retrieverConfigurationIdOrName` (path, string, required) Record ID or API name of the configuration. **Available Version:** 61.0 * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverConfigurationDetailRepresentation`. _Example NoCode response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ _Example Custom SQL response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ _Example Ensemble response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### DELETE Delete retriever configuration `DELETE /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` Tags: Machine Learning. Delete a retriever configuration. **Available Version:** 61.0 #### Parameters * `retrieverConfigurationIdOrName` (path, string, required) Record ID or API name of the configuration. **Available Version:** 61.0 * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Responses * **200** Success * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### PATCH Update retriever configuration `PATCH /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}` Tags: Machine Learning. Update the configuration's active status. Setting `isActive` to `true` activates this configuration and deactivates any previously active configuration. Setting `isActive` to `false` on the currently active configuration deactivates the retriever. The retriever must not be used by other entities before deactivation. **Available Version:** 61.0 #### Parameters * `retrieverConfigurationIdOrName` (path, string, required) Record ID or API name of the configuration. **Available Version:** 61.0 * `retrieverIdOrName` (path, string, required) Record ID or API name of the retriever. **Available Version:** 61.0 #### Request body Media type: `application/json`. Schema: `MlRetrieverConfigurationUpdateInputRepresentation`. _Example: example1_ ``` { "isActive": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `MlRetrieverConfigurationDetailRepresentation`. _Example NoCode response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ _Example Custom SQL response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ _Example Ensemble response: same as POST /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations 200 response._ * **400** Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. * **401** The session ID or OAuth token has expired or is invalid. Or, if the request is made by a guest user, the resource isn't accessible to guest users. * **403** The request has been refused. Verify that the context user has the appropriate permissions to access the requested data, or that the context user is not an external user. * **404** The server can't find the requested resource. * **500** An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. ### GET Get metadata `GET /ssot/metadata` Tags: Metadata. Get all metadata, including Calculated Insights, Engagement, Profile, and other objects, as well as their relationships to other objects in Data 360. **Available Version:** 52.0 #### Parameters * `dataspace` (query, string) Name of the data space. If unspecified, the `default` data space is used. **Available Version:** 55.0 * `entityCategory` (query, string) Category of the metadata entity. Valid values are `Profile`, `Engagement`, and `Related`. If unspecified, all category entities are returned. **Available Version:** 54.0 * `entityName` (query, string) Metadata name of the entity, for example `UnifiedIndividual__dlm`. If unspecified, a complete list of entities is returned. **Available Version:** 54.0 * `entityType` (query, string) Type of metadata entity requested. Valid values are `DataLakeObject`, `DataModelObject`, and `CalculatedInsight`. If unspecified, all types are returned. **Available Version:** 54.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataOutputRepresentation`. _Example: Example_ ``` { "metadata": [ { "fields": [ { "name": "ssot__MailingAddressId__c", "displayName": "Mailing Address", "type": "STRING", "keyQualifier": "KQ_MailingAddressId__c", "businessType": "TEXT" }, { "name": "ssot__Title__c", "displayName": "Title", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__AccountId__c", "displayName": "Account", "type": "STRING", "keyQualifier": "KQ_AccountId__c", "businessType": "TEXT" }, { "name": "ssot__AssistantName__c", "displayName": "Assistant Name", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__AssistantPhone__c", "displayName": "Assistant Phone", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__CreatedDate__c", "displayName": "Created Date", "type": "DATE_TIME", "businessType": "DATE_TIME" }, { "name": "ssot__DataSourceId__c", "displayName": "Data Source", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__DataSourceObjectId__c", "displayName": "Data Source Object", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__DepartmentName__c", "displayName": "Department Name", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__Id__c", "displayName": "Account Contact Id", "type": "STRING", "keyQualifier": "KQ_Id__c", "businessType": "TEXT" }, { "name": "ssot__IndividualId__c", "displayName": "Individual", "type": "STRING", "keyQualifier": "KQ_IndividualId__c", "businessType": "TEXT" }, { "name": "KQ_Id__c", "displayName": "Key Qualifier Account Contact Id", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__LastActivityDate__c", "displayName": "Last Activity Date", "type": "DATE_TIME", "businessType": "DATE_TIME" }, { "name": "ssot__LastModifiedDate__c", "displayName": "Last Modified Date", "type": "DATE_TIME", "businessType": "DATE_TIME" }, { "name": "KQ_AccountId__c", "displayName": "Key Qualifier Account", "type": "STRING", "businessType": "TEXT" }, { "name": "KQ_ContactEmailId__c", "displayName": "Key Qualifier Contact Email", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__ContactEmailId__c", "displayName": "Contact Email", "type": "STRING", "keyQualifier": "KQ_ContactEmailId__c", "businessType": "TEXT" }, { "name": "KQ_BusinessPhoneId__c", "displayName": "Key Qualifier Business Phone", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__BusinessPhoneId__c", "displayName": "Business Phone", "type": "STRING", "keyQualifier": "KQ_BusinessPhoneId__c", "businessType": "TEXT" }, { "name": "KQ_MailingAddressId__c", "displayName": "Key Qualifier Mailing Address", "type": "STRING", "businessType": "TEXT" }, { "name": "KQ_IndividualId__c", "displayName": "Key Qualifier Individual", "type": "STRING", "businessType": "TEXT" } ], "indexes": [], "category": "Profile", "name": "ssot__AccountContact__dlm", "displayName": "Account Contact", "relationships": [ { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__ContactPointAddress__dlm", "fromEntityAttribute": "ssot__MailingAddressId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__Account__dlm", "fromEntityAttribute": "ssot__AccountId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__Account__dlm", "toEntity": "ssot__AccountContact__dlm", "fromEntityAttribute": "ssot__Id__c", "toEntityAttribute": "ssot__AccountId__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__Lead__dlm", "toEntity": "ssot__AccountContact__dlm", "fromEntityAttribute": "ssot__ConvertedToAccountContactId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__OpportunityContact__dlm", "toEntity": "ssot__AccountContact__dlm", "fromEntityAttribute": "ssot__AccountContactId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__Individual__dlm", "fromEntityAttribute": "ssot__IndividualId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__ContactPointEmail__dlm", "fromEntityAttribute": "ssot__ContactEmailId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__ContactPointPhone__dlm", "fromEntityAttribute": "ssot__BusinessPhoneId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" } ], "primaryKeys": [ { "name": "ssot__Id__c", "displayName": "Account Contact Id", "indexOrder": "1" } ], "referenceModelEntityDeveloperName": "AccountContact" }, { "name": "DailyPersonalizationUniques__cio", "displayName": "Daily Personalization Uniques", "dimensions": [ { "name": "RequestDate__c", "displayName": "RequestDate", "type": "DATE", "businessType": "DATE" } ], "measures": [ { "name": "NumUniqueIndividuals__c", "displayName": "NumUniqueIndividuals", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumRequests__c", "displayName": "NumRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumPersonalizationRequests__c", "displayName": "NumPersonalizationRequests", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumUniqueRecordTypes__c", "displayName": "NumUniqueRecordTypes", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" }, { "name": "NumUniqueRecords__c", "displayName": "NumUniqueRecords", "type": "NUMBER", "rollupable": false, "businessType": "NUMBER" } ], "relationships": [ { "fromEntity": "ssot__PersonalizationLog__dlm", "toEntity": "DailyPersonalizationUniques__cio" } ], "partitionBy": "RequestDate__c", "latestProcessTime": "1970-01-01T00:00:00.00000Z", "latestSuccessfulProcessTime": "1970-01-01T00:00:00.00000Z" } ] } ``` ### GET Get metadata entities `GET /ssot/metadata-entities` Tags: Metadata. Get a list of metadata entities. This endpoint provides a high-performance way to retrieve metadata for Data 360 entities. By returning only essential fields like name, type, and category, it allows you to efficiently view entities at scale. Request detailed field and relationship data only for the specific objects you need. **Available Version:** 66.0 #### Parameters * `dataspace` (query, string) Name of the data space in which the metadata is requested. **Available Version:** 66.0 * `entityCategory` (query, string) Category of the metadata entity. If unspecified, all categories are returned. Supported values are: * `Activation_Audience` * `CG_Audience` * `Content` * `Directory_Table` * `Engagement` * `Profile` * `Related` * `Segment_Membership` * `Vector_Embedding` **Available Version:** 66.0 * `entityType` (query, string) Type of metadata entity. If unspecified, all types are returned. Supported values are: * `CalculatedInsight` * `DataLakeObject` * `DataModelObject` **Available Version:** 66.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataEntitiesOutputRepresentation`. _Example: Example_ ``` { "done": false, "nextBatchId": "0abCD12345EFGHiJKL", "metadata": [ { "name": "promotionmeasurestest__dll", "displayName": "promotionmeasurestest", "type": "DataLakeObject", "category": "Related" }, { "name": "PR_commerce_accounts__dll", "displayName": "PR_commerce_accounts", "type": "DataLakeObject", "category": "Engagement" }, { "name": "commerce_accounts__dll", "displayName": "commerce_accounts", "type": "DataLakeObject", "category": "Profile" }, { "name": "PR_commerce_engagement__dll", "displayName": "PR_commerce_engagement", "type": "DataLakeObject", "category": "Engagement" }, { "name": "commerce_engagement__dll", "displayName": "commerce_engagement", "type": "DataLakeObject", "category": "Engagement" } ] } ``` * **400** Bad request. * **403** Forbidden. * **404** Metadata entities not found. ### GET Get private network routes `GET /ssot/private-network-routes` Tags: Private Network Routes. Get a paginated list of Private Network Routes. **Available Version:** 65.0 #### Parameters * `limit` (query, integer) Maximum number of rows to return from `1` through `1000`. By default, the endpoint returns `100` rows. **Available Version:** 65.0 * `offset` (query, integer) Number of rows to skip before returning results. By default, the endpoint skips `0` rows. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `PrivateNetworkRouteCollectionRepresentation`. * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. * **429** Too Many Requests. ### POST Create private network route `POST /ssot/private-network-routes` Tags: Private Network Routes. Create a Private Network Route for Amazon MSK, Redshift, or Snowflake connections. The route enables secure private network connectivity to external data sources. **Available Version:** 65.0 #### Request body Media type: `application/json`. Schema: `PrivateNetworkRouteInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `PrivateNetworkRouteCollectionRepresentation`. * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. * **409** A private network route with this connection URL already exists. A new connection can't be established. * **429** Too Many Requests. ### GET Get private network route `GET /ssot/private-network-routes/{routeIdOrName}` Tags: Private Network Routes. Get detailed information about a Private Network Route. **Available Version:** 65.0 #### Parameters * `routeIdOrName` (path, string, required) ID or name of the Private Network Route. **Available Version:** 65.0 #### Responses * **200** Success Media type: `application/json`. Schema: `PrivateNetworkRouteRepresentation`. * **308** Record Not Found Here. * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. * **429** Too Many Requests. ### DELETE Delete private network route `DELETE /ssot/private-network-routes/{routeIdOrName}` Tags: Private Network Routes. Delete a Private Network Route. **Available Version:** 65.0 #### Parameters * `routeIdOrName` (path, string, required) ID or name of the Private Network Route. **Available Version:** 65.0 #### Responses * **200** Success * **400** Bad Request. * **401** Unauthorized. * **403** Forbidden. * **404** Not Found. * **409** A private network route with this connection URL already exists. A new connection can't be established. * **429** Too Many Requests. ### GET Get profile metadata `GET /ssot/profile/metadata` Tags: Profile, Metadata. Get metadata for data model objects in the profile category, including Individual, Contact Point Email, Unified Individual, and Contact Point Address objects in Data 360. Metadata includes the objects, their fields, and their categories. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataOutputRepresentation`. _Example: Example_ ``` { "metadata": [ { "fields": [ { "name": "ssot__MailingAddressId__c", "displayName": "Mailing Address", "type": "STRING", "keyQualifier": "KQ_MailingAddressId__c", "businessType": "TEXT" }, { "name": "ssot__Title__c", "displayName": "Title", "type": "STRING", "businessType": "TEXT" }, { "name": "ssot__AccountId__c", "displayName": "Account", "type": "STRING", "keyQualifier": "KQ_AccountId__c", "businessType": "TEXT" }, { "name": "ssot__CreatedDate__c", "displayName": "Created Date", "type": "DATE_TIME", "businessType": "DATE_TIME" }, { "name": "ssot__Id__c", "displayName": "Account Contact Id", "type": "STRING", "keyQualifier": "KQ_Id__c", "businessType": "TEXT" }, { "name": "ssot__LastActivityDate__c", "displayName": "Last Activity Date", "type": "DATE_TIME", "businessType": "DATE_TIME" } ], "category": "Profile", "name": "ssot__AccountContact__dlm", "displayName": "Account Contact", "relationships": [ { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__ContactPointAddress__dlm", "fromEntityAttribute": "ssot__MailingAddressId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__AccountContact__dlm", "toEntity": "ssot__Account__dlm", "fromEntityAttribute": "ssot__AccountId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" } ], "primaryKeys": [ { "name": "ssot__Id__c", "displayName": "Account Contact Id", "indexOrder": "1" } ], "referenceModelEntityDeveloperName": "AccountContact" } ] } ``` ### GET Get profile data model object metadata `GET /ssot/profile/metadata/{dataModelName}` Tags: Profile, Metadata. Get metadata for a data model object (DMO) in the profile category, such as Individual, Contact Point Email, Unified Individual, and Contact Point Address in Data 360. Metadata includes the list of fields, data types, and indexes available for lookup. **Available Version:** 52.0 #### Parameters * `dataModelName` (path, string, required) Name of the data model object. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryMetadataOutputRepresentation`. _Example: Example_ ``` { "metadata": [ { "relationships": [ { "fromEntity": "ssot__Account__dlm", "toEntity": "ssot__ContactPointAddress__dlm", "fromEntityAttribute": "ssot__BillContactAddressId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__Account__dlm", "toEntity": "ssot__Individual__dlm", "fromEntityAttribute": "ssot__Id__c", "toEntityAttribute": "ssot__PrimaryAccountId__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__Account__dlm", "toEntity": "ssot__Account__dlm", "fromEntityAttribute": "ssot__Id__c", "toEntityAttribute": "ssot__ParentAccountId__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__Account__dlm", "toEntity": "ssot__AccountContact__dlm", "fromEntityAttribute": "ssot__Id__c", "toEntityAttribute": "ssot__AccountId__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__ContactPointEmail__dlm", "toEntity": "ssot__Account__dlm", "fromEntityAttribute": "ssot__PartyId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" }, { "fromEntity": "ssot__User__dlm", "toEntity": "ssot__Account__dlm", "fromEntityAttribute": "ssot__AccountId__c", "toEntityAttribute": "ssot__Id__c", "cardinality": "NTOONE" } ], "primaryKeys": [ { "name": "ssot__Id__c", "displayName": "Account Id", "indexOrder": "1" } ], "displayName": "Account", "name": "ssot__Account__dlm", "fields": [ { "name": "KQ_Id__c", "displayName": "Key Qualifier Account Id", "type": "STRING" }, { "name": "ssot__Id__c", "displayName": "Account Id", "type": "STRING", "keyQualifier": "KQ_Id__c" }, { "name": "ssot__Name__c", "displayName": "Account Name", "type": "STRING" } ], "category": "Profile", "referenceModelEntityDeveloperName": "Account" } ] } ``` ### GET Get profile data model object `GET /ssot/profile/{dataModelName}` Tags: Profile. Query a profile data model object using filters in Data 360. **Available Version:** 52.0 #### Parameters * `dataModelName` (path, string, required) Name of the data model object. **Available Version:** 52.0 * `batchSize` (query, integer) Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. **Available Version:** 52.0 * `fields` (query, string) Comma-separated list of up to 50 field names that you want to include in the result, for example, `Id__c,FirstName__c`, `GenderId__c,Occupation__c`. If unspecified, `Id__c` is returned. **Available Version:** 52.0 * `filters` (query, string, required) Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 52.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ { "ssot__AccountTypeId__c": "Prospect", "ssot__BillContactAddressId__c": "001SB00000okNZWYA2", "ssot__CreatedDate__c": "2025-01-25T10:00:02.000+00:00", "ssot__DataSourceId__c": "Salesforce_Home", "ssot__DataSourceObjectId__c": "Account", "ssot__Description__c": "Description of the account." } ], "done": true, "metadata": {} } ``` ### GET Get profile data model object with search key `GET /ssot/profile/{dataModelName}/{id}` Tags: Profile. Query a profile data model object using filters and a search key in Data 360. **Available Version:** 52.0 #### Parameters * `id` (path, string, required) ID of the data model object (value of the primary or secondary key field). **Available Version:** 52.0 * `dataModelName` (path, string, required) Name of the data model object. **Available Version:** 52.0 * `batchSize` (query, integer) Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. **Available Version:** 52. * `fields` (query, string) Comma-separated list of up to 50 field names that you want to include in the result, for example, `Id__c,FirstName__c`, `GenderId__c,Occupation__c`. If unspecified, `Id__c` is returned. **Available Version:** 52.0 * `filters` (query, string) Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 52.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 52.0 * `searchKey` (query, string) If a field other than the primary key is used, name of the key field, for example, `FirstName__c`. Parameter is required for secondary key. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ {} ], "done": false, "endTime": "", "metadata": { "//": {} }, "queryId": "", "rowCount": 0, "startTime": "" } ``` ### GET Get profile data model object and calculated insight with search key `GET /ssot/profile/{dataModelName}/{id}/calculated-insights/{ciName}` Tags: Profile. Query a profile data model object and a calculated insight object using filters and a search key in Data 360. **Available Version:** 52.0 #### Parameters * `ciName` (path, string, required) Name of the calculated insight object. **Available Version:** 52.0 * `dataModelName` (path, string, required) Name of the data model object. **Available Version:** 52.0 * `id` (path, string, required) ID of the data model object (value of the primary or secondary key field). **Available Version:** 52.0 * `batchSize` (query, integer) Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. **Available Version:** 52.0 * `dimensions` (query, string) Comma-separated list of up to 10 dimensions, such as `GenderId__c`, to project. If unspecified, this parameter returns all of the available dimensions. **Available Version:** 52.0 * `fields` (query, string) Comma-separated list of up to 50 field names that you want to include in the result, for example, `Id__c,FirstName__c`, `GenderId__c,Occupation__c`. If unspecified, `Id__c` is returned. **Available Version:** 52.0 * `filters` (query, string) Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. **Available Version:** 52.0 * `measures` (query, string) Comma-separated list of up to five measures, such as `TotalSales__c,` to project. If unspecified, this parameter returns all of the available measures. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 52.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 52.0 * `searchKey` (query, string) If a field other than the primary key is used, name of the key field, for example, `FirstName__c`. Parameter is required for secondary key. **Available Version:** 52.0 * `timeGranularity` (query, string) Time range for the measures. Values are: `HOUR`, `DAY`, `MONTH`, `QUARTER`, or `YEAR`. If unspecified, no time range is applied. **Available Version:** 54.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ {} ], "done": false, "endTime": "", "metadata": { "//": {} }, "queryId": "", "rowCount": 0, "startTime": "" } ``` ### GET Get profile data model object and child object with search key `GET /ssot/profile/{dataModelName}/{id}/{childDataModelName}` Tags: Profile. Query a profile data model object and a child object using filters and a search key in Data 360. **Available Version:** 52.0 #### Parameters * `childDataModelName` (path, string, required) Name of the child data model object. **Available Version:** 52.0 * `dataModelName` (path, string, required) Name of the data model object. **Available Version:** 52.0 * `id` (path, string, required) ID of the data model object (value of the primary or secondary key field). **Available Version:** 52.0 * `batchSize` (query, integer) Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. **Available Version:** 52.0 * `fields` (query, string) Comma-separated list of child object field names that you want to include in the result, for example, `Id__c,EmailAddress__c`. If unspecified, the first 10 alphabetically sorted fields are returned. **Available Version:** 52.0 * `filters` (query, string) Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. Filters are applied to the parent object only. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 52.0 * `orderby` (query, string) Sort order for the result set, such as `GenderId__c ASC,\u200BOccupation__c DESC`. If unspecified, items are returned in the order they are retrieved. **Available Version:** 52.0 * `searchKey` (query, string) If a field other than the primary key is used, name of the key field, for example, `FirstName__c`. Parameter is required for secondary key. **Available Version:** 52.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ {} ], "done": false, "endTime": "", "metadata": { "//": {} }, "queryId": "", "rowCount": 0, "startTime": "" } ``` ### POST Query data V1 `POST /ssot/query` Tags: Query V1 & V2. Synchronously query data across data model, lake, unified, and linked objects in Data 360. This query returns up to 49,999 rows. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Important:** A new Query API version is available. We recommend exploring the latest version for enhanced capabilities and improved performance. For more information, see the [submit SQL query](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=createSqlQuery) endpoint. **Available Version:** 52.0 **Root XML tag:** `` #### Parameters * `batchSize` (query, integer) Number of records to return. Values are from `1` through `49999`. If unspecified, the default value is `49999`. **Available Version:** 52.0 * `dataspace` (query, string) Name of the data space. **Available Version:** 52.0 * `offset` (query, integer) Number of rows to skip before returning results. The sum of `offset` and `batchSize` must be less than `2147483647`. The default value is `0`. **Available Version:** 52.0 * `orderby` (query, string) Comma-separated values to sort the results in ascending or descending order, for example, `GenderId__c ASC,Occupation__c DESC`. **Available Version:** 52.0 #### Request body (required) Media type: `application/json`. Schema: `CdpQueryInputRepresentation`. _Example: Example_ ``` { "sql": "select BirthDate__c, DataSourceId__c, DataSourceObjectId__c, ExternalRecordId__c, FirstName__c, GenderId__c, Id__c, InternalOrganizationId__c, LastName__c from Individual__dlm where Id__c='100470169'" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputRepresentation`. _Example: Example_ ``` { "data": [ {} ], "done": false, "endTime": "", "metadata": { "//": {} }, "queryId": "", "rowCount": 0, "startTime": "" } ``` ### POST Query data V2 `POST /ssot/queryv2` Tags: Query V1 & V2. Query up to 8 MB of data across data model, lake, unified, and linked objects in Data 360. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Important:** A new Query API version is available. We recommend exploring the latest version for enhanced capabilities and improved performance. For more information, see the [submit SQL query](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=createSqlQuery) endpoint. **Available Version:** 54.0 **Root XML tag:** `` #### Parameters * `dataspace` (query, string) Name of the data space. **Available Version:** 54.0 #### Request body (required) Media type: `application/json`. Schema: `CdpQueryInputRepresentation`. _Example Example: same as POST /ssot/query request._ #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputV2Representation`. ### GET Query batch data V1 `GET /ssot/queryv2/{nextBatchId}` Tags: Query V1 & V2. Get the next batch of data across data model, lake, unified, and linked objects in Data 360. Initially, use the Data 360 Query V2 resource to query up to 8 MB of data. Use the `nextBatchId` from the Data 360 Query Output V2 response body as the value of _nextBatchId_ in this API to get the next batch of data. You can continue using subsequent next batch IDs for up to an hour. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Important:** A new Query API version is available. We recommend exploring the latest version for enhanced capabilities and improved performance. For more information, see the [submit SQL query](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=createSqlQuery) endpoint. **Available Version:** 54.0 #### Parameters * `nextBatchId` (path, string, required) ID from the Data 360 Query Output V2 response body. **Available Version:** 54.0 * `dataspace` (query, string) Name of the data space. **Available Version:** 54.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryOutputV2Representation`. ### POST Submit SQL query `POST /ssot/query-sql` Tags: Query (Current). Submit a SQL query request for execution and retrieve the metadata and first chunk of data. This endpoint combines and enhances the features of the previous query v1 and v2 endpoints, providing a more robust and versatile solution for interacting with Data 360. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Important:** Ensure application compatibility with both synchronous and asynchronous queries. To retrieve results from an asynchronous query, poll the [get SQL query status](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getSqlQuery) endpoint with the _queryId_ until the status is `Finished`. > **Note:** Refer to the [Data 360 Query Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/query-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 63.0 #### Parameters * `dataspace` (query, string) Name of the data space to query. If unspecified, the `default` data space is used. **Available Version:** 63.0 * `workloadName` (query, string) Description of the scenario that your query is used in. The workload name is added to the log files to help when debugging. **Available Version:** 63.0 #### Request body (required) Media type: `application/json`. Schema: `QuerySqlInputRepresentation`. _Example: Simple request_ ``` { "sql": "select * from Flight__dll", "rowLimit": 2 } ``` _Example: Request with SQL parameters_ ``` { "sql": "select * from FlightSeat__dll where \"boardingstatus__c\"=:myparam", "rowLimit": 2, "sqlParameters": [ { "type": "varchar", "name": "myparam", "value": "Boarded" } ] } ``` _Example: Request with querySettings_ ``` { "querySettings": { "date_style": "MDY", "lc_time": "en_US", "query_timeout": "1800000ms" }, "sql": "SELECT * FROM Case_Home__dll LIMIT 10" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `QuerySqlRepresentation`. _Example: Simple response_ ``` { "data": [ [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Airbus A320", "BOM", "2024-06-10T08:00:00+00:00", "DEL", "2024-06-10T06:00:00+00:00", 1, "AI101", null ], [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Boeing 737", "BLR", "2024-06-10T11:00:00+00:00", "BOM", "2024-06-10T09:00:00+00:00", 2, "AI102", null ] ], "metadata": [ { "name": "DataSourceObject__c", "nullable": false, "type": "Varchar" }, { "name": "DataSource__c", "nullable": false, "type": "Varchar" }, { "name": "InternalOrganization__c", "nullable": true, "type": "Varchar" }, { "name": "KQ_flightid__c", "nullable": true, "type": "Varchar" }, { "name": "aircrafttype__c", "nullable": true, "type": "Varchar" }, { "name": "arrivalairport__c", "nullable": true, "type": "Varchar" }, { "name": "arrivaltime__c", "nullable": true, "type": "TimestampTZ" }, { "name": "departureairport__c", "nullable": true, "type": "Varchar" }, { "name": "departuretime__c", "nullable": true, "type": "TimestampTZ" }, { "name": "flightid__c", "nullable": false, "precision": 38, "scale": 18, "type": "Numeric" }, { "name": "flightnumber__c", "nullable": true, "type": "Varchar" }, { "name": "miles__c", "nullable": true, "precision": 38, "scale": 18, "type": "Numeric" } ], "returnedRows": 2, "status": { "chunkCount": 1, "completionStatus": "ResultsProduced", "expirationTime": "", "progress": 1, "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2Fe1025a17-0ff7-bcb9-204c-656ec276b188", "rowCount": 513 } } ``` _Example: Response with SQL parameters_ ``` { "data": [ [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Boarded", "2024-06-25T11:00:00+00:00", "003SB0", "AI202", 2, "12C", "Business" ], [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Boarded", "2024-01-22T18:19:04+00:00", "000061", "AI652", 14, "21B", "Economy" ] ], "metadata": [ { "name": "DataSourceObject__c", "nullable": false, "type": "Varchar" }, { "name": "DataSource__c", "nullable": false, "type": "Varchar" }, { "name": "InternalOrganization__c", "nullable": true, "type": "Varchar" }, { "name": "KQ_seatid__c", "nullable": true, "type": "Varchar" }, { "name": "boardingstatus__c", "nullable": true, "type": "Varchar" }, { "name": "bookingdate__c", "nullable": true, "type": "TimestampTZ" }, { "name": "customerid__c", "nullable": true, "type": "Varchar" }, { "name": "flightid__c", "nullable": true, "type": "Varchar" }, { "name": "seatid__c", "nullable": false, "precision": 38, "scale": 18, "type": "Numeric" }, { "name": "seatnumber__c", "nullable": true, "type": "Varchar" }, { "name": "seattype__c", "nullable": true, "type": "Varchar" } ], "returnedRows": 2, "status": { "chunkCount": 1, "completionStatus": "ResultsProduced", "expirationTime": "", "progress": 1, "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7", "rowCount": 1288 } } ``` * **400** Invalid request. The `details` field will contain more information about the SQL code and error. * **401** Invalid JWT. * **403** Permission denied. * **408** Request timed out in processing. * **500** Server error. ### GET Get SQL query status `GET /ssot/query-sql/{queryId}` Tags: Query (Current). Get the status of an SQL query request. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Note:** Refer to the [Data 360 Query Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/query-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 63.0 #### Parameters * `queryId` (path, string, required) ID of the query to return status for, for example, `MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7`. The query's ID was returned in the POST request's `queryID` response parameter. **Available Version:** 63.0 * `dataspace` (query, string) Name of the data space to query. If unspecified, the `default` data space is used. **Available Version:** 63.0 * `waitTimeMs` (query, integer) Number of milliseconds to wait before returning the status. If unspecified, returns the status immediately. Maximum allowed value is 10,000 (10 seconds). **Available Version:** 63.0 * `workloadName` (query, string) Description of the scenario that your query is used in. The workload name is added to the log files to help when debugging. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `QuerySqlStatusRepresentation`. _Example: Example_ ``` { "chunkCount": 1, "completionStatus": "Finished", "expirationTime": "seconds: 1738344542\n", "progress": 1, "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7", "rowCount": 1288 } ``` * **400** Invalid request. * **401** Invalid JWT. * **403** Permission denied. * **500** Server error. ### DELETE Cancel SQL query `DELETE /ssot/query-sql/{queryId}` Tags: Query (Current). Delete the specified SQL query and terminate any queries that are currently running. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). **Available Version:** 63.0 #### Parameters * `queryId` (path, string, required) ID of the query to return status for, for example, `MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7`. The query's ID was returned in the POST request's `queryID` response parameter. **Available Version:** 63.0 * `dataspace` (query, string) Name of the data space to query. If unspecified, the `default` data space is used. **Available Version:** 63.0 * `workloadName` (query, string) Description of the scenario that your query is used in. The workload name is added to the log files to help when debugging. **Available Version:** 63.0 #### Responses * **200** Success * **400** Invalid request. * **401** Invalid JWT. * **403** Permission denied. * **500** Server error. ### GET Get SQL query rows `GET /ssot/query-sql/{queryId}/rows` Tags: Query (Current). Get additional query results that weren't returned in the initial request. For more information about using SQL in Data 360, see [Getting Started with Data 360 SQL](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/dc-query-section.html). > **Important:** Ensure application compatibility with both synchronous and asynchronous queries. To retrieve results from an asynchronous query, poll the [get SQL query status](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getSqlQuery) endpoint with the _queryId_ until the status is `Finished`. > **Note:** Refer to the [Data 360 Query Connect API use case example](https://developer.salesforce.com/docs/data/connectapi/guide/query-use-case.html) to see this endpoint implemented in a high-value scenario. **Available Version:** 63.0 #### Parameters * `queryId` (path, string, required) ID of the query to return status for, for example, `MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7`. The query's ID was returned in the POST request's `queryID` response parameter. **Available Version:** 63.0 * `dataspace` (query, string, required) Name of the data space to fetch the data from. The user making the request must have permission to this data pace. If unspecified, the `default` data space is used. **Available Version:** 63.0 type: string * `offset` (query, integer (int64), required) Row number to start with when retrieving the next chunk of query results. Value must be less than the total number of available rows. **Available Version:** 63.0 * `rowLimit` (query, integer (int64)) Maximum number of rows to include in the response. The actual number of rows returned may be lower than the requested value if fewer are available or if the result set exceeds internal system size limits. Value must be greater than `0`. **Available Version:** 63.0 * `workloadName` (query, string) Description of the scenario that your query is used in. The workload name is added to the log files to help when debugging. **Available Version:** 63.0 #### Responses * **200** Success Media type: `application/json`. Schema: `QuerySqlPageRepresentation`. _Example: Example_ ``` { "data": [ [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Airbus A321", "MAA", "2024-06-10T13:30:00+00:00", "BLR", "2024-06-10T12:00:00+00:00", 3, "AI103", null ], [ "DEMO_DATA_PILOT_TRAINING", "Snowflake_BYOL", null, null, "Boeing 737", "HYD", "2024-06-10T15:30:00+00:00", "MAA", "2024-06-10T14:00:00+00:00", 4, "AI104", null ] ], "metadata": [ { "name": "DataSourceObject__c", "nullable": false, "type": "Varchar" }, { "name": "DataSource__c", "nullable": false, "type": "Varchar" }, { "name": "InternalOrganization__c", "nullable": true, "type": "Varchar" }, { "name": "KQ_flightid__c", "nullable": true, "type": "Varchar" }, { "name": "aircrafttype__c", "nullable": true, "type": "Varchar" }, { "name": "arrivalairport__c", "nullable": true, "type": "Varchar" }, { "name": "arrivaltime__c", "nullable": true, "type": "TimestampTZ" }, { "name": "departureairport__c", "nullable": true, "type": "Varchar" }, { "name": "departuretime__c", "nullable": true, "type": "TimestampTZ" }, { "name": "flightid__c", "nullable": false, "precision": 38, "scale": 18, "type": "Numeric" }, { "name": "flightnumber__c", "nullable": true, "type": "Varchar" }, { "name": "miles__c", "nullable": true, "precision": 38, "scale": 18, "type": "Numeric" } ], "returnedRows": 2 } ``` * **400** Invalid request. * **401** Invalid JWT. * **403** Permission denied. * **408** Request timed out in processing. * **500** Server error. ### GET Get semantic search definition details `GET /ssot/search-index` Tags: Search Index. Get all search index definition details. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticSearchDefDetailsRepresentation`. _Example: Semantic search response_ ``` { "semanticSearchDefinitionDetails": [ { "attachmentDmoDeveloperName": null, "attachmentDmoId": null, "attachmentDmoName": null, "chunkDmoDeveloperName": "test_chunk__dlm", "chunkDmoId": "0gjSB00000BWANkYAP", "chunkDmoName": "test chunk", "chunkingConfiguration": { "fieldLevelConfigurations": [ { "config": { "id": "passage_extraction", "userValues": [ { "id": "max_tokens", "value": "500" } ] }, "decorators": [ { "decoratorId": "testId", "dmoDeveloperName": "testDevName", "dmoFieldDeveloperName": "testFieldDevName", "dmoFieldName": "testFieldName", "dmoName": "testName" } ], "sourceDmoDeveloperName": "Ind_Local__dlm", "sourceDmoFieldDeveloperName": "CustomerID__c", "sourceDmoFieldName": "CustomerID", "sourceDmoName": "Ind_Local" } ], "perFileExtension": [ { "config": { "id": "testId", "userValues": [ { "id": "testId", "value": "testValue" } ] }, "fileExtensions": "html" } ] }, "dataspace": "default", "description": "Test description.", "developerName": "test", "id": "18lSB0000006NWbYAM", "indexRefreshedOn": "T19:24:00.000Z", "label": "test", "processingType": "NEAR_REALTIME", "rankingConfigurations": [ { "developerName": "testDevName", "entitySourceType": "testSourceFieldDevName", "fieldRelationshipPathId": "testPathId", "id": "testId", "rankType": "testRankingFieldType", "relatedDmoDeveloperName": "testDevName", "relatedDmoFieldDeveloperName": "testFieldDevName", "relatedDmoFieldId": "testFieldId", "relatedDmoFieldName": "testFieldName", "relatedDmoId": "testId", "relatedDmoName": "testName", "relationships": [ { "apiName": "testName", "parentRelationshipId": "testId", "sourceDmoDeveloperName": "testDevName", "sourceDmoLabel": "testLabel", "sourceFieldId": "testFieldId", "sourceFieldLabel": "testFieldLabel", "sourceFieldName": "testFieldName", "targetDmoDeveloperName": "testDevName", "targetDmoLabel": "testLabel", "targetFieldId": "testFieldId", "targetFieldLabel": "testFieldLabel", "targetFieldName": "testFieldName" } ] } ], "runtimeStatus": "READY", "searchType": "HYBRID", "semanticSearchRankingConfigurations": [], "sourceDmoDeveloperName": "Ind_Local__dlm", "sourceDmoId": "0gjSB00000BT6YLYA1", "transcribeDmoDeveloperName": null, "transcribeDmoId": null, "transcribeDmoName": null, "transformConfigurations": [ { "fileLevelConfiguration": [ { "config": { "id": "testId", "userValues": [ { "id": "testId", "value": "testValue" } ] }, "fileExtensions": "html" } ], "transformType": "testType" } ], "vectorDmoDeveloperName": "test_index__dlm", "vectorDmoId": "0gjSB00000BWANlYAP", "vectorDmoName": "test index", "vectorEmbedding": { "developerName": "testVectorEmbedding", "id": "17nSB0000004lTNYAY", "sourceDmoDeveloperName": "test_chunk__dlm", "sourceDmoFieldDeveloperName": "Chunk__c", "sourceDmoFieldId": "0gYSB00002c22kN2AQ", "sourceDmoId": "0gjSB00000BWANkYAP", "vectorDmoDeveloperName": "test_index__dlm", "vectorDmoFieldDeveloperName": "VectorEmbedding__c", "vectorDmoFieldId": "0gYSB00002c22kT2AQ", "vectorDmoId": "0gjSB00000BWANlYAP", "vectorEmbeddingRelatedFields": [ { "fieldRelationshipPathId": null, "id": "17iSB000004j4MDYAY", "relatedDmoDeveloperName": "test_index__dlm", "relatedDmoFieldDeveloperName": "DataSource__c", "relatedDmoFieldId": "0gYSB00002c22kU2AQ", "relatedDmoFieldName": "Data Source", "relatedDmoId": "0gjSB00000BWANlYAP", "relatedDmoName": "test index", "relationships": [ { "apiName": "testName", "parentRelationshipId": "testId", "sourceDmoDeveloperName": "testDevName", "sourceDmoLabel": "testLabel", "sourceFieldId": "testFieldId", "sourceFieldLabel": "testFieldLabel", "sourceFieldName": "testFieldName", "targetDmoDeveloperName": "testDevName", "targetDmoLabel": "testLabel", "targetFieldId": "testFieldId", "targetFieldLabel": "testFieldLabel", "targetFieldName": "testFieldName" } ] } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "testId", "userValues": [ { "id": "testId", "value": "testValue" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "testId", "value": "testValue" } ] }, "similarityMetric": "COSINE" }, "version": null } ], "totalSize": null, "currentPageUrl": null, "nextPageUrl": null } ``` _Example: Hybrid search response_ ``` { "semanticSearchDefinitionDetails": [ { "attachmentDmoDeveloperName": null, "attachmentDmoId": null, "attachmentDmoName": null, "chunkDmoDeveloperName": "test_csv_upload_chunk__dlm", "chunkDmoId": "0gjTC000000OBjtYAG", "chunkDmoName": "test csv upload chunk", "chunkingConfiguration": { "fieldLevelConfigurations": [ { "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [], "sourceDmoDeveloperName": "test_csv_upload__dlm", "sourceDmoFieldDeveloperName": "email__c", "sourceDmoFieldName": "email", "sourceDmoName": "test csv upload" } ], "perFileExtension": [] }, "dataspace": "default", "description": null, "developerName": "test_csv_upload", "id": "18lTC0000001penYAA", "indexRefreshedOn": "2025-03-03T15:36:17.000Z", "label": "damar csv upload", "processingType": "NEAR_REALTIME", "rankingConfigurations": [], "runtimeStatus": "READY", "searchType": "HYBRID", "semanticSearchRankingConfigurations": [], "sourceDmoDeveloperName": "test_csv_upload__dlm", "sourceDmoId": "0gjTC000000IBY5YAO", "transcribeDmoDeveloperName": null, "transcribeDmoId": null, "transcribeDmoName": null, "transformConfigurations": [], "vectorDmoDeveloperName": "test_csv_upload_index__dlm", "vectorDmoId": "0gjTC000000OBjuYAG", "vectorDmoName": "test csv upload index", "vectorEmbedding": { "developerName": "test_csv_uploadVectorEmbedding", "id": "17nTC0000001onZYAQ", "sourceDmoDeveloperName": "test_csv_upload_chunk__dlm", "sourceDmoFieldDeveloperName": "Chunk__c", "sourceDmoFieldId": "0gYTC000004qebr2AA", "sourceDmoId": "0gjTC000000OBjtYAG", "vectorDmoDeveloperName": "test_csv_upload_index__dlm", "vectorDmoFieldDeveloperName": "VectorEmbedding__c", "vectorDmoFieldId": "0gYTC000004qeby2AA", "vectorDmoId": "0gjTC000000OBjuYAG", "vectorEmbeddingRelatedFields": [ { "fieldRelationshipPathId": null, "id": "17iTC000000RgG5YAK", "relatedDmoDeveloperName": "test_csv_upload_index__dlm", "relatedDmoFieldDeveloperName": "DataSource__c", "relatedDmoFieldId": "0gYTC000004qebt2AA", "relatedDmoFieldName": "Data Source", "relatedDmoId": "0gjTC000000OBjuYAG", "relatedDmoName": "test csv upload index", "relationships": [] } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "version": null }, { "attachmentDmoDeveloperName": null, "attachmentDmoId": null, "attachmentDmoName": null, "chunkDmoDeveloperName": "test_Knowledge_BEIR_chunk__dlm", "chunkDmoId": "0gjTC000000OD5lYAG", "chunkDmoName": "test Knowledge BEIR chunk", "chunkingConfiguration": { "fieldLevelConfigurations": [ { "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [], "sourceDmoDeveloperName": "test_Knowledge_BEIR__dlm", "sourceDmoFieldDeveloperName": "TitlePrependedBody__c", "sourceDmoFieldName": "TitlePrependedBody", "sourceDmoName": "test Knowledge BEIR" } ], "perFileExtension": [] }, "dataspace": "default", "description": null, "developerName": "test_Knowledge_BEIR", "id": "18lTC0000001qPZYAY", "indexRefreshedOn": "2025-03-04T21:45:39.000Z", "label": "test Knowledge BEIR", "processingType": "NEAR_REALTIME", "rankingConfigurations": [], "runtimeStatus": "FAILED", "searchType": "HYBRID", "semanticSearchRankingConfigurations": [], "sourceDmoDeveloperName": "test_Knowledge_BEIR__dlm", "sourceDmoId": "0gjTC000000FacgYAC", "transcribeDmoDeveloperName": null, "transcribeDmoId": null, "transcribeDmoName": null, "transformConfigurations": [], "vectorDmoDeveloperName": "test_Knowledge_BEIR_index__dlm", "vectorDmoId": "0gjTC000000OD5mYAG", "vectorDmoName": "test Knowledge BEIR index", "vectorEmbedding": { "developerName": "test_Knowledge_BEIRVectorEmbedding", "id": "17nTC0000001pYLYAY", "sourceDmoDeveloperName": "test_Knowledge_BEIR_chunk__dlm", "sourceDmoFieldDeveloperName": "Chunk__c", "sourceDmoFieldId": "0gYTC000004qoeL2AQ", "sourceDmoId": "0gjTC000000OD5lYAG", "vectorDmoDeveloperName": "test_Knowledge_BEIR_index__dlm", "vectorDmoFieldDeveloperName": "VectorEmbedding__c", "vectorDmoFieldId": "0gYTC000004qoeW2AQ", "vectorDmoId": "0gjTC000000OD5mYAG", "vectorEmbeddingRelatedFields": [ { "fieldRelationshipPathId": null, "id": "17iTC000000RhSHYA0", "relatedDmoDeveloperName": "test_Knowledge_BEIR_index__dlm", "relatedDmoFieldDeveloperName": "DataSource__c", "relatedDmoFieldId": "0gYTC000004qoeX2AQ", "relatedDmoFieldName": "Data Source", "relatedDmoId": "0gjTC000000OD5mYAG", "relatedDmoName": "test Knowledge BEIR index", "relationships": [] } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "version": null } ], "totalSize": null, "currentPageUrl": null, "nextPageUrl": null } ``` * **400** Bad request. * **403** User does not have permission to access. * **422** Unprocessable entity. ### POST Create semantic search `POST /ssot/search-index` Tags: Search Index. Define the connect APIs that perform create, read, update, and delete operations for a search index of unstructured data. **Available Version:** 60.0 #### Request body Media type: `application/json`. Schema: `SemanticSearchInputRepresentation`. _Example: Semantic search type for a DMO request_ ``` { "label": "Case_search_index", "developerName": "Case_search_index", "sourceDmoDeveloperName": "ssot__Case__dlm", "chunkDmoName": "Case_search_index chunk", "chunkDmoDeveloperName": "Case_search_index_chunk", "vectorDmoName": "Case_search_index index", "vectorDmoDeveloperName": "Case_search_index_index", "vectorEmbedding": { "vectorEmbeddingRelatedFields": [] }, "chunkingConfiguration": { "fieldLevelConfigurations": [ { "sourceDmoDeveloperName": "ssot__Case__dlm", "sourceDmoFieldDeveloperName": "ssot__CaseNumber__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "sourceDmoDeveloperName": "ssot__Case__dlm", "sourceDmoFieldDeveloperName": "ssot__Subject__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } } ], "fileLevelConfiguration": { "perFileExtensions": [ { "fileExtension": "html", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "citations": [ "type" ] }, { "fileExtension": "txt", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "citations": [ "type" ] }, { "fileExtension": "aspx", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "citations": [ "type" ] }, { "fileExtension": "pdf", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "citations": [ "page_number", "type" ] }, { "fileExtension": "log", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "citations": [ "type" ] }, { "fileExtension": "mp3", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "wav", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "flac", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "mpga", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "m4a", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "ogg", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "mp4", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "mpeg", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] }, { "fileExtension": "webm", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] }, "citations": [ "start_time", "end_time", "type" ] } ] } }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "searchType": "VECTOR", "rankingConfigurations": [], "attachmentDmoDeveloperName": "ssot__ContentDocumentVersion__dlm", "transcribeDmoName": "Case_search_index transcribe", "transcribeDmoDeveloperName": "Case_search_index_transcribe", "transformConfigurations": [ { "fileLevelConfiguration": [ { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp3", "wav", "flac", "mpga", "m4a", "ogg" ] }, { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp4", "mpeg", "webm" ] } ], "transformType": "transcribe" } ] } ``` _Example: Semantic search type for a UDMO request_ ``` { "label": "FileUDMO_SI", "developerName": "FileUDMO_SI", "sourceDmoDeveloperName": "RagFileUDMO__dlm", "chunkDmoName": "FileUDMO_SI chunk", "chunkDmoDeveloperName": "FileUDMO_SI_chunk", "vectorDmoName": "FileUDMO_SI index", "vectorDmoDeveloperName": "FileUDMO_SI_index", "vectorEmbedding": { "vectorEmbeddingRelatedFields": [ { "relatedDmoDeveloperName": "AiGroundingFileRefCustom__dlm", "relatedDmoFieldDeveloperName": "FileSize__c", "relationships": [ { "sourceDmoDeveloperName": "AiGroundingFileRefCustom__dlm", "sourceDmoFieldDeveloperName": "FilePath__c", "targetDmoDeveloperName": "RagFileUDMO__dlm", "targetDmoFieldDeveloperName": "FilePath__c" } ] }, { "relatedDmoDeveloperName": "AiGroundingFileRefCustom__dlm", "relatedDmoFieldDeveloperName": "FilePath__c", "relationships": [ { "sourceDmoDeveloperName": "AiGroundingFileRefCustom__dlm", "sourceDmoFieldDeveloperName": "FilePath__c", "targetDmoDeveloperName": "RagFileUDMO__dlm", "targetDmoFieldDeveloperName": "FilePath__c" } ] } ] }, "chunkingConfiguration": { "fileLevelConfiguration": { "perFileExtensions": [ { "fileExtension": "pdf", "config": { "id": "section_aware_chunking", "userValues": [ { "id": "max_tokens", "value": "512" }, { "id": "overlap_tokens", "value": "0" } ] }, "citations": [ "page_number", "type" ] }, { "fileExtension": "docx", "config": { "id": "section_aware_chunking", "userValues": [ { "id": "max_tokens", "value": "512" }, { "id": "overlap_tokens", "value": "0" } ] }, "citations": [ "page_number", "type" ] } ] } }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "searchType": "VECTOR", "rankingConfigurations": [], "transcribeDmoName": "FileUDMO_SI transcribe", "transcribeDmoDeveloperName": "FileUDMO_SI_transcribe", "transformConfigurations": [ { "fileLevelConfiguration": [ { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp3", "wav", "flac", "mpga", "m4a", "ogg" ] }, { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp4", "mpeg", "webm" ] } ], "transformType": "transcribe" } ] } ``` _Example: Hybrid search type request_ ``` { "label": "Test", "developerName": "Test", "description": "A sample description", "sourceDmoDeveloperName": "ssot__Account__dlm", "chunkDmoName": "Test chunk", "vectorDmoName": "Test index", "chunkDmoDeveloperName": "Test_chunk", "vectorDmoDeveloperName": "Test_index", "searchType": "HYBRID", "vectorEmbedding": { "vectorEmbeddingRelatedFields": [ { "relatedDmoDeveloperName": "Account__dlm", "relatedDmoFieldDeveloperName": "Name__c", "relationships": [ { "sourceDmoDeveloperName": "Account__dlm", "sourceDmoFieldDeveloperName": "Name__c", "targetDmoDeveloperName": "AccountContact__dlm", "targetDmoFieldDeveloperName": "IndividualId__c" } ] } ] }, "rankingConfigurations": [ { "relatedDmoDeveloperName": "Case__dlm", "relatedDmoFieldDeveloperName": "CreatedDate__c", "rankType": "RECENCY", "developerName": "Rank_time_freshness", "relationships": [] } ], "chunkingConfiguration": { "fieldLevelConfigurations": [ { "sourceDmoDeveloperName": "ssot__Account__dlm", "sourceDmoFieldDeveloperName": "ssot__Name__c", "config": { "id": "passage_extraction", "userValues": [ { "id": "max_tokens", "value": "512" }, { "id": "strip_html", "value": "true" } ] } } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "8" }, { "id": "M", "value": "4" } ] }, "similarityMetric": "COSINE" } } ``` _Example: Index config request_ ``` { "label": "SlackSI", "developerName": "SlackSI", "sourceDmoDeveloperName": "Slack_Message__dlm", "chunkDmoName": "SlackSI chunk", "chunkDmoDeveloperName": "SlackSI_chunk", "vectorDmoName": "SlackSI index", "vectorDmoDeveloperName": "SlackSI_index", "vectorEmbedding": { "vectorEmbeddingRelatedFields": [ { "relatedDmoDeveloperName": "Slack_User__dlm", "relatedDmoFieldDeveloperName": "FirstName__c", "relationships": [ { "sourceDmoDeveloperName": "Slack_User__dlm", "sourceDmoFieldDeveloperName": "id__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "id__c" } ] }, { "relatedDmoDeveloperName": "Slack_Channel__dlm", "relatedDmoFieldDeveloperName": "Address__c", "relationships": [ { "sourceDmoDeveloperName": "Slack_Channel__dlm", "sourceDmoFieldDeveloperName": "Address__c", "targetDmoDeveloperName": "Slack_User__dlm", "targetDmoFieldDeveloperName": "Address__c" }, { "sourceDmoDeveloperName": "Slack_User__dlm", "sourceDmoFieldDeveloperName": "id__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "id__c" } ] }, { "relatedDmoDeveloperName": "Slack_Message__dlm", "relatedDmoFieldDeveloperName": "birthdate__c", "relationships": [] } ] }, "chunkingConfiguration": { "fieldLevelConfigurations": [ { "sourceDmoDeveloperName": "Slack_Message__dlm", "sourceDmoFieldDeveloperName": "FirstName__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "sourceDmoDeveloperName": "Slack_Message__dlm", "sourceDmoFieldDeveloperName": "gender__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "sourceDmoDeveloperName": "Slack_User__dlm", "sourceDmoFieldDeveloperName": "name__c", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [] }, { "sourceDmoDeveloperName": "Slack_Channel__dlm", "sourceDmoFieldDeveloperName": "name__c", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [] } ] }, "indexConfiguration": { "shouldVectorizeSearchableFields": false, "recordFieldConfiguration": [ { "dmoDeveloperName": "Slack_User__dlm", "dmoFieldDeveloperName": "name__c", "aliasName": "slack_user_name", "tokenizations": [ { "name": "STANDARD" }, { "name": "TYPEAHEAD" } ], "relationships": [ { "sourceDmoDeveloperName": "Slack_User__dlm", "sourceDmoFieldDeveloperName": "name__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "name__c" } ] }, { "dmoDeveloperName": "Slack_Channel__dlm", "dmoFieldDeveloperName": "name__c", "aliasName": "slack_channel_name", "tokenizations": [ { "name": "STANDARD" }, { "name": "TYPEAHEAD" } ], "relationships": [ { "sourceDmoDeveloperName": "Slack_Channel__dlm", "sourceDmoFieldDeveloperName": "name__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "name__c" } ] } ], "contextFieldConfiguration": [ { "dmoDeveloperName": "Slack_User__dlm", "dmoFieldDeveloperName": "FirstName__c", "aliasName": "slack_user_FirstName", "relationships": [ { "sourceDmoDeveloperName": "Slack_User__dlm", "sourceDmoFieldDeveloperName": "FirstName__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "name__c" } ] }, { "dmoDeveloperName": "Slack_Channel__dlm", "dmoFieldDeveloperName": "FirstName__c", "aliasName": "slack_user_name", "relationships": [ { "sourceDmoDeveloperName": "Slack_Channel__dlm", "sourceDmoFieldDeveloperName": "FirstName__c", "targetDmoDeveloperName": "Slack_Message__dlm", "targetDmoFieldDeveloperName": "name__c" } ] } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "searchType": "VECTOR", "rankingConfigurations": [] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticSearchRepresentation`. _Example: Example_ ``` { "vectorEmbedding": { "vectorEmbeddingRelatedFields": [ { "relatedDmoDeveloperName": "Case__dlm", "relatedDmoFieldDeveloperName": "contactid__c", "relationships": [] }, { "relatedDmoDeveloperName": "Case__dlm", "relatedDmoFieldDeveloperName": "DataSourceObject__c", "relationships": [] }, { "relatedDmoDeveloperName": "testSmNewAdityaData__dlm", "relatedDmoFieldDeveloperName": "predicted_label__c", "relationships": [ { "sourceDmoDeveloperName": "testSmNewAdityaData__dlm", "sourceDmoFieldDeveloperName": "PrimaryObjectPk__c", "targetDmoDeveloperName": "Case__dlm", "targetDmoFieldDeveloperName": "CaseId__c" } ] } ] }, "id": "testId", "chunkingStrategies": [], "rankingConfigurations": [], "transformations": [], "currentPageUrl": null, "nextPageUrl": null, "totalSize": null } ``` * **400** Bad request. * **403** User does not have permission to access. * **422** Unprocessable entity. ### GET Get semantic search configuration `GET /ssot/search-index/config` Tags: Search Index. Get a search index configuration. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticSearchConfigRepresentation`. _Example: Example_ ``` { "config": "{"version":"1.0","chunkingConfigurations":{"systemSupportedChunkingStrategies":[{"label":"Passage Extraction","id":"passage_extraction","status":"ENABLED","default":"true","configurations":[{"label":"Strip HTML","status":"ENABLED","id":"strip_html","type":"boolean","readOnly":"false","defaultValue":"true"},{"label":"Max Token","status":"ENABLED","id":"max_tokens","type":"integer","readOnly":"false","defaultValue":"512","maxValue":"512"}]},{"label":"Conversation Based","id":"conversation_based","status":"ENABLED","configurations":[{"label":"Max Token","status":"ENABLED","id":"max_tokens","type":"integer","readOnly":"false","defaultValue":"512","maxValue":"512"}]}],"perFileExtension":[{"fileExtension":"html","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"txt","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"aspx","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"pdf","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":["page_number"]},{"fileExtension":"log","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"rtf","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"docx","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":["page_number"]},{"fileExtension":"pptx","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":["page_number"]},{"fileExtension":"xlsx","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":["page_number","page_name"]},{"fileExtension":"csv","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"eml","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"msg","allowedValues":["passage_extraction"],"defaultValue":"passage_extraction","allowedCitations":[]},{"fileExtension":"mp3","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"mp4","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"wav","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"flac","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"mpga","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"m4a","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"ogg","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"mpeg","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]},{"fileExtension":"webm","allowedValues":["conversation_based"],"defaultValue":"conversation_based","allowedCitations":["author","start_time","end_time"]}],"systemSupportedCitations":[{"label":"Page Number","id":"page_number","status":"ENABLED","readOnly":"true"},{"label":"Page Name","id":"page_name","status":"ENABLED","readOnly":"true"},{"label":"Author","id":"author","status":"ENABLED","readOnly":"true"},{"label":"Start Time","id":"start_time","status":"ENABLED","readOnly":"true"},{"label":"End Time","id":"end_time","status":"ENABLED","readOnly":"true"}]},"vectorEmbeddingConfigurations":{"embeddingModels":[{"label":"E5 Large V2 Embedding Model","id":"e5_large_v2","status":"ENABLED","type":"data_cloud_hosted","default":"true","description":"More details can be found at https://huggingface.co/intfloat/e5-large-v2","configurations":[{"label":"Dimension","status":"ENABLED","id":"dimension","type":"integer","description":"Number of dimensions in the vector","readOnly":"true","defaultValue":"1024","maxValue":"1024"},{"label":"Max Token Limit","status":"ENABLED","id":"max_token_limit","type":"integer","description":"Number of dimensions in the vector","readOnly":"true","defaultValue":"512","maxValue":"512"}]},{"label":"Multilingual E5 Large Embedding Model","id":"multilingual-e5-large","status":"ENABLED","type":"data_cloud_hosted","description":"More details can be found at https://huggingface.co/intfloat/multilingual-e5-large","configurations":[{"label":"Dimension","id":"dimension","type":"integer","description":"Number of dimensions in the vector","readOnly":"true","defaultValue":"1024","maxValue":"1024"},{"label":"Max Token Limit","id":"max_token_limit","type":"integer","description":"token limit in the model","readOnly":"true","defaultValue":"512","maxValue":"512"}]}],"indexConfigurations":{"supportedIndices":[{"label":"HNSW","id":"HNSW","status":"ENABLED","default":"true","configurations":[{"label":"hnswEfConstruction","status":"ENABLED","id":"hnswEfConstruction","type":"integer","readOnly":"true","defaultValue":"2000","maxValue":"2000"},{"label":"M","status":"ENABLED","id":"M","type":"integer","readOnly":"true","defaultValue":"64","maxValue":"64"}]}],"similarityMetricsSupportedPerIndex":[{"indexId":"DISKANN","allowedValues":["L2"]},{"indexId":"HNSW","allowedValues":["COSINE"]}],"supportedSimilarityMetrices":[{"label":"COSINE","id":"COSINE","status":"ENABLED","configurations":[]},{"label":"Euclidean distance","id":"L2","status":"ENABLED","configurations":[]}]}},"transcribeConfigurations":{"systemSupportedTranscribingModels":[{"label":"Whisper Large V3 Model","id":"whisper_large_v3","status":"ENABLED","default":"true","type":"data_cloud_hosted","description":"More details can be found at https://huggingface.co/openai/whisper-large-v3","configurations":[{"label":"Speaker Diarization","id":"speaker_diarization","status":"ENABLED","defaultValue":"false","type":"boolean","readOnly":"false"},{"label":"Include Timestamp","id":"include_timestamp","status":"ENABLED","defaultValue":"true","type":"boolean","readOnly":"false"}]}],"perFileExtension":[{"fileExtension":"mp3","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"ogg","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"flac","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"wav","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"m4a","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"mpga","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"mp4","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"mpeg","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"},{"fileExtension":"webm","allowedValues":["whisper_large_v3"],"defaultValue":"whisper_large_v3"}]}}" } ``` ### GET Get semantic search `GET /ssot/search-index/{searchIndexApiNameOrId}` Tags: Search Index. Get information about the specified search index definition record. **Available Version:** 60.0 #### Parameters * `searchIndexApiNameOrId` (path, string, required) ID or API Name of the search index. **Available Version:** 60.0 #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticSearchDefDetailRepresentation`. _Example: Semantic search response_ ``` { "attachmentDmoDeveloperName": null, "attachmentDmoId": null, "attachmentDmoName": null, "chunkDmoDeveloperName": "JB_Campaign_SI_chunk__dlm", "chunkDmoId": "0gjSB00000163dlYAA", "chunkDmoName": "JB_Campaign_SI chunk", "chunkingConfiguration": { "fieldLevelConfigurations": [ { "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [], "sourceDmoDeveloperName": "Campaign__dlm", "sourceDmoFieldDeveloperName": "Name__c", "sourceDmoFieldName": "Name", "sourceDmoName": "Campaign" } ], "perFileExtension": [] }, "dataspace": "default", "description": null, "developerName": "JB_Campaign_SI", "id": "18lSB0000000MlJYAU", "label": "JB_Campaign_SI", "rankingConfigurations": [], "searchType": "VECTOR", "semanticSearchRankingConfigurations": [], "sourceDmoDeveloperName": "Campaign__dlm", "sourceDmoId": "0gjSB000000GwuTYAS", "transcribeDmoDeveloperName": null, "transcribeDmoId": null, "transcribeDmoName": null, "transformConfigurations": [], "vectorDmoDeveloperName": "JB_Campaign_SI_vector__dlm", "vectorDmoId": "0gjSB00000163dmYAA", "vectorDmoName": "JB_Campaign_SI vector", "vectorEmbedding": { "developerName": "JB_Campaign_SIVectorEmbedding", "id": "17nSB0000000V3pYAE", "sourceDmoDeveloperName": "JB_Campaign_SI_chunk__dlm", "sourceDmoFieldDeveloperName": "Chunk__c", "sourceDmoFieldId": "0gYSB00000ICpcN2AT", "sourceDmoId": "0gjSB00000163dlYAA", "vectorDmoDeveloperName": "JB_Campaign_SI_vector__dlm", "vectorDmoFieldDeveloperName": "VectorEmbedding__c", "vectorDmoFieldId": "0gYSB00000ICpcT2AT", "vectorDmoId": "0gjSB00000163dmYAA", "vectorEmbeddingRelatedFields": [] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "DISKANN", "userValues": [] }, "similarityMetric": "COSINE" }, "version": null } ``` _Example: Hybrid search response_ ``` { "attachmentDmoDeveloperName": null, "attachmentDmoId": null, "attachmentDmoName": null, "chunkDmoDeveloperName": "test_csv_upload_chunk__dlm", "chunkDmoId": "0gjTC000000OBjtYAG", "chunkDmoName": "test csv upload chunk", "chunkingConfiguration": { "fieldLevelConfigurations": [ { "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] }, "decorators": [], "sourceDmoDeveloperName": "test_csv_upload__dlm", "sourceDmoFieldDeveloperName": "email__c", "sourceDmoFieldName": "email", "sourceDmoName": "test csv upload" } ], "perFileExtension": [] }, "dataspace": "default", "description": null, "developerName": "test_csv_upload", "id": "18lTC0000001penYAA", "indexRefreshedOn": "2025-03-03T15:36:17.000Z", "label": "test csv upload", "processingType": "NEAR_REALTIME", "rankingConfigurations": [], "runtimeStatus": "READY", "searchType": "HYBRID", "semanticSearchRankingConfigurations": [], "sourceDmoDeveloperName": "test_csv_upload__dlm", "sourceDmoId": "0gjTC000000IBY5YAO", "transcribeDmoDeveloperName": null, "transcribeDmoId": null, "transcribeDmoName": null, "transformConfigurations": [], "vectorDmoDeveloperName": "test_csv_upload_index__dlm", "vectorDmoId": "0gjTC000000OBjuYAG", "vectorDmoName": "test csv upload index", "vectorEmbedding": { "developerName": "test_csv_uploadVectorEmbedding", "id": "17nTC0000001onZYAQ", "sourceDmoDeveloperName": "test_csv_upload_chunk__dlm", "sourceDmoFieldDeveloperName": "Chunk__c", "sourceDmoFieldId": "0gYTC000004qebr2AA", "sourceDmoId": "0gjTC000000OBjtYAG", "vectorDmoDeveloperName": "test_csv_upload_index__dlm", "vectorDmoFieldDeveloperName": "VectorEmbedding__c", "vectorDmoFieldId": "0gYTC000004qeby2AA", "vectorDmoId": "0gjTC000000OBjuYAG", "vectorEmbeddingRelatedFields": [ { "fieldRelationshipPathId": null, "id": "17iTC000000RgG5YAK", "relatedDmoDeveloperName": "test_csv_upload_index__dlm", "relatedDmoFieldDeveloperName": "DataSource__c", "relatedDmoFieldId": "0gYTC000004qebt2AA", "relatedDmoFieldName": "Data Source", "relatedDmoId": "0gjTC000000OBjuYAG", "relatedDmoName": "test csv upload index", "relationships": [] } ] }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "version": null } ``` * **400** Bad request. * **403** User does not have permission to access. * **422** Unprocessable entity. ### DELETE Delete semantic search `DELETE /ssot/search-index/{searchIndexApiNameOrId}` Tags: Search Index. Delete a search index definition. **Available Version:** 60.0 #### Parameters * `searchIndexApiNameOrId` (path, string, required) ID or API Name of the search index. **Available Version:** 60.0 #### Responses * **200** Success ### PATCH Update semantic search `PATCH /ssot/search-index/{searchIndexApiNameOrId}` Tags: Search Index. Update a Semantic Index record. **Available Version:** 60.0 #### Parameters * `searchIndexApiNameOrId` (path, string, required) ID or API Name of the search index. **Available Version:** 60.0 #### Request body (required) Media type: `application/json`. Schema: `SemanticSearchInputRepresentation`. _Example Index config request: same as POST /ssot/search-index request._ _Example: Search index request_ ``` { "label": "Case_search_index", "developerName": "Case_search_index", "sourceDmoDeveloperName": "ssot__Case__dlm", "chunkDmoName": "Case_search_index chunk", "chunkDmoDeveloperName": "Case_search_index_chunk", "vectorDmoName": "Case_search_index index", "vectorDmoDeveloperName": "Case_search_index_index", "vectorEmbedding": { "vectorEmbeddingRelatedFields": [] }, "chunkingConfiguration": { "fieldLevelConfigurations": [ { "sourceDmoDeveloperName": "ssot__Case__dlm", "sourceDmoFieldDeveloperName": "ssot__CaseNumber__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "sourceDmoDeveloperName": "ssot__Case__dlm", "sourceDmoFieldDeveloperName": "ssot__Subject__c", "decorators": [], "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } } ], "fileLevelConfiguration": { "perFileExtensions": [ { "fileExtension": "html", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "txt", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "aspx", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "pdf", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "log", "config": { "id": "passage_extraction", "userValues": [ { "id": "strip_html", "value": "true" }, { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "mp3", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "wav", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "flac", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "mpga", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "m4a", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "ogg", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "mp4", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "mpeg", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } }, { "fileExtension": "webm", "config": { "id": "conversation_based", "userValues": [ { "id": "max_tokens", "value": "512" } ] } } ] } }, "vectorEmbeddingConfiguration": { "embeddingModel": { "id": "e5_large_v2", "userValues": [ { "id": "dimension", "value": "1024" }, { "id": "max_token_limit", "value": "512" } ] }, "index": { "id": "HNSW", "userValues": [ { "id": "hnswEfConstruction", "value": "2000" }, { "id": "M", "value": "64" } ] }, "similarityMetric": "COSINE" }, "searchType": "VECTOR", "rankingConfigurations": [], "attachmentDmoDeveloperName": "ssot__ContentDocumentVersion__dlm", "transcribeDmoName": "Case_search_index transcribe", "transcribeDmoDeveloperName": "Case_search_index_transcribe", "transformConfigurations": [ { "fileLevelConfiguration": [ { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp3", "wav", "flac", "mpga", "m4a", "ogg" ] }, { "config": { "id": "whisper_large_v3", "userValues": [ { "id": "include_timestamp", "value": "true" }, { "id": "speaker_diarization", "value": "false" } ] }, "fileExtensions": [ "mp4", "mpeg", "webm" ] } ], "transformType": "transcribe" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `SemanticSearchRepresentation`. _Example Example: same as POST /ssot/search-index 200 response._ * **400** Bad request. * **403** User does not have permission to access. * **422** Unprocessable entity. ### GET Get segments `GET /ssot/segments` Tags: Segments. Returns a paginated list of segments. > **Important:** For this endpoint, authorize using the Core Salesforce token instead of the CDP token. **Available Version:** 55.0 #### Parameters * `batchSize` (query, integer) Number of segments to return at one time. Values are from `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 56.0 * `dataspace` (query, string) Name of the data space in which to perform the action. User must have permission to this data space. Valid when bulk-listing segments. If unspecified, the `default` data space is used. **Available Version:** 58.0 * `filters` (query, string) Filter the result set to a more narrow scope based on segment attributes. Specify a maximum of 10 filters. Separate each filter by an AND logical operator. If unspecified, no filters are applied. Supported values: * `LastPublishedEndDateTime` - Not returned in the output. Indicates the end date and time when the segment was last published. Use only the `!=` operator with this value. * `MarketSegmentType` - Matches the provided value to the field `segmentType`. * `Name` - Matches field `displayName`. * `SegmentOn` - Matches field `segmentOnApiName`. * `SegmentStatus` - Matches field `segmentStatus`. Supported operators: * `contains` - Search operator for identifying strings or substrings within a field. * `eq` - Equality operator for identifying values that match exactly. * `in` - Comparison operator for determining whether a field matches one or more specified values. * `!=` - Inequality operator for determining values that don't match. Filter examples: * `filters=Name != NULL AND Name In Seg 01,seg 02 AND Name contains seg AND Name eq seg 01` * `filters=SegmentStatus != NULL AND SegmentStatus In Processing,Active AND SegmentStatus contains ive AND SegmentStatus eq active` * `filters=MarketSegmentType != NULL AND MarketSegmentType In UI,Dbt AND MarketSegmentType contains i AND MarketSegmentType eq UI` * `filters=SegmentOn != NULL AND SegmentOn In individual,account AND SegmentOn contains ual AND SegmentOn eq Account` * `filters=SegmentOn != NULL AND SegmentOn In individual,account AND SegmentOn contains nt AND SegmentOn eq Account` * `filters=LastPublishedEndDateTime != NULL` **Available Version:** 65.0 * `offset` (query, integer) Number of segments to skip before returning results. If unspecified, no segments are skipped. **Available Version:** 56.0 * `orderby` (query, string) Sort order for the result set. Specify a field value followed by an optional sort order, `ASC` or `DESC`. For example, `Name ASC` sorts results by `Name` in ascending order, and `MarketSegmentType DESC` sorts results by `MarketSegmentType` in descending order. If unspecified, items are returned by ID in ascending order. **Available Version:** 56.0 * `segmentCreationFlow` (query, string) Flow used for segment creation. When set to `Headless`, the request is processed as a headless flow, such as a call made through a headless MCP server. If unspecified, the existing behavior is used. `Headless` is the only valid value. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentContainerOutputRepresentation`. _Example: Example_ ``` { "batchSize": 3, "offset": 0, "orderByExpression": "[Name asc]", "segments": [ { "apiName": "TestSegment1", "dataSpace": "default", "description": "A connect API UI segment.", "displayName": "TestSegment1", "marketSegmentDefinitionId": "3HXxx0000004CfIGAU", "marketSegmentId": "1sgxx00000000RRAAY", "publishInterval": "NO_REFRESH", "segmentOnId": "0gjxx00000000eLAAQ", "segmentStatus": "ACTIVE", "segmentType": "UI" }, { "apiName": "TestSegment2", "dataSpace": "default", "description": "A connect API DBT segment.", "displayName": "TestSegment2", "includeCriteria": "<DbtPipeline xmlns=""><models><model><name>m1</name><sql>select ind__dlm.Individual_Id__c, ind__dlm. KQ_Individual_Id__c from ind__dlm</sql></model></models></DbtPipeline>", "marketSegmentDefinitionId": "3HXxx0000004CH6GAM", "marketSegmentId": "1sgxx0000000085AAA", "publishInterval": "NO_REFRESH", "segmentOnId": "0gjxx00000000eLAAQ", "segmentStatus": "PROCESSING", "segmentType": "DBT" }, { "apiName": "TestSegment3", "dataSpace": "default", "displayName": "TestSegment3", "marketSegmentDefinitionId": "3HXxx0000004CLwGAM", "marketSegmentId": "1sgxx00000000CvAAI", "publishInterval": "NO_REFRESH", "segmentOnId": "0gjxx00000000o1AAA", "segmentStatus": "COUNTING", "segmentType": "UI" } ], "totalSize": 3 } ``` ### POST Create segment `POST /ssot/segments` Tags: Segments. Create a segment in Data 360. When creating a segment, the `sql` property is subject to validations. See [Supported Validations for DBT Segments](/docs/data/connectapi/guide/features_cdp_dbt_validations.html). > **Important:** For this endpoint, authorize using the Core Salesforce token instead of the CDP token. **Available Version:** 55.0 **Root XML tag:** `` #### Parameters * `dataspace` (query, string) Name of the data space in which to perform the action. User must have permission to this data space. If unspecified, the `default` data space is used. * In API version 58.0, if specified, this parameter overrides the `dataSpace` request body property. If this parameter is unspecified, the `dataSpace` request body parameter is used. * In API version 58.0, if neither this parameter nor the `dataSpace` request body property is specified, the `default` data space is used. * In API version 59.0 and later, use this parameter. The `dataSpace` request body property is not available. **Available Version:** 58.0 #### Request body (required) Media type: `application/json`. Schema: `CdpSegmentInputRepresentation`. _Example: Daily publish segment request_ ``` { "description": "Daily_Refresh_Watefall", "displayName": "Daily_Refresh_Waterfall", "segmentOnApiName": "ssot__Account__dlm", "segmentType": "Waterfall", "publishScheduleStartDateTime": "2026-03-10T23:59:59.999Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.999Z", "publishScheduleInfo": { "interval": 12, "frequency": "Daily", "daysOfWeek": { "daysOfWeek": [ "Monday", "Tuesday", "Wednesday" ] } } } ``` _Example: Weekly publish segment request_ ``` { "description": "Weekly_Refresh", "displayName": "Weekly_Refresh", "segmentOnApiName": "ssot__Account__dlm", "segmentType": "Waterfall", "publishScheduleStartDateTime": "2026-03-10T23:59:59.999Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.999Z", "publishScheduleInfo": { "interval": 24, "frequency": "Weekly", "daysOfWeek": { "daysOfWeek": [ "Monday" ] } } } ``` _Example: Monthly publish segment request_ ``` { "description": "Montly_Refresh", "displayName": "Monthly_Refresh", "segmentOnApiName": "ssot__Account__dlm", "segmentType": "Waterfall", "publishScheduleStartDateTime": "2026-03-10T23:59:59.999Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.999Z", "publishScheduleInfo": { "interval": 24, "frequency": "Monthly", "daysOfMonth": { "daysOfMonth": [ -1 ] } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentOutputRepresentation`. _Example: Daily publish segment response_ ``` { "apiName": "Daily_Refresh_Watefall", "dataSpace": "default", "description": "Daily_Refresh_Watefall", "displayName": "Daily_Refresh_Watefall", "lastModifiedDate": "2025-11-26T03:40:33.000Z", "marketSegmentDefinitionId": "3HXVF000000xkGX4AY", "marketSegmentId": "1sgVF000000xHmPYAU", "parameters": [], "publishInterval": "TWELVE", "publishScheduleEndDate": "2026-03-20T00:00:00.000Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.000Z", "publishScheduleInfo": { "daysOfWeek": [ "Monday", "Tuesday", "Wednesday" ], "frequency": "Daily", "interval": 12, "nextScheduledDate": null, "runFrom": null, "runTo": null, "timeInfo": null }, "publishScheduleStartDateTime": "2026-03-10T23:59:59.000Z", "segmentOnApiName": "ssot__Account__dlm", "segmentOnId": "0gjVF000000Q2XrYAK", "segmentStatus": "PROCESSING", "segmentType": " Waterfall" } ``` _Example: Weekly publish segment response_ ``` { "apiName": "Weekly_Refresh", "dataSpace": "default", "description": "Weekly_Refresh", "displayName": "Weekly_Refresh", "lastModifiedDate": "2025-11-26T03:44:02.000Z", "marketSegmentDefinitionId": "3HXVF000000xkI94AI", "marketSegmentId": "1sgVF000000xHo1YAE", "parameters": [], "publishInterval": "TWENTY_FOUR", "publishScheduleEndDate": "2026-03-20T00:00:00.000Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.000Z", "publishScheduleInfo": { "daysOfWeek": [ "Monday" ], "frequency": "Weekly", "interval": 24, "nextScheduledDate": null, "timeInfo": null }, "publishScheduleStartDateTime": "2026-03-10T23:59:59.000Z", "segmentOnApiName": "ssot__Account__dlm", "segmentOnId": "0gjVF000000Q2XrYAK", "segmentStatus": "PROCESSING", "segmentType": "Waterfall" } ``` _Example: Monthly publish segment response_ ``` { "apiName": "Monthly_Refresh", "dataSpace": "default", "description": "Montly_Refresh", "displayName": "Monthly_Refresh", "lastModifiedDate": "2025-11-26T03:45:22.000Z", "marketSegmentDefinitionId": "3HXVF000000xkJl4AI", "marketSegmentId": "1sgVF000000xHpdYAE", "parameters": [], "publishInterval": "TWENTY_FOUR", "publishScheduleEndDate": "2026-03-20T00:00:00.000Z", "publishScheduleEndDateTime": "2026-03-20T23:59:59.000Z", "publishScheduleInfo": { "daysOfMonth": [ -1 ], "frequency": "Monthly", "interval": 24, "nextScheduledDate": null, "timeInfo": null }, "publishScheduleStartDateTime": "2026-03-10T23:59:59.000Z", "segmentOnApiName": "ssot__Account__dlm", "segmentOnId": "0gjVF000000Q2XrYAK", "segmentStatus": "PROCESSING", "segmentType": "Waterfall" } ``` * **400** Missing argument, parse error, or illegal query parameter value. For example: * Invalid segment type. * _developerName_ or _displayName_ is empty. * **409** Segment already exists. ### GET Get segments by API name `GET /ssot/segments/{segmentApiName}` Tags: Segments. Returns a paginated list of segments that match the specified segment API name. **Available Version:** 56.0 #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 56.0 * `batchSize` (query, integer) Number of segments to return at one time. Values are from `1` through `200`. If unspecified, the default value is `20`. **Available Version:** 56.0 * `dataspace` (query, string) Name of the data space in which to perform the action. User must have permission to this data space. Valid when bulk-listing segments. If unspecified, the `default` data space is used. **Available Version:** 58.0 * `filters` (query, string) Filter the result set to a more narrow scope based on segment attributes. Specify a maximum of 10 filters. Separate each filter by an AND logical operator. If unspecified, no filters are applied. Supported values: * `LastPublishedEndDateTime` - Not returned in the output. Indicates the end date and time when the segment was last published. Use only the `!=` operator with this value. * `MarketSegmentType` - Matches the provided value to the field `segmentType`. * `Name` - Matches field `displayName`. * `SegmentOn` - Matches field `segmentOnApiName`. * `SegmentStatus` - Matches field `segmentStatus`. Supported operators: * `contains` - Search operator for identifying strings or substrings within a field. * `eq` - Equality operator for identifying values that match exactly. * `in` - Comparison operator for determining whether a field matches one or more specified values. * `!=` - Inequality operator for determining values that don't match. Filter examples: * `filters=Name != NULL AND Name In Seg 01,seg 02 AND Name contains seg AND Name eq seg 01` * `filters=SegmentStatus != NULL AND SegmentStatus In Processing,Active AND SegmentStatus contains ive AND SegmentStatus eq active` * `filters=MarketSegmentType != NULL AND MarketSegmentType In UI,Dbt AND MarketSegmentType contains i AND MarketSegmentType eq UI` * `filters=SegmentOn != NULL AND SegmentOn In individual,account AND SegmentOn contains ual AND SegmentOn eq Account` * `filters=SegmentOn != NULL AND SegmentOn In individual,account AND SegmentOn contains nt AND SegmentOn eq Account` * `filters=LastPublishedEndDateTime != NULL` **Available Version:** 65.0 * `offset` (query, integer) Number of segments to skip before returning results. If unspecified, no segments are skipped. **Available Version:** 56.0 * `orderby` (query, string) Sort order for the result set. Specify a field value followed by an optional sort order, `ASC` or `DESC`. For example, `Name ASC` sorts results by `Name` in ascending order, and `MarketSegmentType DESC` sorts results by `MarketSegmentType` in descending order. If unspecified, items are returned by ID in ascending order. **Available Version:** 56.0 * `segmentCreationFlow` (query, string) Flow used for segment creation. When set to `Headless`, the request is processed as a headless flow, such as a call made through a headless MCP server. If unspecified, the existing behavior is used. `Headless` is the only valid value. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentContainerOutputRepresentation`. _Example Example: same as GET /ssot/segments 200 response._ ### DELETE Delete segment `DELETE /ssot/segments/{segmentApiName}` Tags: Segments. Delete a segment in Data 360. **Available Version:** 56.0 #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 56.0 #### Responses * **204** Success ### PATCH Update segment `PATCH /ssot/segments/{segmentApiName}` Tags: Segments. Update a segment in Data 360. When updating a segment, the `sql` property is subject to validations. See [Supported Validations for DBT Segments](/docs/data/connectapi/guide/features_cdp_dbt_validations.html). **Available Version:** 56.0 **Root XML tag:** `` #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 56.0 #### Request body (required) Media type: `application/json`. Schema: `CdpSegmentInputRepresentation`. _Example: Example_ ``` { "developerName": "ConnectSegment20", "displayName": "", "description": "This is a connect API segment", "segmentOnApiName": "", "publishSchedule": "One", "publishScheduleEndDate": "", "publishScheduleStartDateTime": "", "additionalMetadata": {}, "includeDbt": { "models": { "models": [ { "name": "m1", "sql": "select ssot__Individual__dlm.ssot__Id__c from ssot__Individual__dlm where ssot__Individual__dlm.ssot__FirstName__c='john'" } ] } }, "segmentType": "Dbt" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentOutputRepresentation`. _Example: Example_ ``` { "apiName": "TestSegment20", "dataSpace": "default", "description": "This is a connect API segment", "displayName": "TestSegment20", "includeCriteria": "<DbtPipeline xmlns=""><models><model><name>m1</name><sql>select ind__dlm.Individual_Id__c, ind__dlm. KQ_Individual_Id__c from ind__dlm</sql></model></models></DbtPipeline>", "includeDbt": { "models": [ { "name": "m1", "sql": "select ind__dlm.Individual_Id__c, ind__dlm. KQ_Individual_Id__c from ind__dlm" } ] }, "marketSegmentDefinitionId": "3HXxx0000004CnMGAU", "marketSegmentId": "1sgxx00000000WHAAY", "publishInterval": "TWENTYFOUR", "publishScheduleEndDate": "2025-05-11T00:00:00.000Z", "publishScheduleStartDateTime": "2025-04-11T00:00:00.000Z", "segmentOnApiName": "ind__dlm", "segmentOnId": "0gjxx00000000eLAAQ", "segmentStatus": "PROCESSING", "segmentType": "DBT" } ``` ### POST Count segment `POST /ssot/segments/{segmentApiName}/actions/count` Tags: Segments. Trigger a segment count on demand. **Available Version:** 61.0 #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 61.0 #### Request body (required) Media type: `application/json`. Schema: `CdpSegmentActionInputRepresentation`. _Example: Example_ ``` { "preferApproxCount": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentActionOutputRepresentation`. _Example: Example_ ``` { "errors": [ {} ], "segmentId": "1sgxx00000000MbAAI", "success": true } ``` ### POST Deactivate segment by name `POST /ssot/segments/{segmentApiName}/actions/deactivate` Tags: Segments. Deactivate a segment on demand by API name. **Available Version:** 59.0 #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentActionOutputRepresentation`. _Example: Example_ ``` { "errors": [ {} ], "segmentApiName": "TestFilter", "segmentId": "1sgxx00000000UfAAI", "success": true } ``` ### GET Get segment members `GET /ssot/segments/{segmentApiName}/members` Tags: Segments. Get segment members in Data 360. **Available Version:** 58.0 #### Parameters * `segmentApiName` (path, string, required) API name of the segment. **Available Version:** 58.0 * `fields` (query, array of string) Comma-separated list of field names that you want to include in the result. If unspecified, `Id__c` is returned. Supported fields are: * `Delta_Type__c` * `Id__c` * `KQ_Id__c` * `Parent_Segment_Id__c` * `Segment_Id__c` * `Snapshot_Type__c` * `Timestamp__c` * `Version_Stamp__c` **Available Version:** 58.0 * `filters` (query, string) Filter the result set to a more narrow scope or specific type, for example, `Delta_Type__c IN ('New','Existing')`. When you filter for `Delta_Type__c`, we recommend that you also filter for `Timestamp__c`, for example, `Delta_Type__c IN ('New','Existing') AND Timestamp__c IN 2025-04-09T14:12:41.111Z`. Otherwise, the getSegmentMembers record is returned for the latest publish date; if the segment is not published, an empty result is returned. **Available Version:** 58.0 * `limit` (query, integer) Maximum number of rows to return from `1` through `1000`. If unspecified, the default number of rows is `100`. **Available Version:** 58.0 * `offset` (query, integer) Number of rows to skip before returning results. If unspecified, no rows are skipped. **Available Version:** 58.0 * `orderBy` (query, string) Sort order for the result set, such as `Segment_Id__c ASC` or `Timestamp__c DESC`. If unspecified, items are returned by ID in ascending order. Supported fields for sorting are: * `Delta_Type__c` * `Id__c` * `KQ_Id__c` * `Parent_Segment_Id__c` * `Segment_Id__c` * `Snapshot_Type__c` * `Timestamp__c` * `Version_Stamp__c` **Available Version:** 58.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentMemberOutputRepresentation`. _Example: Example_ ``` { "data": [ { "deltaType": "existing", "id": "100000", "snapshotType": "F", "timestamp": "2025-04-09T14:12:41.111Z", "versionStamp": "2025-03-29T16:29:02.402Z" }, { "deltaType": "existing", "id": "100001", "snapshotType": "F", "timestamp": "2025-04-09T14:12:41.111Z", "versionStamp": "2025-03-29T16:29:02.402Z" }, { "deltaType": "existing", "id": "100002", "snapshotType": "F", "timestamp": "2025-04-09T14:12:41.111Z", "versionStamp": "2025-03-29T16:29:02.402Z" }, { "deltaType": "existing", "id": "100003", "snapshotType": "F", "timestamp": "2025-04-09T14:12:41.111Z", "versionStamp": "2025-03-29T16:29:02.402Z" }, { "deltaType": "existing", "id": "100007", "snapshotType": "F", "timestamp": "2025-04-09T14:12:41.111Z", "versionStamp": "2025-03-29T16:29:02.402Z" } ], "endTime": "2025-04-11T15:16:10.000Z", "filter": "Delta_Type__c in ( new , existing )", "limit": 100, "offSet": 0, "orderBy": "Id__c asc", "rowCount": 5, "startTime": "2025-04-11T15:16:10.000Z", "totalCount": 5 } ``` ### GET Get segments by ID `GET /ssot/segments/{segmentId}` Tags: Segments. Returns the segments that match the specified segment ID. **Available Version:** 67.0 #### Parameters * `segmentCreationFlow` (query, string) Flow used for segment creation. When set to `Headless`, the request is processed as a headless flow, such as a call made through a headless MCP server. If unspecified, the existing behavior is used. `Headless` is the only valid value. **Available Version:** 67.0 * `segmentId` (path, string, required) ID of the segment. **Available Version:** 67.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentContainerOutputRepresentation`. _Example example1: same as GET /ssot/segments 200 response._ ### POST Deactivate segment by ID `POST /ssot/segments/{segmentId}/actions/deactivate` Tags: Segments. Deactivate a segment on demand by ID. **Available Version:** 59.0 #### Parameters * `segmentId` (path, string, required) ID of the segment. **Available Version:** 59.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentActionOutputRepresentation`. _Example: Example_ ``` { "errors": [ {} ], "segmentApiName": "TestFilter", "segmentId": "1sgxx00000000UfAAI", "success": true } ``` ### POST Publish segment `POST /ssot/segments/{segmentId}/actions/publish` Tags: Segments. Publish a segment in Data 360. This `POST` endpoint doesn't accept request parameters or a request body. **Available Version:** 58.0 #### Parameters * `segmentId` (path, string, required) ID of the segment. **Available Version:** 58.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpSegmentActionOutputRepresentation`. _Example: Example_ ``` { "errors": [ {} ], "jobId": "1f8f521f-0616-4bdf-a515-d95192475c95", "partitionId": "1sgxx00000000Pp_6157146b-467e-4c61-a62e-bac2490ae6ce", "publishStatus": "PUBLISHING", "segmentId": "1sgxx00000000PpAAI", "success": true } ``` ### GET Lookup universal ID `GET /ssot/universalIdLookup/{entityName}/{dataSourceId}/{dataSourceObjectId}/{sourceRecordId}` Tags: Universal ID Lookup. Look up objects by source ID in Data 360. **Available Version:** 54.0 #### Parameters * `sourceRecordId` (path, string, required) ID of the source record. **Available Version:** 54.0 * `dataSourceId` (path, string, required) The name of the bridge table entity. **Available Version:** 54.0 * `dataSourceObjectId` (path, string, required) ID of the data source. **Available Version:** 54.0 * `entityName` (path, string, required) ID of the data source object. **Available Version:** 54.0 #### Responses * **200** Success Media type: `application/json`. Schema: `CdpQueryDataOutputRepresentation`. ## Schemas ### ActivationExternalPlatformCollectionRepresentation Activation External Platform Collection Output Represents a collection of activation external platforms. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `platforms` (_array of ActivationExternalPlatformRepresentation_) List of activation external platforms. **Filter Group:** Small **Available Version:** 64.0 ### ActivationExternalPlatformRepresentation Activation External Platform Output Represents an activation external platform. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeConfig` (_object_) Configuration of the external platform attributes. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `ActivationExternalPlatformAttributeConfigRepresentation`. * `creationType` (_string_) Creation type for the external platform. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Json`, `Manual`. * `keyPrefixName` (_string_) Namespace prefix of the external platform. **Filter Group:** Small **Available Version:** 64.0 * `privacyType` (_string_) Privacy type for the external platform. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `NotApplicable`, `ServiceProvider`, `ThirdParty`, `UpdateFailed`. * `status` (_string_) Status of the external platform. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Active`, `Error`, `Inactive`, `Processing`. * `type` (_string_) Platform type for the external platform. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Advertising`, `Analytics`, `Marketing`, `Publishing`, `Technology`. ### ActivationPlatformsCollectionRepresentation Activation Platforms Collection Output Represents a paginated collection of activation platforms. * `activationPlatforms` (_array of ActivationPlatformSummaryRepresentation_) Activation platform summaries in this page of results. **Filter Group:** Small **Available Version:** 67.0 * `batchSize` (_integer_) Number of results returned in this page. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Starting position of this page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of activation platforms matching the query. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformCreateInputRepresentation Activation Platform Create Input Represents the input for creating an activation platform. For ISV Toolkit platforms, provide `additionalMetadata` and `customMetadata`. The `additionalMetadata.hashMethod` value is required if any activation attribute has `applyHash` set to `true`. The `additionalMetadata.partnerSupportedIds` value is required if any activation attribute uses `ContactPointDigitalId` as its `objectName`. * `activationFlowType` (_string_) Type of activation flow. **Available Version:** 67.0 Allowed values: `Dmo`, `Segment`. * `activationPlatformAttributes` (_array of ActivationPlatformAttributeInputRepresentation_) Activation attributes for data mapping. **Available Version:** 67.0 * `additionalMetadata` (_object_) Additional platform metadata, such as event configuration, mappings, and output properties. **Available Version:** 67.0 Includes all fields of `ActivationPlatformAdditionalMetadataInputRepresentation`. * `connector` (_object_) Connector configuration as key-value string pairs, such as `bucketName` and `exportDirectory`. **Available Version:** 67.0 Additional properties: `string`. * `customMetadata` (_object_) Connector credentials for toolkit-created platforms. **Available Version:** 67.0 Includes all fields of `ActivationPlatformCustomMetadataInputRepresentation`. * `description` (_string_, required) Description of the activation platform. **Available Version:** 67.0 * `fields` (_array of ActivationPlatformFieldInputRepresentation_) Configuration fields for the platform. **Available Version:** 67.0 * `identifiers` (_array of ActivationPlatformIdentifierInputRepresentation_) Platform audience identifiers. **Available Version:** 67.0 * `label` (_string_, required) Display label of the activation platform. **Available Version:** 67.0 * `logoUrl` (_string_) URL to the platform logo. **Available Version:** 67.0 * `name` (_string_, required) API name of the activation platform. **Available Version:** 67.0 * `outputFormat` (_string_, required) Format of the output files. **Available Version:** 67.0 Allowed values: `Csv`, `Json`, `Parquet`. * `outputGrouping` (_string_, required) How output files are grouped. **Available Version:** 67.0 Allowed values: `PerAccount`, `PerSegment`. * `platformType` (_string_, required) Category of the activation platform. **Available Version:** 67.0 Allowed values: `Advertising`, `Analytics`, `Marketing`, `Publishing`, `Technology`. * `refreshSettings` (_object_, required) Refresh configuration for the platform. **Available Version:** 67.0 Includes all fields of `RefreshSettingsInputRepresentation`. ### ActivationPlatformRepresentation Activation Platform Output Represents an activation platform. * `activationFlowType` (_string_) Type of activation flow. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Dmo`, `Segment`. * `activationPlatformAttributes` (_array of ActivationPlatformAttributeRepresentation_) Activation attributes for data mapping. **Filter Group:** Small **Available Version:** 67.0 * `activationPlatformCreationType` (_string_) How the platform was created. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Json`, `Manual`. * `additionalMetadata` (_object_) Additional platform metadata, such as event configuration, mappings, and output properties. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformAdditionalMetadataRepresentation`. * `canPublishNow` (_boolean_) Indicates whether the platform is ready to be published (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `connector` (_object_) Connector configuration for S3 or OAuth. **Filter Group:** Small **Available Version:** 67.0 Additional properties: `object`. * `connectorType` (_string_) Type of connector. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Oauth`, `S3`. * `createdBy` (_object_) User who created the platform. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformUserRepresentation`. * `createdDate` (_string (date-time)_) Date and time when the platform was created. **Filter Group:** Small **Available Version:** 67.0 * `customerIdTypeMapping` (_object_) Customer ID type mapping configuration. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformCustomerIdTypeMappingRepresentation`. * `description` (_string_) Description of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `enabled` (_boolean_, required) Indicates whether the activation platform is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `errorCode` (_string_) Error code returned when the status is `Error`. **Filter Group:** Small **Available Version:** 67.0 * `eventParameterHierarchyMap` (_object_) Map of valid parameter value pairings keyed by hierarchy combination, such as `Event__ActionSource`. **Filter Group:** Small **Available Version:** 67.0 Additional properties: `object`. * `eventParameters` (_array of ActivationEventParameterValuesRepresentation_) Event parameter definitions with hierarchy and allowed values. **Filter Group:** Small **Available Version:** 67.0 * `externalProvider` (_string_) External provider associated with the platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Amazon`, `Dv360`, `Facebook`, `Google`, `GoogleAdManager`, `LinkedIn`, `LinkedInCapi`, `MetaCapi`, `Pinterest`, `Snapchat`, `SnapchatCapi`, `TikTok`, `TikTokCapi`. * `fields` (_array of ActivationPlatformFieldRepresentation_) Configuration fields for the platform. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_, required) Salesforce ID of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `identifiers` (_array of ActivationPlatformIdentifierRepresentation_) Platform audience identifiers. **Filter Group:** Small **Available Version:** 67.0 * `includeSegmentNames` (_boolean_) Indicates whether segment names are included in output files (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `isStrategicPartner` (_boolean_) Indicates whether the platform is a strategic partner platform (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_, required) Display label of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `lastModifiedBy` (_object_) User who last modified the platform. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformUserRepresentation`. * `lastModifiedDate` (_string (date-time)_) Date and time when the platform was last modified. **Filter Group:** Small **Available Version:** 67.0 * `logoUrl` (_string_) URL to the platform logo for UI display. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_, required) API name of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `namespace` (_string_) Namespace prefix for managed packages. Null for unmanaged. **Filter Group:** Small **Available Version:** 67.0 * `notes` (_string_) Additional notes or admin commentary. **Filter Group:** Small **Available Version:** 67.0 * `outputFormat` (_string_) Format of the output files. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Csv`, `Json`, `Parquet`. * `outputGrouping` (_string_) How output files are grouped. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `PerAccount`, `PerSegment`. * `platformProcessingType` (_string_, required) How the platform processes activations. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Batch`, `Streaming`. * `platformType` (_string_, required) Category of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Advertising`, `Analytics`, `Marketing`, `Publishing`, `Technology`. * `privacyType` (_string_) Privacy classification of the platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `NotApplicable`, `ServiceProvider`, `ThirdParty`, `UpdateFailed`. * `refreshSettings` (_object_) Refresh configuration for the platform. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `RefreshSettingsRepresentation`. * `showEventSourceAnnotations` (_boolean_) Indicates whether event source annotations are shown in the UI (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_, required) Status of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `Error`, `Processing`. * `supportedEventTypes` (_array of string_) Supported event types for streaming platforms. **Filter Group:** Small **Available Version:** 67.0 Items: Allowed values: `Custom`, `Standard`. ### ActivationPlatformInputRepresentation Activation Platform Input Represents the input for a partial update of an activation platform. * `activationPlatformAttributes` (_array of ActivationPlatformAttributeInputRepresentation_) Activation attributes for data mapping. Replaces the full set. Any existing attributes not included are removed. **Available Version:** 67.0 * `additionalMetadata` (_object_) Additional platform metadata, such as event configuration, mappings, and output properties. **Available Version:** 67.0 Includes all fields of `ActivationPlatformAdditionalMetadataInputRepresentation`. * `connector` (_object_) Connector configuration as key-value string pairs. **Available Version:** 67.0 Additional properties: `string`. * `customMetadata` (_object_) Connector credentials for toolkit-created platforms. **Available Version:** 67.0 Includes all fields of `ActivationPlatformCustomMetadataInputRepresentation`. * `description` (_string_) Description of the activation platform. **Available Version:** 67.0 * `fields` (_array of ActivationPlatformFieldInputRepresentation_) Configuration fields for the platform. Replaces the full set. Any existing fields not included are removed. **Available Version:** 67.0 * `identifiers` (_array of ActivationPlatformIdentifierInputRepresentation_) Platform audience identifiers. Replaces the full set. Any existing identifiers not included are removed. **Available Version:** 67.0 * `label` (_string_) Display label of the activation platform. **Available Version:** 67.0 * `logoUrl` (_string_) URL to the platform logo. **Available Version:** 67.0 * `outputFormat` (_string_) Format of the output files. **Available Version:** 67.0 Allowed values: `Csv`, `Json`, `Parquet`. * `outputGrouping` (_string_) How output files are grouped. **Available Version:** 67.0 Allowed values: `PerAccount`, `PerSegment`. * `platformProcessingType` (_string_) How the platform processes activations. **Available Version:** 67.0 Allowed values: `Batch`, `Streaming`. * `refreshSettings` (_object_) Refresh configuration for the platform. **Available Version:** 67.0 Includes all fields of `RefreshSettingsInputRepresentation`. ### ActionResultRepresentation Action Result Output Represents the result of a lifecycle action, such as enable or disable. * `message` (_string_) Human-readable status or warning message. Can be null on success. **Filter Group:** Small **Available Version:** 67.0 * `success` (_boolean_) Indicates whether the action completed successfully (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 ### SetPrivacyTypeInputRepresentation Set Privacy Type Input Represents the input for setting the privacy type of an activation platform. * `privacyType` (_string_, required) Privacy type classification for the platform. **Available Version:** 67.0 Allowed values: `ThirdParty`, `ServiceProvider`, `UpdateFailed`, `NotApplicable`. ### ActionSourceCollectionRepresentation Action Source Collection Output Represents a paginated collection of action sources available for an event. Includes all fields of `CdpActivationPaginatedResponseBaseRepresentation`. * `actionSources` (_array of ActionSourceRepresentation_) List of action sources valid for the requested event. **Filter Group:** Small **Available Version:** 67.0 ### EventCollectionRepresentation Event Collection Output Represents a paginated collection of events available for a streaming activation platform. Includes all fields of `CdpActivationPaginatedResponseBaseRepresentation`. * `events` (_array of EventRepresentation_) List of events. **Filter Group:** Small **Available Version:** 67.0 ### PartnerObjectTypeCollectionRepresentation Partner Object Type Collection Output Represents a paginated collection of partner-object types available for a streaming activation platform. Includes all fields of `CdpActivationPaginatedResponseBaseRepresentation`. * `partnerObjectTypes` (_array of PartnerObjectTypeRepresentation_) List of partner-object types available for the platform. **Filter Group:** Small **Available Version:** 67.0 ### ActivationTargetCollectionRepresentation Activation Target Collection Output Activation target container. * `activationTargets` (_array of ActivationTargetRepresentation_) List of all activation targets. **Filter Group:** Small **Available Version:** 60.0 * `offset` (_integer_) Number of records skipped before returning results. **Filter Group:** Small **Available Version:** 60.0 * `batchSize` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 60.0 * `orderByExpression` (_string_) Expression to define the sort order of records. **Filter Group:** Small **Available Version:** 60.0 ### ActivationTargetInputRepresentation Activation Target Input Represents the activation target input. * `connector` (_object_) Details of the connector used for the activation target. **Available Version:** 60.0 Includes all fields of `DataConnectorInputRepresentation`. * `dataSpaceName` (_string_, required) Name of the data space for the activation target. **Available Version:** 60.0 * `description` (_string_) Description for the activation target. **Available Version:** 60.0 * `isCappingEnabled` (_boolean_) Indicates whether communication capping is enabled (`true`) or not (`false`). **Available Version:** 60.0 * `egressProperties` (_object_) Egress properties for the activation target, which are applicable only for file-based activation targets. **Available Version:** 60.0 Includes all fields of `EgressPropertiesInputRepresentation`. * `name` (_string_, required) Name of the activation target. **Available Version:** 60.0 * `platformType` (_string_) Platform type for the activation target. **Available Version:** 60.0 Allowed values: `AccountEngagement`, `AmazonS3`, `AmazonS3V2`, `AwsKinesisDS`, `AzureBlob`, `BigQuery`, `ConnectorsFramework`, `ConversationStorage`, `CuratedEntity`, `DataCloud`, `ExternalPlatform`, `Generic`, `GoogleCloudStorage`, `Ibm`, `IngestApi`, `RedShift`, `S3Arn`, `SalesforceCommerceCloud`, `SalesforceDotCom`, `SalesforceInteractionStudio`, `SalesforceMarketingCloud`, `Sftp`, `Snowflake`, `StreamingApp`, `StreamingFlow`, `Upload`. ### ActivationTargetRepresentation Activation Target Output Represents a list of all activation targets. Includes all fields of `CdpAssetBaseRepresentation`. * `connector` (_object_) Details about the connector that is used for the activation target. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataConnectorRepresentation`. * `dataSpaceName` (_string_) Data space name for this activation target. **Filter Group:** Small **Available Version:** 60.0 * `description` (_string_) Description of the activation target. **Filter Group:** Small **Available Version:** 60.0 * `egressProperties` (_object_) Egress properties for the activation target, which are applicable only for file-based activation targets. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `EgressPropertiesRepresentation`. * `historyAudienceDmoApiName` (_string_) API name for the history audience DMO. **Filter Group:** Small **Available Version:** 60.0 * `historyAudienceDmoLabel` (_string_) Name of the history audience DMO. **Filter Group:** Small **Available Version:** 60.0 * `isCappingEnabled` (_boolean_) Indicates whether communication capping is enabled for the activation (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `isEnabled` (_boolean_) Indicates whether the activation target is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `latestAudienceDmoApiName` (_string_) API name for the latest audience DMO. **Filter Group:** Small **Available Version:** 62.0 * `latestAudienceDmoLabel` (_string_) Name of the latest audience DMO. **Filter Group:** Small **Available Version:** 62.0 * `organizationId` (_string_) Organization ID of the activation target. **Filter Group:** Small **Available Version:** 60.0 * `platformName` (_string_) Platform name for the activation target. **Filter Group:** Small **Available Version:** 60.0 * `platformPrivacyType` (_string_) Platform privacy type for the activation target. Derived from Activation Platform. **Filter Group:** Small **Available Version:** 60.0 * `platformType` (_string_) Platform type for the activation target. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `AccountEngagement`, `AmazonS3`, `AmazonS3V2`, `AwsKinesisDS`, `AzureBlob`, `BigQuery`, `ConnectorsFramework`, `ConversationStorage`, `CuratedEntity`, `DataCloud`, `ExternalPlatform`, `Generic`, `GoogleCloudStorage`, `Ibm`, `IngestApi`, `RedShift`, `S3Arn`, `SalesforceCommerceCloud`, `SalesforceDotCom`, `SalesforceInteractionStudio`, `SalesforceMarketingCloud`, `Sftp`, `Snowflake`, `StreamingApp`, `StreamingFlow`, `Upload`. * `status` (_string_, required) Target status of the activation target. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Processing`, `Error`, `Inactive`. ### AssignAdAccountInputRepresentation Assign Ad Account Input Represents the input for assigning an ad account to a target. * `accountNumber` (_string_, required) Ad account number to assign. **Available Version:** 67.0 * `dataSpace` (_string_, required) Name of the data space to associate with the ad account. **Available Version:** 67.0 * `managerAccountId` (_string_) Manager account ID for the ad account. **Available Version:** 67.0 ### ActivationTargetPlatformsCollectionRepresentation Activation Target Platforms Collection Output Represents a collection of activation target platforms. * `activationTargetPlatforms` (_array of ActivationTargetPlatformRepresentation_) Activation target platforms in this page of results. **Filter Group:** Small **Available Version:** 67.0 * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingDataSpacesCollectionRepresentation Communication Capping Data Spaces Collection Output Represents a collection of communication-capping data spaces. * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `dataSpaces` (_array of CommunicationCappingDataSpaceRepresentation_) Data spaces linked to communication-capping definitions. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### DataspaceAccountValidationRepresentation Dataspace Account Validation Output Represents the result of checking whether an ad account is available in a data space. * `available` (_boolean_) Indicates whether the ad account is available, meaning not already assigned (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 ### McEnterprisesCollectionRepresentation Mc Enterprises Collection Output Represents a collection of Marketing Cloud enterprises. * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `enterprises` (_array of McEnterpriseRepresentation_) Marketing Cloud enterprises with their business units. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformFieldsRepresentation Activation Platform Fields Output Represents a collection of target-level configuration fields for an activation platform. * `platformFields` (_array of ActivationPlatformFieldRepresentation_) Target-level configuration fields defined by the platform. **Filter Group:** Small **Available Version:** 67.0 ### AdAccountsRepresentation Ad Accounts Output Represents a collection of ad accounts. * `adAccounts` (_array of AdAccountRepresentation_) Ad accounts from the partner platform. **Filter Group:** Small **Available Version:** 67.0 ### PartnerObjectsCollectionRepresentation Partner Objects Collection Output Represents a cursor-paginated collection of partner objects. * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `partnerObjects` (_array of PartnerObjectRepresentation_) Partner objects in this page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### ActivationCollectionRepresentation Activation Collection Output Represents a collection of activations. * `activations` (_object_) List of all activations. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ActivationRepresentation`. * `batchSize` (_integer_) Number of results returned. Default is 20. **Filter Group:** Small **Available Version:** 60.0 * `offset` (_integer_) Number of records to skip for the next request. **Filter Group:** Small **Available Version:** 60.0 * `orderByExpression` (_string_) Sort order for the result set. **Filter Group:** Small **Available Version:** 60.0 ### ActivationDefinitionInputRepresentation Activation Definition Input Represents the activation definition input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `activationMappingSchema` (_string_) Type of identifier to use for activation audience matching, such as `PII` or `ANON`. **Filter Group:** Small **Available Version:** 65.0 * `activationTargetName` (_string_) Name for the activation target. Either activationTargetName or dataExportDefinitionId must be present. **Available Version:** 60.0 * `activationTargetSubjectConfig` (_object_) Subject configuration for the activation target. **Available Version:** 60.0 Includes all fields of `ActivationTargetSubjectConfigInputRepresentation`. * `activationType` (_string_) Type of activation. If unspecified, defaults to `Segment`. **Available Version:** 66.0 Allowed values: `ApiTriggered`, `Dmo`, `Segment`. * `attributeLimitingExpressionConfig` (_object_) Limiting expression configuration for the activation. **Available Version:** 63.0 Includes all fields of `AttributeLimitingExpressionInputConfigRepresentation`. * `attributesConfig` (_array of AttributesConfigInputRepresentation_) Additional attributes for the activation. The `activateOn` attribute must be present. **Available Version:** 60.0 * `contactPointsConfig` (_array of ContactPointConfigInputRepresentation_) Contact points configuration for the activation target. **Available Version:** 60.0 * `curatedEntity` (_object_) Curated entity details for the activation. **Available Version:** 63.0 Includes all fields of `CuratedEntityInputRepresentation`. * `customerFileSource` (_string_) Customer file source for the activation target. **Available Version:** 60.0 Allowed values: `FirstAndThirdParty`, `FirstParty`, `ThirdParty`. * `dataExportDefinitionId` (_string_) Activation target ID for the activation. Either activationTargetName or dataExportDefinitionId must be present. **Available Version:** 60.0 * `dataSourcesConfig` (_array of ActivationDataSourceConfigInputRepresentation_) Data source configuration for the activation. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space for the activation. **Available Version:** 60.0 * `description` (_string_) Description of the activation. **Available Version:** 60.0 * `developerName` (_string_) Developer name of the activation. Must be unique. The request fails if an activation with the same developer name already exists. **Available Version:** 67.0 * `directDmoFiltersConfig` (_array of DMOFilterConfigInputRepresentation_) Direct DMO filters. **Available Version:** 60.0 * `limitValue` (_integer_) Audience limit value for the activation. **Available Version:** 63.0 * `marketSegmentId` (_string_) Segment ID of the segment the activation needs to be created against. Either marketSegmentId or segmentApiName must be present. Exclude this property for `ApiTriggered` activation types. **Available Version:** 60.0 * `name` (_string_) Name of the activation. **Available Version:** 60.0 * `processingType` (_string_) Processing type for DMO activations. Required when activationType is `DMO`. **Available Version:** 67.0 Allowed values: `Batch`. * `refreshType` (_string_, required) Indicates the refresh type for the activation, (`Full` or `Incremental`). **Available Version:** 60.0 * `relatedDmoFiltersConfig` (_array of DMOFilterConfigInputRepresentation_) DMO filters on related attributes for the activation. **Available Version:** 60.0 * `segmentApiName` (_string_) Developer name of the segment. Either marketSegmentId or segmentApiName must be present. Exclude this property for `ApiTriggered` activation types. **Available Version:** 60.0 * `shouldExcludeDeletes` (_boolean_) Indicates whether to exclude records removed since the last refresh (`true`) or not (`false`). **Available Version:** 60.0 * `shouldExcludeUpdates` (_boolean_) Indicates whether to exclude records modified since the last refresh (`true`) or not (`false`). **Available Version:** 60.0 * `sourceDmoName` (_string_) Developer name of the source DMO. Required for `ApiTriggered` activation types. Exclude this property for `Segment` activation types. **Available Version:** 66.0 * `staticDataConfig` (_array of StaticDataConfigInputRepresentation_) Configuration of campaign data attributes for an activation, which are name-value pairs including standard attributes (system-defined) and custom attributes (user-defined). Standard attributes are resolved by the system at activation run time and added as separate columns in the activation output. The available standard attributes are Activation Name, Activation ID, Segment Name, Segment ID, Activation Publish Start Time, and Activation Run ID. Standard attributes improve traceability, reconciliation, auditability, time-based processing, and disambiguation when multiple activations write to overlapping destinations. To use a standard attribute, select the exact standard attribute name and its corresponding value in the name-value pair. **Available Version:** 60.0 * `waterfallSelectedChildSegmentsConfig` (_object_) Details about the selected Waterfall child segments. Required when segmentApiName references a Waterfall segment type; must not be present otherwise. **Available Version:** 67.0 Includes all fields of `WaterfallSelectedChildSegmentsConfigInputRepresentation`. ### ActivationRepresentation Activation Output Represents an activation. Includes all fields of `CdpAssetBaseRepresentation`. * `activationDefinitionId` (_string_) ID of the activation definition. **Filter Group:** Small **Available Version:** 60.0 * `activationMappingSchema` (_string_) Type of identifier to use for activation audience matching, such as `PII` or `ANON`. **Filter Group:** Small **Available Version:** 63.0 * `activationRecordSchema` (_string_) JSON schema representing the activation JSON payload in the activationRecord field of the AudienceDMO. **Filter Group:** Small **Available Version:** 62.0 * `activationTarget` (_object_, required) Activation target details. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ActivationTargetRepresentation`. * `activationTargetSubjectConfig` (_object_, required) Activation target subject for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ActivationTargetSubjectRepresentation`. * `activationType` (_string_) Type of activation. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `ApiTriggered`, `Dmo`, `Segment`. * `attributeLimitingExpressionConfig` (_object_) Limiting expression configuration for the activation. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `AttributeLimitingExpressionConfigRepresentation`. * `attributesConfig` (_object_, required) Attributes for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ActivationAttributesConfigRepresentation`. * `contactPointsConfig` (_object_, required) Contact points for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ContactPointsConfigRepresentation`. * `curatedEntity` (_object_, required) Curated entity object details for the activation. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `customerFileSource` (_string_) Customer file source of the activation platform. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `First_And_Third_Party`, `First_Party`, `Third_Party`. * `dataSourcesConfig` (_object_, required) Data sources for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ActivationDataSourcesRepresentation`. * `dataSpaceName` (_string_, required) Data space name for the activation. **Filter Group:** Small **Available Version:** 60.0 * `description` (_string_) Description of the activation. **Filter Group:** Small **Available Version:** 60.0 * `developerName` (_string_) Developer name for the activation. **Filter Group:** Small **Available Version:** 60.0 * `directDmoFiltersConfig` (_object_) Direct DMO filters for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DmoFiltersConfigRepresentation`. * `enabled` (_boolean_) Indicates whether the activation is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `historyAudienceDmoApiName` (_string_) API name for the history audience DMO. **Filter Group:** Small **Available Version:** 60.0 * `historyAudienceDmoLabel` (_string_) Name of the history audience DMO. **Filter Group:** Small **Available Version:** 60.0 * `isEnabled` (_boolean_) Indicates whether the activation is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `lastPublishDate` (_string_) Last publish timestamp of the activation. Use the format `yyyy-mm-dd`. **Filter Group:** Small **Available Version:** 60.0 * `lastPublishStatus` (_string_, required) Last publish status of the activation. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Error`, `Partner_Error`, `Partner_Processing`, `Publishing`, `Queued`, `Segment_Error`, `Skipped`, `Success`. * `lastPublishStatusErrorMsg` (_string_) Error message encountered during last publish. **Filter Group:** Small **Available Version:** 60.0 * `latestAudienceDmoApiName` (_string_) API name for the latest audience DMO. **Filter Group:** Small **Available Version:** 62.0 * `latestAudienceDmoLabel` (_string_) Name for the latest audience DMO. **Filter Group:** Small **Available Version:** 62.0 * `latestAudienceDmoLastRunTimestamp` (_string_) Timestamp of the last run for the latest audience DMO. Use the format `yyyy-mm-dd`. **Filter Group:** Small **Available Version:** 62.0 * `limitValue` (_integer_) Audience limit value for the activation. **Filter Group:** Small **Available Version:** 63.0 * `marketSegmentId` (_string_) Segment ID of the activation. Returned for `Segment` type activations. **Filter Group:** Small **Available Version:** 60.0 * `membershipName` (_string_) Membership name of the activation. **Filter Group:** Small **Available Version:** 60.0 * `processingType` (_string_) Processing type for DMO activations. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Batch`. * `queryPathConfig` (_object_, required) Query path for the activation target. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `QueryPathConfigListRepresentation`. * `refreshType` (_string_, required) Refresh type of the activation. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Full_Refresh`, `Incremental`. * `relatedDmoFiltersConfig` (_object_) DMO filters on related attributes for the activation. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DmoFiltersConfigRepresentation`. * `segmentApiName` (_string_) Segment API name. Returned for `Segment` type activations. **Filter Group:** Small **Available Version:** 60.0 * `segmentId` (_string_) Segment ID of the activation. Returned for `Segment` type activations. **Filter Group:** Small **Available Version:** 60.0 * `shouldExcludeDeletes` (_boolean_, required) Indicates whether to exclude records removed since the last refresh (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `shouldExcludeUpdates` (_boolean_) Indicates whether to exclude records modified since the last refresh (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoName` (_string_) Developer name of the source DMO. **Filter Group:** Small **Available Version:** 66.0 * `staticDataConfig` (_object_) Campaign data attributes configuration for an activation, which includes both standard attributes (system-defined) and custom attributes (user-defined). **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `StaticDataConfigRepresentation`. * `status` (_string_) Status of the activation. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Processing`, `Error`, `Inactive`. * `waterfallSelectedChildSegmentsConfig` (_object_) Details about the selected Waterfall child segments. Required when segmentApiName references a Waterfall segment type; must not be present otherwise. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `WaterfallSelectedChildSegmentsConfigRepresentation`. ### ActivatableDataObjectCategoriesRepresentation Activatable Data Object Categories Output Represents the data object category types that can be activated. * `categories` (_array of string_) List of category type identifiers that are available for activation, such as Profile, Engagement, and Other. **Filter Group:** Small **Available Version:** 67.0 ### ChannelPreferencesRepresentation Channel Preferences Output Represents the available channel preferences for a channel and data model object (DMO) pair, which determine the contact point type to activate on. * `preferences` (_array of ChannelPreferenceRepresentation_) Channel preference options. **Filter Group:** Small **Available Version:** 67.0 ### ChannelsCollectionRepresentation Channels Collection Output Represents a collection of contact-point delivery channels. * `channels` (_array of ChannelRepresentation_) Channels available for activation. **Filter Group:** Small **Available Version:** 67.0 * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### ConsentDataModelObjectsRepresentation Consent Data Model Objects Output Represents the standard consent data model objects (DMOs) associated with a data space. * `dataModelObjects` (_array of string_) Consent data model object (DMO) developer names. Currently always two entries: `contactPointConsent` and `communicationSubscriptionConsent`. **Filter Group:** Small **Available Version:** 67.0 ### DataSourcesCollectionRepresentation Data Sources Collection Output Represents a collection of data sources. * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `dataSources` (_array of DataSourceRepresentation_) Data sources in this page of results. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available; absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of records matching the query across all pages. **Filter Group:** Small **Available Version:** 67.0 ### RelatedAttributeActivationQuotaRepresentation Related Attribute Activation Quota Output Represents the org-wide usage and limit for related-attribute activations. * `currentActivations` (_integer_) Number of related-attribute activations currently in use. **Filter Group:** Small **Available Version:** 67.0 * `hasMetLimit` (_boolean_) Indicates whether `currentActivations` has reached `maxActivations` (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `maxActivations` (_integer_) Maximum number of related-attribute activations allowed for the org. **Filter Group:** Small **Available Version:** 67.0 ### RelatedAttributeConfigurationLimitsRepresentation Related Attribute Configuration Limits Output Represents the structural and per-activation configuration limits for related-attribute activations. * `attributesPerActivation` (_integer_) Maximum number of related attributes allowed per activation. **Filter Group:** Small **Available Version:** 67.0 * `dataModelObjectsPerActivation` (_integer_) Maximum number of data model objects (DMOs) referenced by a single activation. **Filter Group:** Small **Available Version:** 67.0 * `dataModelObjectsPerHop` (_integer_) Maximum number of data model objects (DMOs) that can be joined through per relationship hop. **Filter Group:** Small **Available Version:** 67.0 * `maxHops` (_integer_) Maximum number of relationship hops allowed in a single related-attribute path. **Filter Group:** Small **Available Version:** 67.0 * `maxSegmentSize` (_integer_) Maximum allowed segment size. **Filter Group:** Small **Available Version:** 67.0 * `valuesPerAttribute` (_integer_) Maximum number of distinct values allowed per attribute. **Filter Group:** Small **Available Version:** 67.0 ### MatchBoostProvidersRepresentation Match Boost Providers Output Represents identity-provider metadata for the activation builder. * `providers` (_array of MatchBoostProviderRepresentation_) Identity providers available for match-boost. **Filter Group:** Small **Available Version:** 67.0 ### StreamingEligibilityRepresentation Streaming Eligibility Output Represents whether streaming activation is allowed for a given data model object (DMO) and, if not, the reason. * `allowed` (_boolean_) Indicates whether streaming activation is allowed for the requested data model object (DMO) (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `reason` (_string_) Human-readable explanation when `allowed` is `false`. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPublishActionInputRepresentation Activation Publish Action Input Represents a Batch DMO activation publish job input. * `fullRefresh` (_boolean_) Indicates whether the activation publish type is a full refresh (`true`) or incremental (`false`). > **Note:** Execution behavior varies by DMO configuration. > > **For Full Refresh DMOs**: Always performs a full refresh, regardless of this value. > > **For Incremental DMOs**: > > * _Initial publish (day 0)_: Always performs a full refresh, regardless of this value. > * _Subsequent publishes_: Defaults to incremental if `false` or omitted. Set to `true` to force a full refresh. **Available Version:** 66.0 ### ActivationPublishActionRepresentation Activation Publish Action Output Represents output for a Batch DMO activation publish job. Includes all fields of `CdpActionResponseBaseRepresentation`. * `publishStatus` (_string_) Publish status of the activation. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Error`, `NotSupported`, `PartnerError`, `PartnerProcessing`, `Publishing`, `Queued`, `SegmentError`, `Skipped`, `Success`. ### AudienceDMOCollectionRepresentation Audience DMO Collection Output Represents a collection of activation records from Audience data model objects (DMOs). * `batchSize` (_integer_) Number of results returned. Default is 10000. Max is 49999. **Filter Group:** Small **Available Version:** 61.0 * `data` (_array of ActivationDataRepresentation_) List of activation records in an Audience data model object (DMO). **Filter Group:** Small **Available Version:** 61.0 * `offset` (_integer_) Number of records to skip for the next request. Max is 10 million. **Filter Group:** Small **Available Version:** 61.0 ### ActivationHistoryCollectionRepresentation Activation History Collection Output Represents a page of activation publish-history records. * `currentPageUrl` (_string (url)_) URL of the current page request, suitable for re-fetching the same page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page when more records are available. Absent on the last page. **Filter Group:** Small **Available Version:** 67.0 * `records` (_array of ActivationHistoryRecordRepresentation_) Publish-history records in the page. Most-recent-first by default. **Filter Group:** Small **Available Version:** 67.0 * `totalPages` (_integer_) Total number of pages available for the query at the current page size. A next page exists while the current page index, derived from offset and limit, is below this value. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Number of publish-history records returned in the page. Because a grand total record count isn't returned, this value reflects the current page only. Use `totalPages` for the full pagination extent, and follow `nextPageUrl` to page through results. **Filter Group:** Small **Available Version:** 67.0 ### AgentCollectionRepresentation Agent Collection Output Represents a list of agents. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `agents` (_array of AgentRepresentation_) List of agents. **Filter Group:** Small **Available Version:** 66.0 * `limit` (_integer_) Number of records returned in the response. **Filter Group:** Small **Available Version:** 66.0 * `offset` (_integer_) Number of records to skip for the next request. **Filter Group:** Small **Available Version:** 66.0 ### AgentInputRepresentation Agent Input Represents the input for an agent. Includes all fields of `CdpObjectBaseInputRepresentation`. * `configuration` (_object_) Configuration of the agent. **Available Version:** 66.0 Includes all fields of `AgentConfigurationInputRepresentation`. ### AgentRepresentation Agent Output Represents an agent. Includes all fields of `CdpAssetBaseRepresentation`. * `configuration` (_object_) Configuration of the agent. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `AgentConfigurationRepresentation`. * `dataspaceName` (_string_) Name of the data space that the agent belongs to. **Filter Group:** Small **Available Version:** 66.0 * `setupName` (_object_) Name of the agent setup. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `status` (_string_) Status of the agent. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Active`, `Error`, `Processing`. ### CdpCalculatedInsightCollectionRepresentation Calculated Insight Collection Output Container of a calculated insights page. * `collection` (_object_) Collection of calculated insights. **Filter Group:** Small **Available Version:** 57.0 Includes all fields of `CdpCalculatedInsightCollectionDataRepresentation`. ### CdpCalculatedInsightInputRepresentation Calculated Insight Input Input representation for a calculated insight. * `apiName` (_string_) API name of the calculated insight with suffix \_\_cio. Required for POST. Optional for PATCH. **Available Version:** 57.0 * `createdFromPackage` (_boolean_) Specifies whether the calculated insight was created from an installed package (`true`) or not (`false`). **Available Version:** 57.0 * `dataSpaceName` (_string_) Name of the data space. **Available Version:** 57.0 * `definitionType` (_string_) Definition type of the calculated insight. Required for POST. Optional for PATCH. **Available Version:** 57.0 Allowed values: `CALCULATED_METRIC`, `EXTERNAL_METRIC`, `STREAMING_METRIC`. * `description` (_string_) Calculated insight description. **Available Version:** 57.0 * `displayName` (_string_) Calculated insight display name. Required for POST. Optional for PATCH. **Available Version:**\* 57.0 * `draft` (_boolean_) Specifies whether to save the calculated insight as draft (`true`) or not (`false`). **Available Version:** 57.0 * `expression` (_string_) Calculated insight ANSI SQL expression. Required for POST. Optional for PATCH. **Available Version:** 57.0 * `packagedCalculatedInsightApiName` (_string_) API name of the packaged calculated insight. **Available Version:** 57.0 * `publishScheduleEndDate` (_string_) The date and time after which the calculated insight is no longer run. * Use the format `yyyy-mm-dd`. * Must be a date later than `publishScheduleStartDateTime`. * Don't use with streaming insights. * Don't use if the `publishScheduleInterval` is `No Schedule`. **Available Version:** 62.0 * `publishScheduleInterval` (_string_, required) Indicates how frequently the calculated insight is processed. Required for calculated insights. Don't use with streaming insights. **Available Version:** 62.0 Allowed values: `ExternallyManaged`, `NotScheduled`, `One`, `Six`, `Streaming`, `SystemManaged`, `Twelve`, `TwentyFour`. * `publishScheduleStartDateTime` (_string_, required) The date and time when the calculated insight is evaluated to be run. * Use the format `yyyy-mm-dd`. * The specified date and time must be in the future. * Required if `publishScheduleInterval` is any value other than `No Schedule`. * Don't use with streaming insights. **Available Version:** 62.0 ### CdpCalculatedInsightRepresentation Calculated Insight Output Represents a calculated insight. * `apiName` (_string_) API name of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `calculatedInsightStatus` (_string_) Status of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `creationType` (_string_) Creation type of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `dataSpace` (_string_) Data space of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `definitionStatus` (_string_) Definition status of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `definitionType` (_string_) Definition type of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `description` (_string_) Description of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `dimensions` (_array of CdpCalculatedInsightDimensionRepresentation_) Dimensions of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `displayName` (_string_) Display name of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `expression` (_string_) Expression of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `isEnabled` (_boolean_) Specifies whether the calculated insight is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 57.0 * `lastCalcInsightStatusDateTime` (_string_) Last calculated insight status date and time. **Filter Group:** Small **Available Version:** 57.0 * `lastCalcInsightStatusErrorCode` (_string_) Last calculated insight status error code. **Filter Group:** Small **Available Version:** 57.0 * `lastRunDateTime` (_string_) Last run date and time of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `lastRunStatus` (_string_) Last run status of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `lastRunStatusDateTime` (_string_) Last run status date and time of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `lastRunStatusErrorCode` (_string_) Last run status error code of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 * `measures` (_array of CdpCalculatedInsightMeasureRepresentation_) Measures of the calculated insight. **Filter Group:** Small **Available Version:** 57.0 ### CdpCalculatedInsightStandardActionResponseRepresentation Calculated Insight Standard Action Response Output Response for a calculated insight run action. Includes all fields of `CdpActionResponseBaseRepresentation`. ### CommunicationCappingEntityInputRepresentation Communication Capping Entity Input Represents the input for creating or updating a communication capping configuration. * `dataCommCapDataSpaces` (_array of CommunicationCappingDataSpaceInputRepresentation_) Data spaces to associate with the configuration. **Available Version:** 67.0 * `dataCommCapRelatedDims` (_array of CommunicationCappingRelatedDimInputRepresentation_) Related dimensions for the configuration. **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the communication capping definition. Null when creating and set when updating. **Available Version:** 67.0 * `description` (_string_) Description of the communication capping configuration. **Available Version:** 67.0 * `id` (_string_) ID of the communication capping instance. **Available Version:** 67.0 * `name` (_string_) Name of the communication capping configuration. **Available Version:** 67.0 ### CommunicationCappingEntityRepresentation Communication Capping Entity Output Represents a communication capping entity. * `dataCommCapDataSpaces` (_array of CommunicationCappingDataSpaceRepresentation_) Data spaces associated with the configuration. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapRelatedDims` (_array of CommunicationCappingRelatedDimRepresentation_) Related dimensions for the configuration. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the communication capping definition. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapStatus` (_string_) Status of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the communication capping instance. **Filter Group:** Small **Available Version:** 67.0 * `lastStatusDateTime` (_string (date-time)_) Date and time of the last status change. **Filter Group:** Small **Available Version:** 67.0 * `lastStatusErrorCode` (_string_) Last status error code. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Name of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingActivationTargetCollectionRepresentation Communication Capping Activation Target Collection Output Represents a collection of communication capping activation targets. * `activationTargets` (_array of CommunicationCappingActivationTargetRepresentation_) List of communication capping activation targets. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingActivationTargetInputRepresentation Communication Capping Activation Target Input Represents the input for mapping dimension metadata to a communication capping activation target. * `activationTargetName` (_string_) Name of the activation target. **Available Version:** 67.0 * `dataCommCapDimInfo` (_array of CommunicationCappingActivationTargetDimInputRepresentation_) List of dimension and dimension value associations for the activation target. **Available Version:** 67.0 ### CommunicationCappingDimCollectionRepresentation Communication Capping Dim Collection Output Represents a collection of communication capping dimensions. * `dimensions` (_array of CommunicationCappingDimRepresentation_) List of communication capping dimensions. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingDimInputRepresentation Communication Capping Dim Input Represents the input for creating or updating a communication capping dimension. * `apiName` (_string_) API name of the dimension. **Available Version:** 67.0 * `dimensionName` (_string_) API name of the dimension object. **Available Version:** 67.0 * `dimensionValues` (_array of CommunicationCappingDimValueInputRepresentation_) Values for the dimension. **Available Version:** 67.0 * `functionType` (_string_) Function type of the dimension. **Available Version:** 67.0 * `hierarchyOrder` (_integer_) Hierarchy order of the dimension. **Available Version:** 67.0 * `id` (_string_) ID of the dimension. **Available Version:** 67.0 * `name` (_string_) Name of the dimension. **Available Version:** 67.0 ### CommunicationCappingDimRepresentation Communication Capping Dim Output Represents a communication capping dimension. * `apiName` (_string_) API name of the dimension. **Filter Group:** Small **Available Version:** 67.0 * `dimensionName` (_string_) API name of the dimension object. **Filter Group:** Small **Available Version:** 67.0 * `dimensionValues` (_array of CommunicationCappingDimValueRepresentation_) Values for the dimension. **Filter Group:** Small **Available Version:** 67.0 * `functionType` (_string_) Function type of the dimension. **Filter Group:** Small **Available Version:** 67.0 * `hierarchyOrder` (_integer_) Hierarchy order of the dimension. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character ID of the dimension. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Name of the dimension. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingDimPriorityInputRepresentation Communication Capping Dim Priority Input Represents the input for updating the priority order of communication capping dimensions. * `dimensions` (_array of CommunicationCappingDimInputRepresentation_) Ordered list of dimensions to update the priority for. **Available Version:** 67.0 ### CommunicationCappingRepresentation Communication Capping Output Represents a communication capping configuration. * `dataspacesInfo` (_array of object_) Data spaces associated with the configuration. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `dimensions` (_array of object_) Dimensions for the configuration. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Label of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) API name of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Status of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingActionResponseRepresentation Communication Capping Action Response Output Represents the standard action response for communication capping. * `errors` (_array of object_) Errors that resulted from the action. **Filter Group:** Small **Available Version:** 67.0 * `success` (_boolean_) Indicates whether the call was successful (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingRuleCollectionRepresentation Communication Capping Rule Collection Output Represents a collection of communication capping rules. * `rules` (_array of CommunicationCappingRuleRepresentation_) List of communication capping rules. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingRuleInputRepresentation Communication Capping Rule Input Represents the input for creating or updating a communication capping rule. * `apiName` (_string_) API name of the rule. **Available Version:** 67.0 * `dataCommCapRuleDim` (_array of CommunicationCappingRuleDimInputRepresentation_) Dimension associations for the rule. **Available Version:** 67.0 * `endDate` (_string (date-time)_) End date of the rule. **Available Version:** 67.0 * `limits` (_integer_) Capping limit value. **Available Version:** 67.0 * `startDate` (_string (date-time)_) Start date of the rule. **Available Version:** 67.0 ### CommunicationCappingRuleRepresentation Communication Capping Rule Output Represents a communication capping rule. * `apiName` (_string_) API name of the rule. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapRuleDim` (_array of CommunicationCappingRuleDimRepresentation_) Dimension associations for the rule. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the parent communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `endDate` (_string (date-time)_) End date of the rule. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character ID of the rule. **Filter Group:** Small **Available Version:** 67.0 * `limits` (_integer_) Capping limit value. **Filter Group:** Small **Available Version:** 67.0 * `source` (_string_) Source of the rule. **Filter Group:** Small **Available Version:** 67.0 * `startDate` (_string (date-time)_) Start date of the rule. **Filter Group:** Small **Available Version:** 67.0 ### ConnectionCollectionRepresentation Connection Collection Output Information about the collection of connections in an org. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `connections` (_array of ConnectionRepresentation_, required) List of information about the connections in the org. **Filter Group:** Small **Available Version:** 60.0 ### ConnectionInputRepresentation Connection Input Abstract superclass for all connection input types. * `connectorType` (_string_, required) The type of the Data Connector Framework (DCF) connector. For **create connection** and **replace connection**, allowable connector types are `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `StreamingApp`, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `Sftp`, and so forth. Use the connection input object that corresponds to the schema type: * `IngestApi`: Ingest API Connection Input * `SalesforceDotCom`: CRM Connection Input * `SalesforceMarketingCloud`: Marketing Cloud Connection Input * `StreamingApp`: Streaming App Connection Input * All others: Data Connection Input For **update connection**, allowable connector types are `SalesforceMarketingCloud` or `StreamingApp`. Use the connection patch input object that corresponds to the schema type: * `SalesforceMarketingCloud`: Marketing Cloud Connection Patch Input * `StreamingApp`: Streaming App Connection Patch Input **Available Version:** 60.0 * `label` (_string_) Label of the connector. **Available Version:** 60.0 * `name` (_string_) Developer name of the connector. **Available Version:** 60.0 ### ConnectionRepresentation Connection Output Abstract superclass for all connection output types. * `connectorType` (_string_, required) The type of the Data Connector Framework (DCF) connector. The endpoint returns the connection output object that corresponds to the connector type: * `AccountEngagement`: Account Engagement Connection Output * `IngestApi`: Ingest API Connection Output * `SalesforceDotCom`: CRM Connection Output * `SalesforceMarketingCloud`: Marketing Cloud Connection Output * `StreamingApp`: Streaming App Connection Output * All others: Data Connection Output **Filter Group:** Small **Available Version:** 60.0 ### ConnectionPatchInputRepresentation Connection Patch Input Abstract input representation superclass for all connector types. Used by the [update connection](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=patchConnection) endpoint. Includes all fields of `ConnectionInputRepresentation`. ### ConnectionDbSchemaCollectionInputRepresentation Connection DB Schema Collection Input Input representation for a collection of database schemas for a connection. * `advancedAttributes` (_object_) Comma-separated list of additional parameters to fetch the database schemas. Specify additional parameters in the form `"key": "value"`, where the key, for example, is `databaseName`. The list of parameter keys varies by connector and can include database names and other connector-specific properties. Use the [get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnectorMetadata) endpoint to discover the supported keys. Specify an empty object if no additional parameters are needed. **Available Version:** 63.0 Additional properties: `string`. ### ConnectionDbSchemaCollectionRepresentation Connection DB Schema Collection Output Representation for a collection of database schemas for a connection. * `databaseSchemas` (_array of string_) List of database schemas for the connection. **Filter Group:** Small **Available Version:** 63.0 ### ConnectionDatabaseCollectionRepresentation Connection Database Collection Output Representation for a collection of database names for a connection. * `databases` (_array of string_) List of database names for the connection. **Filter Group:** Small **Available Version:** 63.0 ### ConnectionFieldCollectionInputRepresentation Connection Field Collection Input Input representation for a collection of fields in a connection object. * `advancedAttributes` (_object_, required) Comma-separated list of additional parameters to fetch the fields for a connector. Specify additional parameters in the form `"key": "value"`, where the key, for example, can be a file path or parser settings. The list of parameter keys varies by connector. Use the [get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnectorMetadata) endpoint to discover the supported keys. Specify an empty object if no additional parameters are needed. **Available Version:** 62.0 Additional properties: `string`. * `filters` (_object_) Criteria that filter and retrieve fields based on a subset of fields and values. **Available Version:** 63.0 Includes all fields of `ResourceFiltersInputRepresentation`. ### ConnectionFieldCollectionRepresentation Connection Field Collection Output Represents a collection of fields for a connection. * `advancedAttributes` (_object_) Advanced attributes of the connection, which can include extract attributes and parser settings where applicable. **Filter Group:** Small **Available Version:** 61.0 Additional properties: `string`. * `fields` (_array of BaseConnectionFieldRepresentation_) List of fields for the connection. All connections return the properties of `Connection Field Output`. CRM connections also return the properties of `CRM Connection Field Output`. **Filter Group:** Small **Available Version:** 61.0 * `incrementalExtractAttributes` (_object_) List of incremental fields and delete fields for the connection. **Filter Group:** Small **Available Version:** 61.0 * `primaryKeys` (_array of string_) List of primary keys for the connection. **Filter Group:** Small **Available Version:** 61.0 ### ConnectionObjectCollectionInputRepresentation Connection Object Collection Input Input representation for a collection of source objects for a connection. * `advancedAttributes` (_object_) Additional parameters used to retrieve the source objects for a connector. Specify each parameter in the form `"key": "value"`. The supported keys vary by connector. To discover the supported keys, use the [Get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnectorMetadata) endpoint. If no additional parameters are needed, specify an empty object. Example keys include `databaseName`, `schemaName`, and `includeDataExtensionSize` (for the `SalesforceMarketingCloudDataExtension` subtype). **Available Version:** 62.0 Additional properties: `string`. * `filters` (_object_) Criteria that filter and retrieve objects based on a subset of fields and values. **Available Version:** 62.0 Includes all fields of `ResourceFiltersInputRepresentation`. ### ConnectionObjectCollectionRepresentation Connection Object Collection Output Represents a collection of source objects for a connection. * `objects` (_array of CrmConnectionObjectRepresentation | SalesforceMarketingCloudStandardConnectionObjectRepresentation | SalesforceMarketingCloudDataExtensionConnectionObjectRepresentation | ConnectionObjectRepresentation_) List of source objects for the connection. The endpoint returns the connection output object that corresponds to the connector type: * `SalesforceDotCom`: CRM Connection Object Output * `SalesforceMarketingCloud`: Salesforce Marketing Cloud Standard or Data Extension Connection Object Output * All others: Connection Object Output. **Filter Group:** Small **Available Version:** 62.0 ### ConnectionPreviewInputRepresentation Connection Preview Input Input representation for a connection preview. * `advancedAttributes` (_object_, required) Comma-separated list of additional parameters to fetch the connector to be previewed. Specify additional parameters in the form `"key": "value"`, where the key, for example, is `schema` or `database`. The list of parameter keys varies by connector and can include extract attributes and parser settings where applicable. Use the [get connector metadata](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getConnectorMetadata) endpoint to discover the supported keys. Specify an empty object if no additional parameters are needed. **Available Version:** 62.0 Additional properties: `string`. * `fields` (_array of string_, required) List of fields to return in the preview. **Available Version:** 62.0 * `limit` (_integer_) Maximum number of records to return in the preview. The default is `100`. **Available Version:** 62.0 ### ConnectionPreviewRepresentation Connection Preview Output Represents a collection of previewed records for a connection. * `advancedAttributes` (_object_) Advanced attributes of the connection, which can include extract attributes and parser settings where applicable. **Filter Group:** Small **Available Version:** 62.0 Additional properties: `string`. * `records` (_array of ConnectionPreviewRecordRepresentation_) List of connection preview records. **Filter Group:** Small **Available Version:** 62.0 ### ConnectionSchemaCollectionRepresentation Connection Schema Collection Output Represents a collection of connection schemas. * `schemas` (_array of ConnectionSchemaRepresentation_) List of connection schemas. The endpoint returns the connection schema output object that corresponds to the connector type. For example, the Connectors Framework Connection Schema Output is returned for the `DataConnectionEvent` connector type. **Filter Group:** Small **Available Version:** 60.0 ### ConnectionSchemaCollectionInputRepresentation Connection Schema Collection Input Input representation of a collection of connection schemas. * `schemas` (_array of ConnectionSchemaInputRepresentation_, required) List of connection schemas. Use the connection schema input object that corresponds to the schema type. For example, use the Connectors Framework Connection Schema Input for the `DataConnectionEvent` schema type. **Available Version:** 60.0 ### ConnectionSitemapRepresentation Connection Sitemap Output Represents the sitemap for a Streaming App connection. * `sitemap` (_string_) Sitemap of the Streaming App connector. **Filter Group:** Small **Available Version:** 60.0 * `sitemapPath` (_string_) Path to the sitemap of the Streaming App connector. **Filter Group:** Small **Available Version:** 60.0 ### ConnectionSitemapInputRepresentation Connection Sitemap Input Input representation for the sitemap for a Streaming App connection. * `sitemap` (_string_, required) Sitemap for the Streaming App connector. **Available Version:** 60.0 ### ConnectionTestInputRepresentation Connection Test Input Input representation for testing a connection without creating it. * `connectorType` (_string_, required) Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. **Available Version:** 62.0 * `credentials` (_array of DataConnectionParameterInputRepresentation_) List of key-value pairs that provide credentials for the data connection. Credentials values are masked. **Available Version:** 62.0 * `method` (_string_) Type of the data connection. **Available Version:** 62.0 Allowed values: `Egress`, `Ingress`. * `parameters` (_array of DataConnectionParameterInputRepresentation_) List of key-value pairs that provide parameters for the data connection. **Available Version:** 62.0 ### ConnectionTestActionRepresentation Connection Test Action Output Representation for the result of testing an action on a connection. Includes all fields of `CdpActionResponseBaseRepresentation`. ### ConnectionCommandActionInputRepresentation Connection Command Action Input Input representation for running a command on a connection without creating the connection. * `commandAttributes` (_object_) Map of key-value pairs for command attributes in the form `Map`. **Available Version:** 64.0 Additional properties: `object`. * `connectorType` (_string_, required) Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. **Available Version:** 64.0 * `method` (_string_, required) Type of the data connection. **Available Version:** 64.0 Allowed values: `Egress`, `Ingress`. ### ConnectionCommandActionRepresentation Connection Command Action Output Representation for the result of testing a command action on a connection. Includes all fields of `CdpActionResponseBaseRepresentation`. ### ConnectionCommandExistingActionInputRepresentation Connection Command Existing Action Input Input representation for running a command on an existing connection. * `commandAttributes` (_object_) Map of key-value pairs for command attributes in the form `Map`. **Available Version:** 64.0 Additional properties: `object`. ### ConnectionSchemaActionResponseRepresentation Connection Schema Action Response Output Representation for the result of testing a schema for an existing connection. Includes all fields of `CdpActionResponseBaseRepresentation`. ### ConnectorInfoCollectionRepresentation Connector Info Collection Output Represents a collection of information about Data 360 connectors. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `connectorInfoList` (_array of ConnectorInfoRepresentation_, required) List of items that provide information about the requested connectors. **Filter Group:** Small **Available Version:** 62.0 ### ConnectorMetadataRepresentation Connector Metadata Output Represents metadata for a Data 360 connector. * `advancedAttributes` (_array of object_) List of advanced attributes supported by the connector, which can include extract attributes and parser settings where applicable. The list of attributes is returned in the form `List>`. **Filter Group:** Small **Available Version:** 62.0 Additional properties: `object`. * `connectionAttributes` (_array of object_) List of connection attributes supported by the connector. The list of attributes is returned in the form `List>`. **Filter Group:** Small **Available Version:** 62.0 Additional properties: `object`. * `description` (_string_) Description of the connector. **Filter Group:** Small **Available Version:** 62.0 * `features` (_array of ConnectorFeatureRepresentation_) List of features of the connector. **Filter Group:** Small **Available Version:** 62.0 * `iconUrl` (_string_) URL for the icon of the connector. **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the connector. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Name of the connector. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataActionTargetCollectionRepresentation Data Action Target Collection Output Data action target collection representation. **Available Version:** 62.0 * `currentPageUrl` (_string_) URL to the current page of data action targets. **Available Version:** 62.0 * `dataActionTargets` (_array of CdpDataActionTargetOutputRepresentation_) List of data action targets. **Available Version:** 62.0 * `nextPageUrl` (_string_) URL for the next page of data action targets. **Available Version:** 62.0 ### CdpDataActionTargetInputRepresentation Data Action Target Input Input representation for creating a data action target. * `apiName` (_string_, required) Data action target API name. **Available Version:** 62.0 * `config` (_CdpDataActionTargetCRMConfig | CdpDataActionTargetInternalWebConfig | CdpDataActionTargetMCConfig | CdpDataActionTargetWebConfig_, required) Configuration for the data action target. Use the config input object that corresponds to the type of data action target. For example, use the Data Action Target Internal Web Config Input for the `Internal_WebHook` type. **Available Version:** 62.0 One of: `CdpDataActionTargetCRMConfig`, `CdpDataActionTargetInternalWebConfig`, `CdpDataActionTargetMCConfig`, `CdpDataActionTargetWebConfig`. * `externalRecordIdentifier` (_string_) External record ID. **Available Version:** 62.0 * `label` (_string_, required) Data action target name. **Available Version:** 62.0 * `subType` (_string_) Data action target sub type. **Available Version:** 62.0 Allowed values: `Grpc`, `Rest`. * `type` (_string_, required) Data action target type. **Available Version:** 62.0 Allowed values: `Core`, `Internal_WebHook`, `MarketingCloud`, `WebHook`. ### CdpDataActionTargetOutputRepresentation Data Action Target Output Representation for a data action target. * `apiName` (_string_) Developer name of the data action target. **Filter Group:** Small **Available Version:** 62.0 * `config` (_CdpDataActionCRMTargetInfo | CdpDataActionTargetInternalWebInfo | CdpDataActionMCTargetInfo | CdpDataActionTargetWebInfo_) Configuration for the data action target. The endpoint returns the config output object that corresponds to the type of data action target. For example, the Data Action Target Core Config Output is returned for the `Core` type. **Filter Group:** Small **Available Version:** 62.0 One of: `CdpDataActionCRMTargetInfo`, `CdpDataActionTargetInternalWebInfo`, `CdpDataActionMCTargetInfo`, `CdpDataActionTargetWebInfo`. * `externalRecordIdentifier` (_string_) External record ID. **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Data action target name. **Filter Group:** Small **Available Version:** 62.0 * `status` (_string_) Status **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Active`, `Error`, `InActive`, `Processing`. * `statusErrorCode` (_string_) Status error code. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `CreateFailed`, `DeleteFailed`, `ProcessingFailed`. * `subType` (_string_) Sub type **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Grpc`, `Rest`. * `type` (_string_) Data action target type. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Core`, `Internal_WebHook`, `MarketingCloud`, `WebHook`. ### CdpDataActionTargetSigningKeyOutputRepresentation Data Action Target Signing Key Output Data Action target Signing Key representation. * `signingAlgorithm` (_string_) Signing algorithm. **Filter Group:** Small **Available Version:** 62.0 * `signingKey` (_string_) Signing key. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataActionCollectionRepresentation Data Action Collection Output Represents a collection of data actions. * `currentPageUrl` (_string_) URL to the current page of data actions. **Filter Group:** Small **Available Version:** 62.0 * `dataActions` (_array of CdpDataActionOutputRepresentation_) List of data actions. **Filter Group:** Small **Available Version:** 62.0 * `nextPageUrl` (_string_) URL to the next page of data actions. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataActionInputRepresentation Data Action Input Input representation to create a data action. * `actionConditionExpression` (_string_, required) The action's condition expression. **Available Version:** 62.0 * `actionConditions` (_array of object_, required) The action conditions. **Available Version:** 62.0 * `dataActionEnrichmentProperties` (_array of object_, required) The data action enrichment properties. **Available Version:** 62.0 * `dataActionName` (_string_, required) Name of the data action. **Available Version:** 62.0 * `dataActionProjectedFields` (_array of object_, required) Projected fields for the data action. **Filter Group:** Small **Available Version:** 62.0 * `dataActionSources` (_array of object_, required) Data action sources. **Filter Group:** Small **Available Version:** 62.0 * `dataActionTargetNames` (_array of string_, required) List of names of the data action targets. **Filter Group:** Small **Available Version:** 62.0 * `dataspace` (_string_, required) Name of the data space to use for the request. **Available Version:** 62.0 * `description` (_string_, required) Data action's description. **Available Version:** 62.0 * `developerName` (_string_, required) Data action developer name. **Available Version:** 62.0 * `eventTriggerCondition` (_string_) Data action's event trigger condition. **Available Version:** 62.0 * `externalRecordIdentifier` (_string_) Data action's external record identifier. **Available Version:** 62.0 * `isRealTimeAction` (_boolean_) `true` if the data action is a real time action, otherwise `false`. **Available Version:** 62.0 * `masterLabel` (_string_, required) Data action's master label. **Available Version:** 62.0 * `shouldProcessDayZero` (_boolean_) `true` if the data action should be processed immediately, otherwise `false`. **Available Version:** 62.0 * `shouldTriggerEventOnlyFirstTime` (_boolean_) If `true`, the related event is triggered only the first time that the data action is used. If `false`, the event is triggered each time the data action is used. **Available Version:** 62.0 * `subscriberKey` (_string_) Data action subscriber key. **Available Version:** 62.0 ### CdpDataActionOutputRepresentation Data Action Output The output of a create data action request. * `actionConditionExpression` (_string_) The action's condition expression. **Filter Group:** Small **Available Version:** 62.0 * `actionConditions` (_array of DataActionConditionOutputRepresentation_) The action conditions. **Filter Group:** Small **Available Version:** 62.0 * `dataActionEnrichmentProperties` (_array of DataActionEnrichmentOutputRepresentation_) The data action enrichment properties. **Filter Group:** Small **Available Version:** 62.0 * `dataActionName` (_string_) Data action's name. **Filter Group:** Small **Available Version:** 62.0 * `dataActionProjectedFields` (_array of DataActionProjectedFieldOutputRepresentation_) The data action's projected fields. **Filter Group:** Small **Available Version:** 62.0 * `dataActionSources` (_array of DataActionSourceOutputRepresentation_) Data action sources. **Filter Group:** Small **Available Version:** 62.0 * `dataActionStatus` (_string_) Data action's status. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Active`, `Error`, `InActive`, `Processing`. * `dataActionTargets` (_array of string_) Data action targets. **Filter Group:** Small **Available Version:** 62.0 * `dataSpaceDevName` (_string_) Developer name of the data space. **Filter Group:** Small **Available Version:** 62.0 * `description` (_string_) Description of the data action. **Filter Group:** Small **Available Version:** 62.0 * `developerName` (_string_) Developer name of the data action. **Filter Group:** Small **Available Version:** 62.0 * `eventTriggerCondition` (_string_) Event trigger condition for the data action. **Filter Group:** Small **Available Version:** 62.0 * `externalRecordIdentifier` (_string_) Data action's external record identifier. **Filter Group:** Small **Available Version:** 62.0 * `isRealTimeAction` (_boolean_) Indicates whether the data action is a real-time action (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `lastActionStatusDateTime` (_string_) Date and time that the most recent data action status was set. **Filter Group:** Small **Available Version:** 62.0 * `lastActionStatusErrorCode` (_string_) Status of the data action's error code. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `CreateFailed`, `DeleteFailed`, `ProcessingFailed`. * `masterLabel` (_string_) Data action's master label. **Filter Group:** Small **Available Version:** 62.0 * `shouldTriggerEventOnlyFirstTime` (_boolean_) If `true`, the related event is triggered only the first time that the data action is used. If `false`, the event is triggered each time the data action is used. **Filter Group:** Small **Available Version:** 62.0 * `subscriberKey` (_string_) Data action subscriber key. **Filter Group:** Small **Available Version:** 62.0 ### CustomCodeDeploymentCollectionRepresentation Custom Code Deployment Collection Output Represents a collection of custom code deployments. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `customCodeDeployments` (_array of CustomCodeDeploymentRepresentation_) List of custom code deployments. **Filter Group:** Small **Available Version:** 63.0 ### CustomCodeDeploymentInputRepresentation Custom Code Deployment Input Represents the input for creating a custom code deployment. Includes all fields of `CdpAssetBaseInputRepresentation`. * `description` (_string_) Description of the custom code deployment. **Available Version:** 63.0 * `codeType` (_string_) Type of code. **Available Version:** 63.0 Allowed values: `Function`, `Script`. * `computeType` (_string_) Type of compute resource allocated for the deployment. Each compute size corresponds to a billing tier that consumes compute units per hour. | Size | Tier | Compute units per hour | | --- | --- | --- | | CPU\_XS | Standard - Large | 4 | | CPU\_S | Standard - X-Large | 8 | | CPU\_M | Standard - 2X-Large | 16 | | CPU\_L | Standard - 4X-Large | 32 | **Available Version:** 63.0 Allowed values: `CPU_XS`, `CPU_S`, `CPU_M`, `CPU_L`. * `label` (_string_) Label of the custom code deployment. **Available Version:** 63.0 ### CustomCodeDeploymentRepresentation Custom Code Deployment Output Represents a custom code deployment. Includes all fields of `CdpAssetBaseRepresentation`. * `description` (_string_) Description of the custom code deployment. **Filter Group:** Small **Available Version:** 63.0 * `codeType` (_string_) Type of code. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Function`, `Script`. * `computeType` (_string_) Type of compute resource allocated for the deployment. Each compute size corresponds to a billing tier that consumes compute units per hour. | Size | Tier | Compute Units / hour | | --- | --- | --- | | CPU\_XS | Standard - Large | 4 | | CPU\_S | Standard - X-Large | 8 | | CPU\_M | Standard - 2X-Large | 16 | | CPU\_L | Standard - 4X-Large | 32 | **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Cpu_l`, `Cpu_m`, `Cpu_s`, `Cpu_xs`. * `deploymentFailureCode` (_integer_) Failure code returned if the deployment failed. **Filter Group:** Small **Available Version:** 63.0 * `deploymentFailureReason` (_string_) Reason the deployment failed. **Filter Group:** Small **Available Version:** 63.0 * `deploymentStatus` (_string_) Deployment status of the custom code. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Deployed`, `Disabled`, `Error`, `Initializing`, `Pending`, `Scanning`. * `fileUploadUrl` (_string_) URL to use for uploading the custom code file. **Filter Group:** Small **Available Version:** 63.0 * `isRemote` (_boolean_) Indicates whether the code package is remote (`true`) or not (`false`). A remote package is owned by another org. **Filter Group:** Small **Available Version:** 63.0 * `ownedBy` (_string_) Org that owns the code package. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Overall status of the custom code deployment. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Deleting`, `Error`, `Processing`. ### CustomCodePatchInputRepresentation Custom Code Patch Input Represents the input for updating a custom code deployment. * `computeType` (_string_) Type of compute resource allocated for the deployment. Each compute size corresponds to a billing tier that consumes compute units per hour. | Size | Tier | Compute Units / hour | | --- | --- | --- | | CPU\_XS | Standard - Large | 4 | | CPU\_S | Standard - X-Large | 8 | | CPU\_M | Standard - 2X-Large | 16 | | CPU\_L | Standard - 4X-Large | 32 | **Available Version:** 63.0 Allowed values: `Cpu_l`, `Cpu_m`, `Cpu_s`, `Cpu_xs`. * `description` (_string_) Description of the custom code deployment. **Available Version:** 63.0 * `label` (_string_) Label of the custom code deployment. **Available Version:** 63.0 * `version` (_string_) Version of the custom code. **Available Version:** 63.0 ### CustomCodeExecutionCollectionRepresentation Custom Code Execution Collection Output Represents a collection of custom code executions. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `executions` (_array of CustomCodeExecutionBaseRepresentation_) List of custom code executions. **Filter Group:** Small **Available Version:** 63.0 ### CustomCodeExecutionBaseRepresentation Custom Code Execution Base Output Represents an execution of custom code. * `computeType` (_string_) Type of compute resource allocated for the execution. Each compute size corresponds to a billing tier that consumes compute units per hour. | Size | Tier | Compute Units / hour | | --- | --- | --- | | CPU\_XS | Standard - Large | 4 | | CPU\_S | Standard - X-Large | 8 | | CPU\_M | Standard - 2X-Large | 16 | | CPU\_L | Standard - 4X-Large | 32 | **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Cpu_l`, `Cpu_m`, `Cpu_s`, `Cpu_xs`. * `durationInSeconds` (_integer_) Duration of the execution, in seconds. **Filter Group:** Small **Available Version:** 63.0 * `endTime` (_string (date-time)_) End time of the execution. **Filter Group:** Small **Available Version:** 63.0 * `errorCode` (_integer_) Error code returned if the execution failed. **Filter Group:** Small **Available Version:** 63.0 * `errorMessage` (_string_) Detailed error message returned if the execution failed. **Filter Group:** Small **Available Version:** 63.0 * `id` (_string_) ID of the execution. **Filter Group:** Small **Available Version:** 64.0 * `rowsRead` (_number (int64)_) Number of rows read during the execution. **Filter Group:** Small **Available Version:** 63.0 * `rowsWritten` (_number (int64)_) Number of rows written during the execution. **Filter Group:** Small **Available Version:** 63.0 * `startTime` (_string (date-time)_) Start time of the execution. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Status of the execution. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Cancelled`, `Failure`, `Running`, `Success`. * `submittedTime` (_string (date-time)_) Time when the execution was submitted. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomCollaborationCollectionRepresentation Data Clean Room Collaboration Collection Output Represents a collection of clean room collaborations. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `collaborations` (_array of DataCleanRoomCollaborationRepresentation_) List of clean room collaborations. **Filter Group:** Small **Available Version:** 63.0 * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 63.0 * `offset` (_integer_) Number of records to skip. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomCollaborationInputRepresentation Data Clean Room Collaboration Input Represents the input for a clean room collaboration. Includes all fields of `CdpObjectBaseInputRepresentation`. * `apiKey` (_string_) API key of the clean room. **Available Version:** 63.0 * `dataCloudOrgId` (_string_, required) Core org ID where the Data 360 clean room is enabled. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space where the collaboration is to be created. **Available Version:** 63.0 * `label` (_string_, required) Label of the clean room. **Available Version:** 63.0 * `providerDevName` (_string_, required) Developer name of the provider definition for the clean room. **Available Version:** 63.0 * `specificationDevName` (_string_, required) Developer Name of the clean room specification. **Available Version:** 63.0 * `templateName` (_string_, required) Developer name of the use case template that the collaboration is to support. **Available Version:** 63.0 * `templateVersionId` (_string_) Template version ID that the collaboration is to support. **Available Version:** 63.0 ### DataCleanRoomCollaborationRepresentation Data Clean Room Collaboration Output Represents a clean room collaboration. Includes all fields of `CdpAssetBaseRepresentation`. * `apiKey` (_string_) API key of the clean room. **Filter Group:** Small **Available Version:** 63.0 * `dataSpace` (_object_) Data space details for the clean room. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataSpaceRepresentation`. * `description` (_string_) Description of the collaboration. **Filter Group:** Small **Available Version:** 63.0 * `members` (_array of DataCleanRoomMemberRepresentation_) List of the collaboration members. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Status of the collaboration. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Disabled`, `Error`, `Inactive`. * `templateVersion` (_object_) Information about the template version that the collaboration supports. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `DataCleanRoomTemplateRepresentation`. ### DataCleanRoomAcceptInvitationInputRepresentation Data Clean Room Accept Invitation Input Represents the input for accepting an invitation to a clean room collaboration. * `dataSpaceName` (_string_) Name of the data space in which to accept the invitation. **Available Version:** 66.0 * `invitationId` (_string_, required) Record ID of of the collaboration invitation. **Available Version:** 63.0 * `outputConfiguration` (_object_) Configuration details for the output. **Available Version:** 66.0 Includes all fields of `DataCleanRoomOutputConfigurationRepresentation`. * `specificationId` (_string_, required) Record ID of the clean room specification. **Available Version:** 63.0 ### DataCleanRoomMemberRepresentation Data Clean Room Member Output Represents a member of a clean room collaboration. Includes all fields of `CdpAssetBaseRepresentation`. * `invitationId` (_string_) ID of the invitation that enabled the member to join the collaboration. **Filter Group:** Small **Available Version:** 63.0 * `invitationStatus` (_string_) Status of the invitation. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Accept_Error`, `Accept_Initiated`, `Accepted`, `Pending`, `Received`, `Reject_Error`, `Reject_Initiated`, `Rejected`, `Send_Error`, `Sent`. * `memberConfigs` (_array of DataCleanRoomMemberConfigRepresentation_) List of member configurations. **Filter Group:** Small **Available Version:** 66.0 * `memberDataCloudRegion` (_string_) Region of the member org. **Filter Group:** Small **Available Version:** 66.0 * `memberDomainUrl` (_string_) Domain URL of the member org. **Filter Group:** Small **Available Version:** 66.0 * `memberId` (_string_) ID of the collaboration member. **Filter Group:** Small **Available Version:** 63.0 * `memberOrgId` (_string_) ID of the collaboration member's org. **Filter Group:** Small **Available Version:** 63.0 * `memberStatus` (_string_) Status of the collaboration member. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Inactive`, `Mapping_Incomplete`. * `memberType` (_string_) Type of collaboration member. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Consumer`, `Provider`. * `providerId` (_string_) Reference key of the provider record of the clean room. **Filter Group:** Small **Available Version:** 63.0 * `specificationId` (_string_) Reference key of the data specification record of the clean room. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomGenericResponseRepresentation Data Clean Room Generic Response Output Generic response representation for clean room APIs. Includes all fields of `CdpActionResponseBaseRepresentation`. ### DataCleanRoomRejectInvitationInputRepresentation Data Clean Room Reject Invitation Input Represents the input for rejecting an invitation to a clean room collaboration. * `invitationId` (_string_, required) Record ID of the collaboration invitation. **Available Version:** 63.0 ### DataCleanRoomQueryJobInputRepresentation Data Clean Room Query Job Input Represents the input for a query job for a clean room. * `queryExecutionName` (_string_, required) Name of the query that is to be executed. **Available Version:** 63.0 * `queryParameters` (_object_) Map of query parameters and their values. **Available Version:** 63.0 Additional properties: `string`. * `segmentIds` (_array of string_) Segment IDs on which the query is to be executed. **Available Version:** 63.0 ### DataCleanRoomQueryJobRepresentation Data Clean Room Query Job Output Represents a query job for a clean room. Includes all fields of `CdpAssetBaseRepresentation`. * `completedDate` (_string_) Date and time the query run job was completed. **Filter Group:** Small **Available Version:** 63.0 * `errorCode` (_string_) Error code (if any) caused by a query failure. **Filter Group:** Small **Available Version:** 63.0 * `errorMessage` (_string_) Error message (if any) that specifies the query failure reason. **Filter Group:** Small **Available Version:** 63.0 * `executedBy` (_string_) Name of the user who executed the query job. **Filter Group:** Small **Available Version:** 63.0 * `outputDMOName` (_string_) Developer name of the resulting data model object (DMO) for Activation use cases. For other use cases, this value is the name of the resulting report. **Filter Group:** Small **Available Version:** 63.0 * `queryParam` (_object_) Map of query parameters and their values. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `string`. * `reportId` (_string_) ID of the report associated with the output DMO. **Filter Group:** Small **Available Version:** 63.0 * `reportName` (_string_) Name of the report associated with the output DMO. **Filter Group:** Small **Available Version:** 63.0 * `segmentNames` (_array of string_) List of segment names. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Status of the query job. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Created`, `Failed`, `Running`, `Success`. * `triggeredDate` (_string_) Date and time the query run job was started. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomQueryJobCollectionRepresentation Data Clean Room Query Job Collection Output Represents a collection of query jobs for a clean room. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 63.0 * `offset` (_integer_) Number of records skipped. **Filter Group:** Small **Available Version:** 63.0 * `queryJobs` (_array of DataCleanRoomQueryJobRepresentation_) List of query jobs for a clean room. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomCollaborationResultDataObjectCollectionRepresentation Data Clean Room Collaboration Result Data Object Collection Output Represents a list of data objects created by a clean room collaboration. * `collaborationResultDataObjects` (_array of DataCleanRoomCollaborationResultDataObjectRepresentation_) List of DMOs created by the collaboration. **Filter Group:** Small **Available Version:** 66.0 ### DataCleanRoomProviderCollectionRepresentation Data Clean Room Provider Collection Output Represents a collection of clean room providers. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 63.0 * `offset` (_integer_) Number of records skipped. **Filter Group:** Small **Available Version:** 63.0 * `providers` (_array of DataCleanRoomProviderRepresentation_) List of provider definitions. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomProviderInputRepresentation Data Clean Room Provider Input Represents the input for a clean room provider. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataCloudOrgId` (_string_) Core org ID where the Data 360 clean room is enabled. **Available Version:** 63.0 * `domainUrl` (_string_) Domain URL of the provider. **Available Version:** 63.0 * `label` (_string_, required) Label of the provider definition. **Available Version:** 63.0 * `logoUrl` (_string_) URL path to the provider logo. **Available Version:** 63.0 * `offCoreTenantId` (_string_) Off core tenant ID of the provider. **Available Version:** 63.0 * `packageType` (_string_) Type of provider package. **Available Version:** 66.0 Allowed values: `DataCollaboration`, `IdEnrichment`. * `providerDataSource` (_string_) Source of the provider data. **Available Version:** 66.0 Allowed values: `Snowflake`. * `providerName` (_string_) Name of the provider. **Available Version:** 63.0 * `source` (_string_) Source of the provider. **Available Version:** 63.0 Allowed values: `AWS`, `DATA_CLOUD`. * `sourceConfiguration` (_object_) Other source-related configurations for the provider. Use the source config input object that corresponds to the type of provider. For example, use the Data Clean Room AWS Source Config Input for the `AWS` type. **Available Version:** 63.0 Includes all fields of `DataCleanRoomProviderSourceConfigInputRepresentation`. * `templateJson` (_object_) Custom JSON template configuration for extensible template flow. **Available Version:** 63.0 Includes all fields of `CustomUseCaseTemplateInputRepresentation`. * `templateNames` (_array of string_) List of use case templates that the provider supports. **Available Version:** 63.0 * `templateType` (_string_) Type of use case template. **Available Version:** 63.0 Allowed values: `Custom`, `Salesforce`. * `useCaseTypeConfig` (_array of DataCleanRoomUseCaseTypeInputRepresentation_) Configuration for the type of use case template. **Available Version:** 63.0 ### DataCleanRoomProviderRepresentation Data Clean Room Provider Output Represents a clean room provider. Includes all fields of `CdpAssetBaseRepresentation`. * `creationType` (_string_) Type of provider creation. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Packaged`, `Peer`. * `dataCloudOrgId` (_string_) Core org ID where Data 360 clean room is enabled. **Filter Group:** Small **Available Version:** 63.0 * `description` (_string_) Description of the provider. **Filter Group:** Small **Available Version:** 63.0 * `domainUrl` (_string_) Domain URL of the provider. **Filter Group:** Small **Available Version:** 63.0 * `logoUrl` (_string_) URL of the provider logo. **Filter Group:** Small **Available Version:** 63.0 * `offCoreTenantId` (_string_) Off-core tenant ID of the provider. **Filter Group:** Small **Available Version:** 63.0 * `packageType` (_string_) Type of package. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `DataCollaboration`, `IdEnrichment`. * `providerDataSource` (_string_) Source of the provider's data. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Snowflake`. * `providerName` (_string_) Name of the provider. **Filter Group:** Small **Available Version:** 64.0 * `source` (_string_) Source type of the provider. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `AWS`, `DATA_CLOUD`. * `sourceConfiguration` (_object_) Other source-related configurations for the provider. The endpoint returns the source config output object that corresponds to the type of provider. For example, the Data Clean Room AWS Source Config Output is returned for the `AWS` type. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `DataCleanRoomProviderSourceConfigRepresentation`. * `templateNames` (_array of string_) List of template names. **Filter Group:** Small **Available Version:** 63.0 * `useCaseTypeConfig` (_object_) Configuration for the type of use case template. **Filter Group:** Small **Available Version:** 65.0 Includes all fields of `DataCleanRoomUseCaseTypeRepresentation`. ### DataCleanRoomTemplateCollectionRepresentation Data Clean Room Template Collection Output Represents a collection of use case templates for a clean room. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 63.0 * `offset` (_integer_) Number of records skipped. **Filter Group:** Small **Available Version:** 63.0 * `templates` (_array of DataCleanRoomTemplateRepresentation_) List of use case templates. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomSpecificationCollectionRepresentation Data Clean Room Specification Collection Output Represents a collection of clean room specifications. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `cleanroomSpecifications` (_array of DataCleanRoomDataSpecificationRepresentation_) List of clean room specifications. **Filter Group:** Small **Available Version:** 63.0 * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 63.0 * `offset` (_integer_) Number of records skipped. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomDataSpecificationInputRepresentation Data Clean Room Data Specification Input Represents the input for a clean room specification. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataMapping` (_array of UseCaseTemplateMappingRepresentation_, required) Data mapping details for a clean room member. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space where the specification is to be created. **Available Version:** 63.0 * `description` (_string_) Description of the mapping. **Available Version:** 63.0 * `label` (_string_, required) Label of the clean room specification. **Available Version:** 63.0 * `memberType` (_string_, required) Type of clean room member, `Provider` or `Consumer`. **Available Version:** 63.0 * `ownerOrgId` (_string_, required) Data 360 org ID where the mapping is to be created. **Available Version:** 63.0 * `templateName` (_string_, required) Name of the use case template for which the mapping is provided. **Available Version:** 63.0 * `templateType` (_string_, required) Type of template. **Available Version:** 63.0 Allowed values: `Custom`, `Salesforce`. * `templateVersionId` (_string_, required) Template version ID that is to be used for mapping. **Available Version:** 63.0 * `useCaseType` (_string_, required) Type of use case template. **Available Version:** 63.0 Allowed values: `Custom`, `Overlap`. ### DataCleanRoomDataSpecificationRepresentation Data Clean Room Data Specification Output Represents a clean room specification. Includes all fields of `CdpAssetBaseRepresentation`. * `dataMapping` (_object_) Data mapping details for a clean room member in JSON format. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateMappingRepresentation`. * `dataSpace` (_object_) Data space details for the clean room. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataSpaceRepresentation`. * `description` (_string_) Description of the specification. **Filter Group:** Small **Available Version:** 63.0 * `memberType` (_string_) Type of clean room member. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Consumer`, `Provider`. * `ownerOrgId` (_string_) Data 360 org ID where the mapping is created. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Status of the specification. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Error`, `Inactive`, `Processing`. * `templateVersion` (_object_) Details of the use case template version for which the mapping is provided. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `DataCleanRoomTemplateRepresentation`. ### DataCleanRoomCollaborationCollectionForUseCaseTypeRepresentation Data Clean Room Collaboration Collection For Use Case Type Output Represents a list of collaborations for a given use case template. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `collaborations` (_array of DataCleanRoomCollaborationForUseCaseTypeRepresentation_) List of collaborations. **Filter Group:** Small **Available Version:** 66.0 * `limit` (_integer_) Number of records returned. **Filter Group:** Small **Available Version:** 66.0 * `offset` (_integer_) Number of records to skip for the next request. **Filter Group:** Small **Available Version:** 66.0 ### CleanroomTestConnectionInputRepresentation Cleanroom Test Connection Input Represents the input for testing a clean room connection. * `connectionAttributes` (_object_) Map of connection attributes. **Available Version:** 66.0 Additional properties: `string`. * `connectorType` (_string_) Type of connector. **Available Version:** 66.0 Allowed values: `CleanroomAwsS3`, `CleanroomSnowflake`. * `consumerOrgId` (_string_) 18-character org ID of the target consumer. **Available Version:** 66.0 ### CleanRoomTestConnectionRepresentation Clean Room Test Connection Output Represents the result of a clean room connection test. * `details` (_object_) Additional information including error details passed by the DCF service's test connection. **Filter Group:** Small **Available Version:** 66.0 Additional properties: `string`. * `errorCode` (_string_) Error code, if any. **Filter Group:** Small **Available Version:** 66.0 * `message` (_string_) Message that provides additional context about the connection test result. **Filter Group:** Small **Available Version:** 66.0 * `success` (_boolean_) Indicates whether the connection test was successful (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 ### AccessPolicyCollectionRepresentation Access Policy Collection Output Represents a paginated list of access policies. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `records` (_array of AccessPolicyRepresentation_) Access policies on the current page. **Filter Group:** Small **Available Version:** 67.0 ### AccessPolicyInputRepresentation Access Policy Input Represents the input for creating an access policy. Includes all fields of `CdpObjectBaseInputRepresentation`. * `rules` (_array of AccessPolicyRuleInputRepresentation_) Ordered list of rules embedded in the policy. The access policy builder requires exactly one rule. **Available Version:** 67.0 ### AccessPolicyRepresentation Access Policy Output Represents an access policy with its embedded rules. Includes all fields of `CdpAssetBaseRepresentation`. * `builderCompatible` (_boolean_) Indicates whether the policy was authored to be renderable in the access policy builder (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `builderValidated` (_boolean_) Indicates whether the access policy validator has run for the policy (`true`) or not (`false`). Read-only; the server derives this value on save. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the policy. **Filter Group:** Small **Available Version:** 67.0 * `rules` (_array of AccessPolicyRuleRepresentation_) Rules contained in the policy. The access policy builder restricts a policy to one rule; multi-rule policies have `builderCompatible` set to `false`. **Filter Group:** Small **Available Version:** 67.0 ### AccessPolicyPatchInputRepresentation Access Policy Patch Input Represents the input for partially updating an access policy's set-level metadata. Only the fields that are explicitly set are updated. * `description` (_string_) Description of the policy. Omit to leave unchanged. **Available Version:** 67.0 * `label` (_string_) Display label for the policy. Omit to leave unchanged. **Available Version:** 67.0 ### AccessPolicyRuleRepresentation Access Policy Rule Output Represents a single rule within an access policy. * `action` (_array of string_) Actions the rule applies to, such as `Read`. **Filter Group:** Small **Available Version:** 67.0 * `category` (_string_) MDAPI rule category, which determines the validator that dispatches. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ACCESS_POLICY_RULE_DEFINITION`, `GOVERNANCE_POLICY_RULE_DEFINITION`, `TRANSFORM_POLICY_RULE_DEFINITION`, `RECORD_POLICY_RULE_DEFINITION`, `IDENTIFIED_RECORD_POLICY_RULE_DEFINITION`. * `effect` (_string_) Effect of the rule. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Permit`, `Forbid`, `Transform`. * `id` (_string_) 18-character record ID of the underlying PolicyRuleDefinition. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label for the rule. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the rule (PolicyRuleDefinition fullName). **Filter Group:** Small **Available Version:** 67.0 * `principalAuthenticationLevel` (_string_) Required principal authentication level. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `UNIDENTIFIED`, `IDENTIFIED`, `AUTHENTICATED`, `INTERNAL`. * `principalScopeType` (_string_) Principal scope type. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ANY`. * `resourceDomains` (_array of string_) DMOs or objects the rule scopes to. Required for record-scope (RLS) rules; typically empty or absent for OLS or FLS. **Filter Group:** Small **Available Version:** 67.0 * `resourceScopeType` (_string_) Resource scope type. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ANY`, `FIELD`, `RECORD`. * `resourceTransform` (_string_) For Transform or FLS rules, the transform applied to the field before the principal sees it. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `LAST_N_CHARS_RESOURCE_TRANSFORM`, `FIRST_N_CHARS_RESOURCE_TRANSFORM`, `ALL_BUT_LAST_N_CHARS_RESOURCE_TRANSFORM`, `ALL_BUT_FIRST_N_CHARS_RESOURCE_TRANSFORM`, `CLOSEST_ORDER_OF_MAGNITUDE_RESOURCE_TRANSFORM`, `NULL_RESOURCE_TRANSFORM`, `EMPTY_STRING_RESOURCE_TRANSFORM`, `TRUNCATE_DATE_RESOURCE_TRANSFORM`, `ROUND_RESOURCE_TRANSFORM`, `REPLACE_ALL_CHARS_RESOURCE_TRANSFORM`. * `resourceTransformArguments` (_array of ResourceTransformArgumentRepresentation_) Static argument list for the resource transform, such as the `2` for `FIRST_N_CHARS_RESOURCE_TRANSFORM`. **Filter Group:** Small **Available Version:** 67.0 * `ruleConsumer` (_string_) Consumer of the rule's enforcement. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ALL`, `DATACLOUD`, `MULESOFT`, `TABLEAU`, `CORE`. * `transformPrecedence` (_integer_) Tiebreaker when multiple Transform rules apply to the same field. The lower value wins. Emitted only on Transform-effect rules. **Filter Group:** Small **Available Version:** 67.0 * `unless` (_object_) Condition group that, when met, exempts the rule from applying. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ConditionGroupRepresentation`. * `when` (_object_) Condition group that must be met for the rule to apply. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ConditionGroupRepresentation`. ### AccessPolicyRuleInputRepresentation Access Policy Rule Input Represents the input for a single rule within an access policy. * `action` (_array of string_) Actions the rule applies to, such as `Read`. **Available Version:** 67.0 * `category` (_string_, required) MDAPI rule category. **Available Version:** 67.0 Allowed values: `ACCESS_POLICY_RULE_DEFINITION`, `GOVERNANCE_POLICY_RULE_DEFINITION`, `TRANSFORM_POLICY_RULE_DEFINITION`, `RECORD_POLICY_RULE_DEFINITION`, `IDENTIFIED_RECORD_POLICY_RULE_DEFINITION`. * `effect` (_string_, required) Effect of the rule. **Available Version:** 67.0 Allowed values: `Permit`, `Forbid`, `Transform`. * `label` (_string_) Display label for the rule. **Available Version:** 67.0 * `name` (_string_, required) Developer name of the rule (PolicyRuleDefinition fullName). **Available Version:** 67.0 * `principalAuthenticationLevel` (_string_) Required principal authentication level. **Available Version:** 67.0 Allowed values: `UNIDENTIFIED`, `IDENTIFIED`, `AUTHENTICATED`, `INTERNAL`. * `principalScopeType` (_string_) Principal scope type. **Available Version:** 67.0 Allowed values: `ANY`. * `resourceDomains` (_array of string_) DMOs or objects the rule scopes to. Required for record-scope (RLS) rules. **Available Version:** 67.0 * `resourceScopeType` (_string_) Resource scope type. **Available Version:** 67.0 Allowed values: `ANY`, `FIELD`, `RECORD`. * `resourceTransform` (_string_) For Transform or FLS rules, the transform applied to the field. **Available Version:** 67.0 Allowed values: `LAST_N_CHARS_RESOURCE_TRANSFORM`, `FIRST_N_CHARS_RESOURCE_TRANSFORM`, `ALL_BUT_LAST_N_CHARS_RESOURCE_TRANSFORM`, `ALL_BUT_FIRST_N_CHARS_RESOURCE_TRANSFORM`, `CLOSEST_ORDER_OF_MAGNITUDE_RESOURCE_TRANSFORM`, `NULL_RESOURCE_TRANSFORM`, `EMPTY_STRING_RESOURCE_TRANSFORM`, `TRUNCATE_DATE_RESOURCE_TRANSFORM`, `ROUND_RESOURCE_TRANSFORM`, `REPLACE_ALL_CHARS_RESOURCE_TRANSFORM`. * `resourceTransformArguments` (_array of ResourceTransformArgumentInputRepresentation_) Static argument list for the resource transform, such as the `2` for `FIRST_N_CHARS_RESOURCE_TRANSFORM`. **Available Version:** 67.0 * `ruleConsumer` (_string_) Consumer of the rule's enforcement. **Available Version:** 67.0 Allowed values: `ALL`, `DATACLOUD`, `MULESOFT`, `TABLEAU`, `CORE`. * `transformPrecedence` (_integer_) Tiebreaker when multiple Transform rules apply to the same field. The lower value wins. Applies only to Transform-effect rules. **Available Version:** 67.0 * `unless` (_object_) Condition group that, when met, exempts the rule from applying. **Available Version:** 67.0 Includes all fields of `ConditionGroupInputRepresentation`. * `when` (_object_) Condition group that must be met for the rule to apply. **Available Version:** 67.0 Includes all fields of `ConditionGroupInputRepresentation`. ### AutoTaggingJobCollectionRepresentation Auto Tagging Job Collection Output Represents a paginated collection of data governance auto-tagging jobs. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of records on the current page. **Filter Group:** Small **Available Version:** 67.0 * `jobs` (_array of AutoTaggingJobRepresentation_) List of auto-tagging jobs. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for the response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 ### AutoTaggingJobRepresentation Auto Tagging Job Output Represents a data governance auto-tagging background job. * `createdDate` (_string (date-time)_) Date the job was created. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the job. **Filter Group:** Small **Available Version:** 67.0 * `lastModifiedDate` (_string (date-time)_) Date the job status was last updated. **Filter Group:** Small **Available Version:** 67.0 * `objectName` (_string_) Target object API name. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Status of the job. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Fail`, `InProgress`, `Success`. ### ClassificationAssignmentCollectionRepresentation Classification Assignment Collection Output Represents a collection of data governance classification assignments. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `classificationAssignments` (_array of ClassificationAssignmentRepresentation_) List of classification assignments. **Filter Group:** Small **Available Version:** 67.0 * `count` (_integer_) Number of records on the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for the response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 ### ClassificationAssignmentCreateItemInputRepresentation Classification Assignment Create Item Input Represents the input for a single classification assignment creation item. * `classificationFullyQualifiedName` (_string_, required) Fully-qualified API name of the source classification. **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_, required) Fully-qualified API name of the target tag. **Available Version:** 67.0 ### ClassificationAssignmentRepresentation Classification Assignment Output Represents a data governance classification assignment to a tag. * `classificationFullyQualifiedLabel` (_string_) Hierarchical display label of the classification (dotted path of ancestor labels). **Filter Group:** Small **Available Version:** 67.0 * `classificationFullyQualifiedName` (_string_) Fully-qualified API name of the source classification. **Filter Group:** Small **Available Version:** 67.0 * `classificationId` (_string_) ID of the source classification. **Filter Group:** Small **Available Version:** 67.0 * `classificationLabel` (_string_) Leaf display label of the classification. **Filter Group:** Small **Available Version:** 67.0 * `classificationName` (_string_) Leaf developer name of the source classification. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the classification assignment. **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedLabel` (_string_) Hierarchical display label of the target tag (dotted path of ancestor labels). **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_) Fully-qualified API name of the target tag. **Filter Group:** Small **Available Version:** 67.0 * `tagId` (_string_) ID of the target tag. **Filter Group:** Small **Available Version:** 67.0 * `tagLabel` (_string_) Leaf display label of the target tag. **Filter Group:** Small **Available Version:** 67.0 * `tagName` (_string_) Leaf developer name of the target tag. **Filter Group:** Small **Available Version:** 67.0 ### ClassificationAssignmentBulkCreateInputRepresentation Classification Assignment Bulk Create Input Represents the input for bulk creating classification assignments. * `assignments` (_array of ClassificationAssignmentBulkItemInputRepresentation_, required) List of classification assignment bulk items, each containing a classification and its target tags. **Available Version:** 67.0 ### BatchRepresentation Batch Output Represents the result of a data governance bulk operation. * `hasErrors` (_boolean_) Indicates whether any item failed (`true`) or all items succeeded (`false`). **Filter Group:** Small **Available Version:** 67.0 * `results` (_array of BatchResultItemRepresentation_) List of per-item results in the same order as the input list. **Filter Group:** Small **Available Version:** 67.0 ### ClassificationAssignmentBulkDeleteInputRepresentation Classification Assignment Bulk Delete Input Represents the input for bulk deleting classification assignments by ID. * `ids` (_array of string_, required) List of classification assignment IDs to delete. **Available Version:** 67.0 ### TaxonomyCollectionRepresentation Taxonomy Collection Output Represents a paginated collection of tag taxonomies. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of tag taxonomies in the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Maximum number of tag taxonomies returned per page. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Number of rows skipped before the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Returns `null` if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 * `taxonomies` (_array of TaxonomyRepresentation_) List of tag taxonomies. **Filter Group:** Small **Available Version:** 67.0 ### TaxonomyCreateInputRepresentation Taxonomy Create Input Represents the input for creating a tag taxonomy. * `description` (_string_) Description of the tag taxonomy. **Available Version:** 67.0 * `label` (_string_) Label of the tag taxonomy. **Available Version:** 67.0 * `name` (_string_) Developer name of the tag taxonomy. **Available Version:** 67.0 ### TaxonomyRepresentation Taxonomy Output Represents a tag taxonomy. * `childCount` (_integer_) Number of direct child tags. **Filter Group:** Small **Available Version:** 67.0 * `createdBy` (_object_) User who created the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `createdDate` (_string (date-time)_) Date and time when the tag taxonomy was created. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Label of the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `lastModifiedBy` (_object_) User who last modified the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `lastModifiedDate` (_string (date-time)_) Date and time when the tag taxonomy was last modified. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `state` (_string_) Current state of the tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `Deleting`, `Inactive`. * `taxonomyKind` (_string_) Kind of tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Classification`, `Tag`. * `type` (_string_) Type of tag taxonomy. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. * `url` (_string (url)_) URL of the taxonomy resource. **Filter Group:** Small **Available Version:** 67.0 ### TaxonomyPatchInputRepresentation Taxonomy Patch Input Represents the input for updating a tag taxonomy. * `description` (_string_) Description of the tag taxonomy. **Available Version:** 67.0 * `label` (_string_) Label of the tag taxonomy. **Available Version:** 67.0 ### TaxonomyBulkCreateInputRepresentation Taxonomy Bulk Create Input Represents the input for bulk creating tag taxonomies. * `taxonomies` (_array of TaxonomyCreateInputRepresentation_) List of tag taxonomies to create. **Available Version:** 67.0 ### TaxonomyBulkDeleteInputRepresentation Taxonomy Bulk Delete Input Represents the input for bulk deleting tag taxonomies. * `names` (_array of string_) List tag taxonomies to delete. **Available Version:** 67.0 ### TaxonomyBulkUpdateInputRepresentation Taxonomy Bulk Update Input Represents the input for bulk updating tag taxonomies. * `items` (_array of TaxonomyBulkUpdateItemInputRepresentation_) List of tag taxonomies to update. **Available Version:** 67.0 ### ClassificationCollectionRepresentation Classification Collection Output Represents a collection of data governance classifications. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `classifications` (_array of ClassificationRepresentation_) List of data governance classifications. **Filter Group:** Small **Available Version:** 67.0 * `count` (_integer_) Number of records in this page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for this response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for this page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Returns `null` if this is the first page. **Filter Group:** Small **Available Version:** 67.0 ### ClassificationCreateInputRepresentation Classification Create Input Represents the input for creating a data governance classification. * `description` (_string_) Description of the classification. **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the classification in dotted path format. Use 2-3 segments: `.[.]`. **Available Version:** 67.0 * `label` (_string_) Display label of the classification. **Available Version:** 67.0 * `tagFullyQualifiedNames` (_array of string_) Fully-qualified API names of tags to associate with the classification. Maximum of 200 items. **Available Version:** 67.0 ### ClassificationRepresentation Classification Output Represents a data governance classification. * `createdBy` (_object_) User who created the classification. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `createdDate` (_string (date-time)_) Date the classification was created. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the classification. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedLabel` (_string_) Hierarchical display label in dotted path format of ancestor labels. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the classification in dotted path format. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the classification. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the classification. **Filter Group:** Small **Available Version:** 67.0 * `lastModifiedBy` (_object_) User who last modified the classification. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `lastModifiedDate` (_string (date-time)_) Date the classification was last modified. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the classification. Terminal segment only. **Filter Group:** Small **Available Version:** 67.0 * `parentClassification` (_object_) Parent classification reference. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ClassificationLookupRepresentation`. * `state` (_string_) State of the classification. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `Deleting`, `Inactive`. * `tags` (_array of TagLookupRepresentation_) Tags associated with the classification. **Filter Group:** Small **Available Version:** 67.0 * `taxonomy` (_object_) Taxonomy reference. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `TaxonomyLookupRepresentation`. * `type` (_string_) Type of classification. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. * `url` (_string (url)_) URL of the classification resource. **Filter Group:** Small **Available Version:** 67.0 ### ClassificationPatchInputRepresentation Classification Patch Input Represents the input for updating a data governance classification. * `description` (_string_) Updated description. **Available Version:** 67.0 * `label` (_string_) Updated display label. **Available Version:** 67.0 * `tagFullyQualifiedNames` (_array of string_) Replaces all tag links. Maximum of 200 items. Provide an empty list to remove all links. Omit to leave unchanged. **Available Version:** 67.0 ### ClassificationBulkCreateInputRepresentation Classification Bulk Create Input Represents the input for bulk creating data governance classifications. * `classifications` (_array of ClassificationCreateInputRepresentation_) List of classification create inputs. **Available Version:** 67.0 ### ClassificationBulkDeleteInputRepresentation Classification Bulk Delete Input Represents the input for bulk deleting data governance classifications. * `fullyQualifiedNames` (_array of string_) Fully-qualified API names of classifications to delete. Maximum of 200 items. **Available Version:** 67.0 ### ClassificationBulkUpdateInputRepresentation Classification Bulk Update Input Represents the input for bulk updating data governance classifications. * `items` (_array of ClassificationBulkUpdateItemInputRepresentation_) List of classification update items. **Available Version:** 67.0 ### DataGovernanceObjectAccessGrantCollectionRepresentation Data Governance Object Access Grant Collection Output Represents a paginated list of object access grants. * `count` (_integer_) Number of grants on the current page. **Filter Group:** Small **Available Version:** 67.0 * `currentPageUrl` (_string_) URL for the current page. **Filter Group:** Small **Available Version:** 67.0 * `grants` (_array of DataGovernanceObjectAccessGrantRepresentation_) Grants on the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Maximum number of grants returned per page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string_) URL for the next page, or null if there are no more pages. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Number of rows skipped before returning results. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string_) URL for the previous page, or null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of grants matching the query, across all pages. **Filter Group:** Small **Available Version:** 67.0 ### ObjectAccessGrantCreateInputRepresentation Object Access Grant Create Input Represents the input for creating a single object access grant. * `dataSpaceName` (_string_) Name of the data space that the grant belongs to. **Available Version:** 67.0 * `objectApiName` (_string_, required) API name of the Data Cloud object to grant access to. **Available Version:** 67.0 * `permissionSetName` (_string_, required) Developer name of the permission set. **Available Version:** 67.0 ### DataGovernanceObjectAccessGrantRepresentation Data Governance Object Access Grant Output Represents a single object access grant. * `createdBy` (_object_) User who created the grant. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `createdDate` (_string (date-time)_) Timestamp when the grant was created. **Filter Group:** Small **Available Version:** 67.0 * `dataSpaceName` (_string_) Name of the data space that the grant belongs to. **Filter Group:** Small **Available Version:** 67.0 * `objectApiName` (_string_) API name of the granted Data Cloud object. **Filter Group:** Small **Available Version:** 67.0 * `permissionSetName` (_string_) Developer name of the permission set. **Filter Group:** Small **Available Version:** 67.0 ### ObjectAccessGrantBulkCreateInputRepresentation Object Access Grant Bulk Create Input Represents the input for bulk creating object access grants. * `dataSpaceName` (_string_) Name of the data space that the grants belong to. **Available Version:** 67.0 * `objectApiNames` (_array of string_, required) List of Data Cloud object API names to grant access to. Maximum of 200. **Available Version:** 67.0 * `permissionSetName` (_string_, required) Developer name of the permission set. **Available Version:** 67.0 ### DataGovernanceObjectAccessGrantBulkCreateResultRepresentation Data Governance Object Access Grant Bulk Create Result Output Represents the result of a bulk create object access grants operation. * `hasErrors` (_boolean_) Indicates whether any item failed (`true`) or all items succeeded (`false`). **Filter Group:** Small **Available Version:** 67.0 * `results` (_array of DataGovernanceObjectAccessGrantBulkResultItemRepresentation_) Per-item results, in the same order as the input list. **Filter Group:** Small **Available Version:** 67.0 ### ObjectAccessGrantBulkDeleteInputRepresentation Object Access Grant Bulk Delete Input Represents the input for bulk deleting object access grants. * `dataSpaceName` (_string_) Name of the data space that the grants belong to. **Available Version:** 67.0 * `objectApiNames` (_array of string_, required) List of Data Cloud object API names to remove grants for. Maximum of 200. **Available Version:** 67.0 * `permissionSetName` (_string_, required) Developer name of the permission set. **Available Version:** 67.0 ### DataGovernanceObjectAccessGrantBulkDeleteResultRepresentation Data Governance Object Access Grant Bulk Delete Result Output Represents the result of a bulk delete object access grants operation. * `hasErrors` (_boolean_) Indicates whether any item failed (`true`) or all items succeeded (`false`). **Filter Group:** Small **Available Version:** 67.0 * `results` (_array of DataGovernanceObjectAccessGrantBulkResultItemRepresentation_) Per-item results, in the same order as the input list. **Filter Group:** Small **Available Version:** 67.0 ### TagAssignmentCollectionRepresentation Tag Assignment Collection Output Represents a collection of data governance tag assignments. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of records on the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for the response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 * `tagAssignments` (_array of TagAssignmentRepresentation_) List of data governance tag assignments. **Filter Group:** Small **Available Version:** 67.0 ### TagAssignmentCreateItemInputRepresentation Tag Assignment Create Item Input Represents the input for a single tag assignment creation item. * `fieldName` (_string_) API name of the field. Requires `objectName`. **Available Version:** 67.0 * `objectName` (_string_) API name of the data object. **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_, required) Fully-qualified API name of the tag to assign. **Available Version:** 67.0 ### TagAssignmentRepresentation Tag Assignment Output Represents a data governance tag assignment to an object or field. * `fieldLabel` (_string_) Label of the field the tag is assigned to. **Filter Group:** Small **Available Version:** 67.0 * `fieldName` (_string_) Name of the field the tag is assigned to. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the tag assignment. **Filter Group:** Small **Available Version:** 67.0 * `objectLabel` (_string_) Label of the object the tag is assigned to. **Filter Group:** Small **Available Version:** 67.0 * `objectName` (_string_) Name of the object the tag is assigned to. **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedLabel` (_string_) Hierarchical display label of the assigned tag (dotted path of ancestor labels). **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_) Fully-qualified API name of the assigned tag (dotted path). **Filter Group:** Small **Available Version:** 67.0 * `tagId` (_string_) ID of the assigned tag. **Filter Group:** Small **Available Version:** 67.0 * `tagLabel` (_string_) Leaf display label of the assigned tag. **Filter Group:** Small **Available Version:** 67.0 * `tagName` (_string_) Leaf developer name of the assigned tag (terminal segment only). **Filter Group:** Small **Available Version:** 67.0 ### TagAssignmentBulkCreateInputRepresentation Tag Assignment Bulk Create Input Represents the input for bulk creating tag assignments. * `assignments` (_array of array of TagAssignmentTargetInputRepresentation_, required) List of tag assignment bulk items, each containing a tag and its targets. **Available Version:** 67.0 ### TagAssignmentBulkDeleteInputRepresentation Tag Assignment Bulk Delete Input Represents the input for bulk deleting tag assignments by ID. * `ids` (_array of string_, required) List of tag assignment IDs to delete. **Available Version:** 67.0 ### TagSuggestionCollectionRepresentation Tag Suggestion Collection Output Represents a paginated collection of AI-generated data governance tag suggestions. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of records on the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for the response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 * `suggestions` (_array of TagSuggestionRepresentation_) List of AI-generated tag suggestions. **Filter Group:** Small **Available Version:** 67.0 ### TagSuggestionRepresentation Tag Suggestion Output Represents an AI-generated data governance tag suggestion. * `assignmentId` (_string_) ID of the tag assignment created when the suggestion was approved. Null if not yet approved. **Filter Group:** Small **Available Version:** 67.0 * `createdDate` (_string (date-time)_) Date the suggestion was generated. **Filter Group:** Small **Available Version:** 67.0 * `fieldName` (_string_) Target field API name. Null if the suggestion targets the object rather than a specific field. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) ID of the suggestion. **Filter Group:** Small **Available Version:** 67.0 * `objectName` (_string_) Target object API name. **Filter Group:** Small **Available Version:** 67.0 * `processedBy` (_object_) User who approved or rejected the suggestion. Null if not yet processed. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `processedDate` (_string (date-time)_) Date the suggestion was approved or rejected. Null if the suggestion is new. **Filter Group:** Small **Available Version:** 67.0 * `score` (_number (double)_) LLM confidence score. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Status of the suggestion. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Approved`, `AutoRejected`, `New`, `Rejected`. * `tagFullyQualifiedLabel` (_string_) Hierarchical display label of the suggested tag (dotted path of ancestor labels). **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_) Fully-qualified API name of the suggested tag (dotted path). **Filter Group:** Small **Available Version:** 67.0 * `tagId` (_string_) ID of the suggested tag. **Filter Group:** Small **Available Version:** 67.0 * `tagLabel` (_string_) Leaf display label of the suggested tag. **Filter Group:** Small **Available Version:** 67.0 * `tagName` (_string_) Leaf developer name of the suggested tag (terminal segment only). **Filter Group:** Small **Available Version:** 67.0 ### BulkIdInputRepresentation Bulk Id Input Represents the input for bulk operations that accept a list of record IDs. * `ids` (_array of string_, required) List of core record IDs (18 characters). Maximum 200. **Available Version:** 67.0 ### SuggestTagsInputRepresentation Suggest Tags Input Represents the input for generating tag suggestions for one or more objects. * `objectNames` (_array of string_, required) Data object API names to generate tag suggestions for. Maximum 20. **Available Version:** 67.0 * `taxonomyNames` (_array of string_, required) Flat developer names of the tag taxonomies to source suggestions from. Maximum 20. **Available Version:** 67.0 ### SuggestTagsResultRepresentation Suggest Tags Result Output Represents the result of the generate tag suggestions action, containing per-object job IDs for polling. * `jobs` (_array of SuggestTagsJobRepresentation_) Per-object job information. Contains one entry per object in the request. **Filter Group:** Small **Available Version:** 67.0 ### TagDetectionInstructionBulkCreateInputRepresentation Tag Detection Instruction Bulk Create Input Represents the input for bulk creating tag detection instructions. * `detectionInstructions` (_array of TagDetectionInstructionBulkCreateItemRepresentation_, required) List of per-tag detection instruction create items. Maximum 200. **Available Version:** 67.0 ### TagWithActiveDetectionInstructionCollectionRepresentation Tag With Active Detection Instruction Collection Output Represents a paginated collection of tags with their active detection instructions for a taxonomy. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of records on the current page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for the response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for the current page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Null if the current page is the first page. **Filter Group:** Small **Available Version:** 67.0 * `tagsWithActiveDetectionInstructions` (_array of TagWithActiveDetectionInstructionRepresentation_) List of tags paired with their active detection instructions. **Filter Group:** Small **Available Version:** 67.0 ### TagCollectionRepresentation Tag Collection Output Represents a collection of data governance tags. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `count` (_integer_) Number of records in this page. **Filter Group:** Small **Available Version:** 67.0 * `limit` (_integer_) Page size used for this response. **Filter Group:** Small **Available Version:** 67.0 * `offset` (_integer_) Offset into the result set for this page. **Filter Group:** Small **Available Version:** 67.0 * `previousPageUrl` (_string (url)_) URL for the previous page. Returns `null` if this is the first page. **Filter Group:** Small **Available Version:** 67.0 * `tags` (_array of TagRepresentation_) List of data governance tags. **Filter Group:** Small **Available Version:** 67.0 ### TagCreateInputRepresentation Tag Create Input Represents the input for creating a data governance tag. * `classificationFullyQualifiedNames` (_array of string_) Fully-qualified API names of classifications to associate with the tag. Maximum of 200 items. **Available Version:** 67.0 * `description` (_string_) Description of the tag. **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the tag in dotted path format. Use 2-3 segments: `.[.]`. **Available Version:** 67.0 * `label` (_string_) Display label of the tag. **Available Version:** 67.0 ### TagRepresentation Tag Output Represents a data governance tag. * `classifications` (_array of ClassificationLookupRepresentation_) Classifications associated with the tag. **Filter Group:** Small **Available Version:** 67.0 * `createdBy` (_object_) User who created the tag. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `createdDate` (_string (date-time)_) Date the tag was created. **Filter Group:** Small **Available Version:** 67.0 * `description` (_string_) Description of the tag. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedLabel` (_string_) Hierarchical display label in dotted path format of ancestor labels. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the tag in dotted path format. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the tag. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the tag. **Filter Group:** Small **Available Version:** 67.0 * `lastModifiedBy` (_object_) User who last modified the tag. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpUserRepresentation`. * `lastModifiedDate` (_string (date-time)_) Date the tag was last modified. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the tag. Terminal segment only. **Filter Group:** Small **Available Version:** 67.0 * `parentTag` (_object_) Parent tag reference. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `TagLookupRepresentation`. * `state` (_string_) State of the tag. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `Deleting`, `Inactive`. * `taxonomy` (_object_) Taxonomy reference. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `TaxonomyLookupRepresentation`. * `type` (_string_) Type of tag. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. * `url` (_string (url)_) URL of the tag resource. **Filter Group:** Small **Available Version:** 67.0 ### TagPatchInputRepresentation Tag Patch Input Represents the input for updating a data governance tag. * `classificationFullyQualifiedNames` (_array of string_) Replaces all classification links. Maximum of 200 items. Provide an empty list to remove all links. Omit to leave unchanged. **Available Version:** 67.0 * `description` (_string_) Updated description. **Available Version:** 67.0 * `label` (_string_) Updated display label. **Available Version:** 67.0 * `parentTagFullyQualifiedName` (_string_) Fully-qualified API name of the new parent tag. Provide `null` to move the tag to the root level. Must be in the same taxonomy. **Available Version:** 67.0 ### TagDetectionInstructionCreateInputRepresentation Tag Detection Instruction Create Input Represents the input for creating a tag detection instruction. * `instructionTxt` (_string_, required) LLM detection-instruction (prompt) body. Maximum 100 characters. Posting replaces the currently active instruction with a new version. **Available Version:** 67.0 ### TagDetectionInstructionRepresentation Tag Detection Instruction Output Represents an LLM detection instruction (prompt) bound to a data governance tag. * `createdDate` (_string (date-time)_) Date the detection instruction was created. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the detection instruction. **Filter Group:** Small **Available Version:** 67.0 * `instructionTxt` (_string_) LLM detection-instruction (prompt) body. **Filter Group:** Small **Available Version:** 67.0 * `isActive` (_boolean_) Indicates whether the version is the currently active instruction for the tag (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `lastSyncedDate` (_string (date-time)_) Timestamp of the last successful off-core sync. Null until the first sync. **Filter Group:** Small **Available Version:** 67.0 * `offCoreSyncState` (_string_) Off-core sync state. Values are `NotSynced`, `Syncing`, `Synced`, or `Error`. **Filter Group:** Small **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_) Fully-qualified API name of the tag the instruction is bound to. **Filter Group:** Small **Available Version:** 67.0 * `url` (_string (url)_) URL of the detection instruction resource. **Filter Group:** Small **Available Version:** 67.0 * `version` (_integer_) Monotonically increasing version of the instruction within the tag. **Filter Group:** Small **Available Version:** 67.0 ### TagBulkCreateInputRepresentation Tag Bulk Create Input Represents the input for bulk creating data governance tags. * `tags` (_array of TagCreateInputRepresentation_) List of tag create inputs. **Available Version:** 67.0 ### TagBulkDeleteInputRepresentation Tag Bulk Delete Input Represents the input for bulk deleting data governance tags. * `fullyQualifiedNames` (_array of string_) Fully-qualified API names of tags to delete. Maximum of 200 items. **Available Version:** 67.0 ### TagBulkUpdateInputRepresentation Tag Bulk Update Input Represents the input for bulk updating data governance tags. * `items` (_array of TagBulkUpdateItemInputRepresentation_) List of tag update items. **Available Version:** 67.0 ### TagPropagateInputRepresentation Tag Propagate Input Represents the input for propagating a data governance tag to objects. * `objectNames` (_array of string_, required) List of object developer names to propagate the tag to. **Available Version:** 67.0 ### CdpDataGraphInputRepresentation Data Graph Input Input representation for creating a data graph. Includes all fields of `CdpObjectBaseInputRepresentation`. * `primaryObjectName` (_string_) API name of the primary data model object (DMO) of the data graph. **Available Version:** 59.0 * `sourceObject` (_object_) Primary root of the data graph. **Available Version:** 59.0 Includes all fields of `CdpDataGraphSourceInputRepresentation`. * `type` (_string_) Data graph type. Valid value is `NONE`. **Available Version:** 59.0 ### CdpDataGraphOutputRepresentation Data Graph Output Represents data graph output. Includes all fields of `CdpObjectBaseOutputRepresentation`. * `extendedProperties` (_string_) Extended properties of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `idDmoLabel` (_string_) Label of the data model object (DMO) that contains the ID table of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `idDmoName` (_string_) API name of the data model object (DMO) that contains the ID table of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `kind` (_string_) Reserved for internal use. **Filter Group:** Small **Available Version:** 59.0 * `lastRunStatus` (_string_) Status for the most recent run of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `primaryObjectLabel` (_string_) Label of the primary data model object (DMO) of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `primaryObjectName` (_string_) Developer name of the primary object. **Filter Group:** Small **Available Version:** 59.0 * `sourceObject` (_object_) Source object. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpDataGraphSourceObjectOutputRepresentation`. * `status` (_string_) Status of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Type of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `valuesDmoLabel` (_string_) Label of the data model object (DMO) that contains the data graph JSON records. **Filter Group:** Small **Available Version:** 59.0 * `valuesDmoName` (_string_) API name of the DMO that contains the data graph JSON records. **Filter Group:** Small **Available Version:** 59.0 * `version` (_string_) Version of the data graph. **Filter Group:** Small **Available Version:** 59.0 ### CdpQueryOutputRepresentation Query Output Represents query output. * `data` (_array of object_) Result data set. **Filter Group:** Small **Available Version:** 52.0 * `done` (_boolean_) Specifies whether the query is done (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 52.0 * `endTime` (_string_) Query end time. Not returned for data graphs. **Filter Group:** Small **Available Version:** 52.0 * `metadata` (_object_) Result metadata set. Not returned for data graphs. **Filter Group:** Small **Available Version:** 52.0 Additional properties: `object`. * `queryId` (_string_) Query ID. Not returned for data graphs. **Filter Group:** Small **Available Version:** 52.0 * `rowCount` (_integer_) Number of rows in the result data set. Not returned for data graphs. **Filter Group:** Small **Available Version:** 52.0 * `startTime` (_string_) Query start time. Not returned for data graphs. **Filter Group:** Small **Available Version:** 52.0 ### CdpDgMetadataRepresentation Data Graph Metadata Output Represents metadata from one or more data graphs. * `dataGraphMetadata` (_array of CdpQueryDataGraphMetadataRepresentation_) List of metadata from data graphs. **Filter Group:** Small **Available Version:** 59.0 ### CdpDataGraphActivateInputRepresentation Data Graph Activate Input Represents the input for activating a data graph. * `fullRefreshConfig` (_object_) Configuration of the full refresh schedule for standard data graphs. **Available Version:** 67.0 Includes all fields of `DataGraphFullRefreshConfigInputRepresentation`. ### CdpDataGraphActionResponseRepresentation Data Graph Action Response Output Represents the data graph refresh output. Includes all fields of `CdpActionResponseBaseRepresentation`. ### DataKitOutputRepresentation Data Kit Collection Output Represents a list of data kits. * `dataKitDetails` (_array of DataKitDetails_) List of data kits. **Filter Group:** Small **Available Version:** 63.0 ### DataKitInputRepresentation Data Kit Input Represents the input for creating a new data kit. * `components` (_array of DataKitComponentInputRepresentation_, required) List of components to be included in the data kit. **Available Version:** 63.0 * `dataKitDevName` (_string_, required) Developer name of the data kit. **Available Version:** 63.0 * `dataKitType` (_string_) Type of data kit. **Available Version:** 63.0 Allowed values: `None`, `Sandbox`. * `dataSpaceName` (_string_) Name of the data space for the data kit creation. **Available Version:** 63.0 * `label` (_string_, required) Label of the data kit. **Available Version:** 63.0 ### DataKitRepresentation Data Kit Output Represents data kit details. * `components` (_array of DataKitComponentRepresentation_) List of components in the data kit. **Filter Group:** Small **Available Version:** 63.0 * `devName` (_string_) Developer name of the data kit. **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_) Label of the data kit. **Filter Group:** Small **Available Version:** 63.0 ### DataKitComponentCollectionRepresentation Data Kit Component Collection Output Represents a list of data kit components. * `components` (_array of DataKitComponentRepresentation_) List of data kit components. **Filter Group:** Small **Available Version:** 63.0 * `externalRecordIdentifier` (_string_) External record ID for `DataStreamBundle` component types. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataKitDeployInputRepresentation Data Kit Deploy Input Represents input for deploying a data kit. * `components` (_array of CdpDataKitDeployComponentRepresentation_, required) List of components to deploy. **Available Version:** 57.0 ### DataKitAsyncRepresentation Data Kit Async Output Represents a data kit un-deployment output. * `jobId` (_string_) The queued job ID. **Filter Group:** Small **Available Version:** 63.0 ### DataKitPatchInputRepresentation Data Kit Patch Input Represents the input for updating a data kit. * `components` (_array of DataKitComponentInputRepresentation_, required) List of data kit components. **Available Version:** 63.0 ### CdpDataKitMembersList Data Kit Members Collection Output Represents a list of members for one data kit. * `dataKitMembers` (_array of CdpDataKitMembers_) List of data kit members. **Filter Group:** Small **Available Version:** 63.0 ### DataKitUnDeployInputRepresentation Data Kit UnDeploy Input Input representation for undeploying the components in a DataKit * `components` (_array of DataKitUnDeployComponentDetails_, required) Components from the data kit. **Available Version:** 63.0 ### DataKitComponentDependencyCollectionRepresentation Data Kit Component Dependency Collection Output Represents a collection of component dependency details. * `componentDependencies` (_array of DataKitComponentDependencyRepresentation_) List of component dependencies. **Filter Group:** Small **Available Version:** 63.0 ### DataKitComponentDeploymentStatusRepresentation Data Kit Component Deployment Status Output Represents the status of a component deployed from a data kit. * `componentDetails` (_array of DatakitComponentDetails_) List of components and their status. **Filter Group:** Small **Available Version:** 62.0 * `status` (_object_) Current status of the component. **Filter Group:** Small **Available Version:** 62.0 Includes all fields of `DataKitComponentDeploymentStatus`. ### DataLakeObjectCollectionRepresentation Data Lake Object Collection Output Represents an output collection of data lake objects (DLOs). Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataLakeObjects` (_array of DataLakeObjectRepresentation_, required) List of DLOs. **Filter Group:** Small **Available Version:** 60.0 ### DataLakeObjectInputRepresentation Data Lake Object Input Represents the input for a data lake object (DLO). Includes all fields of `DataObjectInputRepresentation`. * `category` (_string_, required) Category of the DLO. For an unstructured data lake object (UDLO) that ingests files, use `Directory_Table` (exact mixed-case value with an underscore; not `DIRECTORY_TABLE`). **Available Version:** 60.0 Allowed values: `Directory_Table`, `Engagement`, `Insights`, `Other`, `Profile`. * `dataLakeFieldInputRepresentations` (_array of DataLakeFieldInputRepresentation_) Information about DLO fields. For Ingestion API data streams, include only the primary key field. **Available Version:** 60.0 * `dataspaceInfo` (_array of DataSpaceInputRepresentation_, required) Information about the data space. **Available Version:** 60.0 * `dataModelObjectConfig` (_object_) Configuration for creating a data model object (DMO) atomically with the DLO. When present, the platform creates the DMO and its DLO-to-DMO field mapping as part of the same request, so no follow-up mapping call is needed. Omit this property if you only need the raw data lake object, or if you prefer to create and map the DMO in separate calls afterward with `POST /ssot/data-model-objects` and `POST /ssot/data-model-object-mappings`. **Available Version:** 67.0 Includes all fields of `DataModelObjectConfigInputRepresentation`. * `dataSource` (_object_) Data source information for the DLO. References the connection to ingest from (by `sourceId`) and carries its source configuration. Required for the cloud-storage push path (Amazon S3, Google Cloud Storage, Azure) and the scheduled external-connector path (Google Drive, website, Jira, SharePoint). Omit it for the UploadedFiles path, which has no connection. **Available Version:** 67.0 Includes all fields of `DataLakeSourceInputRepresentation`. * `eventDateTimeFieldName` (_string_) Name of the event date and time field. This property is required when the value of the category property is `Engagement`. **Available Version:** 60.0 * `label` (_string_, required) Label of the DLO. **Available Version:** 60.0 * `name` (_string_, required) Name of the DLO. **Available Version:** 60.0 * `orgUnitIdentifierFieldName` (_string_) Name of the org unit identifier field. **Available Version:** 60.0 * `recordModifiedFieldName` (_string_) Name of the record modified field. **Available Version:** 60.0 ### DataLakeObjectRepresentation Data Lake Object Output Represents the output for a data lake object (DLO). Includes all fields of `CdpAssetBaseRepresentation`. * `category` (_string_, required) Category of the DLO. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Directory_Table`, `Engagement`, `Other`, `Profile`. * `dataLakeFieldInfoRepresentation` (_array of DataLakeFieldRepresentation_, required) Information about the `DataLake` field of the DLO. **Filter Group:** Small **Available Version:** 60.0 * `dataSpaceInfo` (_array of DataSpaceRepresentation_, required) Information about the data space. **Filter Group:** Small **Available Version:** 60.0 * `eventDateTimeFieldName` (_string_) Name of the event date and time field. This property is required when the value of the category property is `Engagement`. **Filter Group:** Small **Available Version:** 60.0 * `orgUnitIdentifierFieldName` (_string_) Name of the org unity identifier field. **Filter Group:** Small **Available Version:** 60.0 * `recordModifiedFieldName` (_string_) Name of the record modified field. **Filter Group:** Small **Available Version:** 60.0 * `status` (_string_, required) Status of the DLO. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Deleting`, `Error`, `Inactive`, `Processing`. ### DataLakeObjectPatchInputRepresentation Data Lake Object Patch Input Represents the input for updating a DLO. * `fields` (_array of DataLakeFieldInputRepresentation_) Fields of the DLO. **Available Version:** 60.0 * `label` (_string_, required) Label of the DLO. **Available Version:** 60.0 ### DataModelObjectCollectionRepresentation Data Model Object Collection Output Represents a collection of data model objects (DMOs). Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataModelObject` (_array of DataModelObjectRepresentation_) List of DMOs. **Filter Group:** Small **Available Version:** 61.0 ### DataModelObjectInputRepresentation Data Model Object Input Input representation for a DMO. Includes all fields of `DataObjectInputRepresentation`. * `status` (_string_) Status of DMO. **Available Version:** 60.0 Allowed values: `Active`, `Error`, `Inactive`, `Processing`. ### DataModelObjectRepresentation Data Model Object Output DMO Definition Includes all fields of `DataObjectRepresentation`. * `status` (_string_) Status of the DMO. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Error`, `Inactive`, `Processing`. ### CdpObjectSourceTargetMapCollectionRepresentation Object Source Target Map Collection Output Represents a collection of object source target mappings. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `objectSourceTargetMaps` (_array of CdpObjectSourceTargetMapRepresentation_) List of object source target mappings. **Filter Group:** Small **Available Version:** 61.0 ### CdpObjectSourceTargetMapInputRepresentation Object Source Target Map Input Represents the input for creating an object source target map. Includes all fields of `CdpObjectBaseInputRepresentation`. * `fieldMapping` (_array of CdpFieldSourceTargetMapInputRepresentation_) Details about the fields mappings between the DLO source and the DMO target. **Available Version:** 61.0 * `sourceEntityDeveloperName` (_string_) Source DLO entity developer name. **Available Version:** 61.0 * `targetEntityDeveloperName` (_string_) Target DMO entity developer name. **Available Version:** 61.0 ### CdpObjectSourceTargetMapRepresentation Object Source Target Map Output Represents the mappings between a data lake object (DLO) and a data model object (DMO). * `developerName` (_string_) Developer name of the object source target map. **Filter Group:** Small **Available Version:** 61.0 * `fieldMappings` (_array of CdpFieldSourceTargetMapRepresentation_) List of field mappings from the object source target map. **Filter Group:** Small **Available Version:** 61.0 * `sourceEntityDeveloperName` (_string_) Source DLO entity developer name of the object source target map. **Filter Group:** Small **Available Version:** 61.0 * `status` (_string_) Status of the object source target map. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Active`, `Creating`, `Deleting`, `Error`, `Inactive`, `Updating`. * `targetEntityDeveloperName` (_string_) Target DMO entity developer name of the object source target map. **Filter Group:** Small **Available Version:** 61.0 ### FieldSrcTrgtRelationshipCollectionRepresentation Field Source Target Relationship Collection Output Represents a collection of field source target relationships between data model objects (DMOs). Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `relationships` (_array of FieldSrcTrgtRelationshipRepresentation_, required) List of relationships. **Filter Group:** Small **Available Version:** 64.0 ### FieldSrcTrgtRelationshipCollectionInputRepresentation Field Source Target Relationship Collection Input Represents the input to create a collection of field source target relationships between data model objects (DMOs). * `relationships` (_array of FieldSrcTrgtRelationshipInputRepresentation_, required) List of relationships to be created. **Available Version:** 64.0 ### DataShareCollectionRepresentation Data Share Collection Output Represents a collection of data shares. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataShares` (_array of DataShareRepresentation_) List of data shares in the org. **Filter Group:** Small **Available Version:** 63.0 ### DataShareInputRepresentation Data Share Input Represents the input for creating a data share. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataShareObjects` (_array of string_) List of data share object names to include in the data share. **Available Version:** 63.0 ### DataShareRepresentation Data Share Output Represents a data share. Includes all fields of `CdpAssetBaseRepresentation`. * `dataShareObjects` (_object_) Data share objects included in the data share. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `DataShareObjectRepresentation`. * `dataspaceName` (_string_) Name of the data space that the data share belongs to. **Filter Group:** Small **Available Version:** 63.0 * `status` (_string_) Status of the data share. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Deleting`, `Error`, `InActive`, `Processing`. ### DataSharePatchInputRepresentation Data Share Patch Input Represents the input for updating a data share. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataShareObjects` (_array of string_) List of data share object names to include in the data share. **Available Version:** 63.0 ### DataShareLinkActionInputRepresentation Data Share Link Action Input Represents the input for linking a data share with targets. * `dataShareTargetNames` (_array of string_) List of developer names for the data share targets to link. **Available Version:** 63.0 ### DataShareUnlinkActionInputRepresentation Data Share Unlink Action Input Represents the input for unlinking a data share from targets. * `dataShareTargetNames` (_array of string_) List of developer names for the data share targets to unlink. **Available Version:** 63.0 ### DataShareTargetCollectionRepresentation Data Share Target Collection Output Represents a collection of data share targets. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataShareTargets` (_array of DataShareTargetRepresentation_) List of data share targets. **Filter Group:** Small **Available Version:** 63.0 ### DataShareTargetInputRepresentation Data Share Target Input Represents the input for creating a data share target. Includes all fields of `CdpObjectBaseInputRepresentation`. * `targetType` (_string_) Type of data share target. Use the input object that correspongs to the target type. For example, use the AWS Data Share Target Input for the `Aws` target type. **Available Version:** 63.0 Allowed values: `Aws`, `BigQuery`, `Databricks`, `Datacloud`, `Ibm`, `Other`, `Snowflake`, `SnowflakeOpenFlow`. ### DataShareTargetRepresentation Data Share Target Output Represents a data share target. Includes all fields of `CdpAssetBaseRepresentation`. * `status` (_string_) Status of the data share target. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Active`, `Deleting`, `Error`, `GrantRevokeAccess`, `InActive`, `Processing`. * `targetType` (_string_) Type of data share target. The endpoint returns the output object that corresponds to the target type. For example, the Aws Data Share Target Output is returned for the `Aws` target type. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Aws`, `BigQuery`, `Databricks`, `Datacloud`, `Ibm`, `Other`, `Snowflake`, `SnowflakeOpenFlow`. ### DataSpaceCollectionRepresentation Data Space Collection Output Represents a collection of data spaces. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataSpaces` (_array of DataSpaceInfoRepresentation_, required) List of all data spaces. **Filter Group:** Small **Available Version:** 62.0 ### DataSpaceInputRepresentation Data Space Input Represents the input for a data space. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `filter` (_object_) Filter for the data space. **Available Version:** 60.0 Includes all fields of `DataSpaceFilterInputRepresentation`. * `name` (_string_) Name of the data space. **Available Version:** 60.0 ### DataSpaceInfoRepresentation Data Space Info Output Represents the details of a data space. Includes all fields of `CdpAssetBaseRepresentation`. * `description` (_string_, required) Description of the data space. **Filter Group:** Small **Available Version:** 62.0 * `prefix` (_string_) Three-character prefix of the data space. **Filter Group:** Small **Available Version:** 62.0 * `status` (_string_, required) Status of the data space. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Active`, `Error`, `Processing`. ### DataSpacePatchInputRepresentation Data Space Patch Input Represents the details for updating a data space. * `description` (_string_, required) Description of the data space. **Available Version:** 62.0 * `label` (_string_, required) Label of the data space. **Available Version:** 62.0 ### DataSpaceMemberCollectionRepresentation Data Space Member Collection Output Represents a collection of data space members. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `continuationToken` (_string_) Token used to retrieve the next page of data space members. Returned in the response whenever more results remain. **Filter Group:** Small **Available Version:** 67.0 * `members` (_array of DataSpaceMemberRepresentation_, required) List of all data space members and filters. **Filter Group:** Small **Available Version:** 61.0 ### DataSpaceMemberCollectionInputRepresentation Data Space Member Collection Input Represents the input for creating and updating the members of a data space. * `members` (_array of DataSpaceMemberInputListRepresentation_, required) A list of members to either create or update in the data space. **Available Version:** 62.0 ### DataSpaceMemberPutCollectionRepresentation Data Space Member Put Collection Output Represents the output for creating and updating data space members. * `dataSpaceMembers` (_object_) Details of the data space members that have been successfully created or updated. **Filter Group:** Small **Available Version:** 62.0 Includes all fields of `DataSpaceMemberCollectionRepresentation`. * `errors` (_array of DataSpaceMemberErrorRepresentation_) Details of the data space members that have been ignored or failed during the operation. **Filter Group:** Small **Available Version:** 62.0 * `success` (_string_) Status of the operation (`true` or `false`). Value is `true` if some or all members have been created or updated. Value is `false` only if all members have failed to be created or updated. **Filter Group:** Small **Available Version:** 62.0 ### DataSpaceMemberRepresentation Data Space Member Output Represents the details of a data space member. Includes all fields of `CdpAssetBaseRepresentation`. * `filter` (_object_) Filter on the object used for creating the data space member. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `DataSpaceFilterRepresentation`. * `memberName` (_string_, required) Developer name of the data space member. **Filter Group:** Small **Available Version:** 62.0 * `status` (_string_, required) Status of the off-core sync of the data space member. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Active`, `Error`, `Processing`. ### DataStreamCollectionRepresentation Data Stream Collection Output Represents a Data 360 data stream collection. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataStreams` (_array of DataStreamDetailedRepresentation_, required) List of data streams. **Filter Group:** Small **Available Version:** 60.0 ### DataStreamInputRepresentation Data Stream Input Represents a data stream. * `advancedAttributes` (_object_) Additional attributes for the data stream, such as a directory, file name, or file parser options. The available options depend on the data stream type. * For a BYOL data stream, provide inputs such as `database`, `schema`, and `object`. * For an unstructured data lake object (UDLO), provide connector-specific extract options and set `objectType` to `UNSTRUCTURED_DATA`. Use the same values as `dataLakeObjectInfo.dataSource.sourceConfig`. * For external connectors, provide options such as `crawlDepth`, `sync`, or `driveSelection`. * For cloud storage (Amazon S3, Google Cloud Storage, or Azure), provide `bucketName`, `importDirectory`, `fileName`, and `fileType` (`CSV` or `PARQUET`). **Available Version:** 60.0 Additional properties: `string`. * `connectorInfo` (_object_, required) Details about the connector used for the data stream. **Available Version:** 60.0 Includes all fields of `ConnectorInputRepresentation`. * `currencyIsoCodeInfo` (_object_) Currency ISO code configured in the org. If unspecified, the org default is used. **Available Version:** 63.0 * `dataAccessMode` (_string_) Data access mode used to create the data stream. **Available Version:** 62.0 Allowed values: `Direct_Access`, `Ingest`. * `dataLakeObjectInfo` (_array of DataLakeObjectInputRepresentation_) Information about the DLO. Either `dataLakeObjectInfo` or `existingDataLakeObjectInfo` can be present. For Ingestion API data streams, the `dataLakeFieldInputRepresentations` array must only contain the primary key field. **Available Version:** 60.0 * `datasource` (_string_) Data source of the data stream. **Available Version:** 60.0 * `datastreamType` (_string_) Type of data stream. Possible values include: * `AZURE` * `COMMERCE_CLOUD-S3` * `CONNECTORSFRAMEWORK` * `CRM-S3` * `DATA_CONNECTORS` * `DATA_CONNECTORS_STREAMING` * `DFU-BUNDLE` * `DFU-DE` * `EVENTS` * `GCS` * `INGEST_API` * `MCIS` * `S3` * `SFDC` * `SFDC_BUNDLE` * `SFDC_PACKAGE_KIT` * `SFTP` * `SLACK` **Available Version:** 60.0 * `existingDataLakeObjectInfo` (_object_) Information about a DLO that you want to reuse for the deployment. Either `dataLakeObjectInfo` or `existingDataLakeObjectInfo` can be present. **Available Version:** 60.0 Includes all fields of `ExistingDataLakeObjectInputRepresentation`. * `label` (_string_, required) Label of the data stream. **Available Version:** 60.0 * `mappings` (_array of DataStreamFieldMappingInputRepresentation_, required) Formula fields or mappings. **Available Version:** 60.0 * `name` (_string_, required) Unique identifier of the data stream. **Available Version:** 60.0 * `refreshConfig` (_object_, required) Refresh information for the data stream. **Available Version:** 60.0 Includes all fields of `RefreshConfigInputRepresentation`. * `sourceFields` (_array of DataStreamSourceFieldInputRepresentation_, required) Source fields for the data stream. **Available Version:** 60.0 ### DataStreamRepresentation Data Stream Output Information about a data stream. Includes all fields of `CdpAssetBaseRepresentation`. * `dataLakeObjectInfo` (_object_, required) Information about the data lake object (DLO) related to the data stream. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataLakeObjectRepresentation`. * `recordId` (_string_, required) Record ID of the data stream. **Filter Group:** Small **Available Version:** 60.0 * `status` (_string_, required) Status of the data stream. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Deleting`, `Error`, `Processing`. ### DataStreamDetailedRepresentation Data Stream Detailed Output Represents the details of a Data 360 data stream. Includes all fields of `CdpAssetBaseRepresentation`. * `advancedAttributes` (_object_) Additional attributes for a data stream, such as a directory, file name, or file parser options. The `areHeadersIncludedInFile` and `isMissingFileFailutre` flags are populated for file-based connectors. **Filter Group:** Small **Available Version:** 62.0 Additional properties: `string`. * `connectorInfo` (_object_) Data stream connector information. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ConnectorRepresentation`. * `dataAccessMode` (_string_) Data access mode used to create the data stream. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Direct_Access`, `Ingest`. * `dataLakeObjectInfo` (_object_) Information about the data stream's data lake. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataLakeObjectRepresentation`. * `dataSource` (_string_) Information about the data source to categorize the data being ingested. **Filter Group:** Small **Available Version:** 63.0 * `dataStreamType` (_string_) Type of data stream. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `AccountEngagement`, `Azure_Blob`, `Commerce_Bundle`, `Commerce_Data_Kit`, `ConnectorFramework`, `Cs`, `Events`, `Events_Package`, `External`, `FileUpload`, `Google_Cloud_Storage`, `IngestAPI`, `IngestAPI_Package`, `Mc`, `Mcde`, `Mcis`, `Package`, `PackageNDataKit`, `S3`, `S3_Arn`, `Sfdc`, `Sfdc_Bundle`, `Sfdc_Package_Kit`, `Sftp`. * `lastAddedRecords` (_integer (int64)_) Number of rows added in the most recent ingestion run. **Filter Group:** Small **Available Version:** 62.0 * `lastProcessedRecords` (_integer (int64)_) Number of last processed data stream records. **Filter Group:** Small **Available Version:** 60.0 * `lastRefreshDate` (_string_) Data and time of the most recent refresh for the data stream. **Filter Group:** Small **Available Version:** 62.0 * `lastRunStatus` (_string_) Status of the most recent run. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Cancelled`, `Extracting`, `Failure`, `In Progress`, `None`, `Pending`, `Success`. * `mappings` (_array of DataStreamFieldMappingRepresentation_) Data stream mappings. **Filter Group:** Small **Available Version:** 60.0 * `recordId` (_string_) Record ID of the data stream. **Filter Group:** Small **Available Version:** 60.0 * `refreshConfig` (_object_) Data stream refresh configuration. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `RefreshConfigRepresentation`. * `sourceFields` (_array of DataStreamSourceFieldRepresentation_) List of data stream source field information. **Filter Group:** Small **Available Version:** 60.0 * `status` (_string_) Status of the data stream. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Deleting`, `Error`, `Processing`. * `totalRecords` (_integer (int64)_) Total records in the data stream. **Filter Group:** Small **Available Version:** 60.0 ### DataStreamPatchInputRepresentation Data Stream Patch Input Represents the data stream to update. * `connectorPatchInfo` (_object_) Information about the connector for the data stream. **Available Version:** 60.0 Includes all fields of `ConnectorPatchInputRepresentation`. * `dataLakeObjectInfo` (_array of object_) Input data lake object used by the data stream. **Available Version:** 60.0 * `datastreamType` (_string_) Type of data stream. Possible values include: * `AZURE` * `COMMERCE_CLOUD-S3` * `CONNECTORSFRAMEWORK` * `CRM-S3` * `DATA_CONNECTORS` * `DATA_CONNECTORS_STREAMING` * `DFU-BUNDLE` * `DFU-DE` * `EVENTS` * `GCS` * `INGEST_API` * `MCIS` * `S3` * `SFDC` * `SFDC_BUNDLE` * `SFDC_PACKAGE_KIT` * `SFTP` * `SLACK` **Available Version:** 60.0 * `label` (_string_) Label of the data stream. **Available Version:** 60.0 * `mappings` (_array of DataStreamFieldMappingInputRepresentation_) Mapping representations between formula fields and data lake object (DLO) fields. **Available Version:** 60.0 * `refreshConfig` (_object_) Description of the refresh config input representation. **Available Version:** 60.0 Includes all fields of `RefreshConfigInputRepresentation`. * `sourceFields` (_array of DataStreamSourceFieldInputRepresentation_) Description of the source fields. Not used for data streams of type EVENTS. To re-enable disabled fields of a Salesforce CRM connector data stream standard or custom DLO, add them to the this array. **Available Version:** 60.0 ### DataStreamActionResponseRepresentation Data Stream Action Response Output Represents the output for an action job on a data stream. Includes all fields of `CdpActionResponseBaseRepresentation`. * `jobId` (_string_) Job ID of the data stream run. **Filter Group:** Small **Available Version:** 62.0 ### DataTransformCollectionRepresentation Data Transform Collection Output Represents a collection of data transforms. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `dataTransforms` (_array of DataTransformRepresentation_, required) List of data transforms returned for the current page. **Filter Group:** Small **Available Version:** 60.0 * `errors` (_array of FailedResourceCollectionRepresentation_) Error collection of resources that failed to be retrieved. **Filter Group:** Small **Available Version:** 60.0 ### DataTransformInputRepresentation Data Transform Input * `currencyIsoCode` (_string_) Currency ISO code of the data transform. **Available Version:** 62.0 * `dataSpaceName` (_string_) Data space that the data transform belongs to. Required for DMO-based data transforms. **Available Version:** 60.0 * `definition` (_DcSqlDataTransformDefinitionInputRepresentation | StlDataTransformDefinitionInputRepresentation | SqlDataTransformDefinitionInputRepresentation_, required) Base definition for the data transform. Use the definition input object that corresponds to the type of data transform. For example, use the Stl Data Transform Definition Input for the `Stl` type. **Available Version:** 60.0 One of: `DcSqlDataTransformDefinitionInputRepresentation`, `StlDataTransformDefinitionInputRepresentation`, `SqlDataTransformDefinitionInputRepresentation`. * `definitions` (_array of DataTransformDefinitionInputRepresentation_) List of definitions for batch transforms. **Available Version:** 63.0 * `description` (_string_) Description of the data transform. **Available Version:** 60.0 * `fullRunFrequency` (_string_) Full run frequency of the data transform. **Available Version:** 60.0 Allowed values: `Daily`, `Monthly`, `Weekly`. * `label` (_string_, required) Label of the data transform. **Available Version:** 60.0 * `name` (_string_, required) Name of the data transform. **Available Version:** 60.0 * `primarySource` (_string_) In cases where the transformation contains table joins, describes the primary source. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_, required) Type of data transform. **Available Version:** 60.0 Allowed values: `BATCH`, `STREAMING`. ### DataTransformRepresentation Data Transform Output Represents a data transform. Includes all fields of `CdpAssetBaseRepresentation`. * `actionUrls` (_object_) Actions available for the data transform. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BatchActionRepresentation`. * `creationType` (_string_) Creation type of the data transform. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Custom`, `System`. * `dataSpaceName` (_string_) Data space for the data transform. **Filter Group:** Small **Available Version:** 60.0 * `definition` (_DcSqlDataTransformDefinitionRepresentation | StlDataTransformDefinitionRepresentation | SqlDataTransformDefinitionRepresentation_) Base definition for the data transform. The endpoint returns the definition output object that corresponds to the type of data transform. For example, the Stl Data Transform Definition Output is returned for the `Stl` and `StlHidden` types. **Filter Group:** Small **Available Version:** 60.0 One of: `DcSqlDataTransformDefinitionRepresentation`, `StlDataTransformDefinitionRepresentation`, `SqlDataTransformDefinitionRepresentation`. * `definitions` (_array of DataTransformDefinitionRepresentation_) List of definitions for batch data transforms. **Filter Group:** Small **Available Version:** 63.0 * `description` (_string_) Description of the data transform. **Filter Group:** Small **Available Version:** 60.0 * `fullRunFrequency` (_string_) Full run frequency of the data transform. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Daily`, `Monthly`, `Weekly`. * `lastRunDate` (_string_) Last date the data transform was run. **Filter Group:** Small **Available Version:** 60.0 * `lastRunErrorCode` (_object_) Error code of the last run. **Filter Group:** Big **Available Version:** 60.0 Includes all fields of `CdpErrorRepresentation`. * `lastRunStatus` (_string_) Status of the last run. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Canceled`, `Failure`, `InProgress`, `None`, `PartialFailure`, `PartiallyCanceled`, `Pending`, `Success`. * `schedule` (_object_) The schedule for the data transform. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ScheduleRepresentation`. * `status` (_string_) The status of the data transform. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Active`, `Deleting`, `Error`, `Processing`. * `type` (_string_) Type of data transform. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `BATCH`, `STREAMING`. * `version` (_integer (int64)_) Version of the data transform. **Filter Group:** Small **Available Version:** 60.0 ### CdpDataTransformActionResponseRepresentation Data Transform Action Response Output Representation for the action response of the run action for the data transform API. Includes all fields of `CdpActionResponseBaseRepresentation`. * `requestId` (_string_) Request ID assigned to this data transform run request for tracking. **Filter Group:** Small **Available Version:** 67.0 * `shouldForceFullRun` (_boolean_) Indicates whether to force the transform to run in full mode (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 ### RebuildActionInputRepresentation Rebuild Action Input Represents the input for rebuilding a data transform. * `transforms` (_array of string_) List of data transform API names or record IDs to rebuild. **Available Version:** 61.0 ### DataTransformRunHistoryCollectionRepresentation Data Transform Run History Collection Output Represents a data transform run history collection. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `histories` (_array of BatchDataTransformRunHistoryRepresentation | StreamingDataTransformRunHistoryRepresentation_, required) List of information about the jobs that the data transform has run. Each data transform run is one entry in the array. The endpoint returns the run history output object that corresponds to the type of data transform. For example, the Batch Data Transform Run History Output is returned for the `Batch` data transform type. **Filter Group:** Small **Available Version:** 62.0 ### CdpScheduleBaseRepresentation Schedule Base Output Base output class for a schedule. * `type` (_string_) Type of schedule frequency. The endpoint returns the schedule output object that corresponds to the type of schedule frequency. Only `Daily`, `Hourly`, or `None` are supported for data transforms. For example, the Daily Schedule Output is returned for the `Daily` publish frequency. **Filter Group:** Small **Available Version:** 58.0 Allowed values: `Daily`, `Hourly`, `Minutely`, `Monthly`, `MonthlyRelative`, `Weekly`, `None`, `Transform`. ### CdpScheduleInputRepresentation Data 360 Schedule Input Base schedule input representation. * `definitionName` (_string_) Name of the schedule definition. **Available Version:** 63.0 * `frequency` (_string_, required) Frequency on which the schedule is run. `None` removes the schedule and is the default. **Available Version:** 58.0 Allowed values: `Daily`, `Hourly`, `None`. * `shouldForceSpecifiedMinutes` (_boolean_) Only applicable to data transforms. If `true`, the consumer's schedule is used. If `false`, the transform is distributed over an hour to avoid hourly hotspots. Set to `true` only when the schedule is critical. If unspecified, the default value is `false`. **Available Version:** 64.0 * `time` (_object_, required) When to run the schedule. **Available Version:** 58.0 Includes all fields of `CdpTimeInputRepresentation`. ### DataTransformValidationRepresentation Data Transform Validation Output Data transform validations and output data object representation. * `issues` (_array of TransformValidationIssueRepresentation_) List of validation issues, if any. **Filter Group:** Small **Available Version:** 62.0 * `outputDataObjects` (_array of DataObjectRepresentation_) Output representation of the target object. **Filter Group:** Small **Available Version:** 62.0 ### IdpSchemaDetectionInputRepresentation Idp Schema Detection Input Represents the input for IDP schema detection. * `files` (_array of IdpGenerateSchemaFileInputRepresentation_) The list of unstructured source files to detect the schema from. Supported file types: PDF, image (PNG, JPG, JPEG), Microsoft Word (.docx), PowerPoint (.pptx), Excel (.xlsx), markdown (.md), and text (.txt). **Available Version:** 67.0 * `mlModel` (_string_) ID of the model to use for schema detection. **Available Version:** 67.0 * `mode` (_string_) Schema detection mode. * `Single`: Detect one schema for the entire document. * `Multi`: Detect and map multiple schemas to different page ranges. **Available Version:** 67.0 Allowed values: `Multi`, `Single`. * `schemaConfigurations` (_array of string_) List of Document AI schema configuration IDs to match against. **Available Version:** 67.0 ### IdpSchemaDetectionRepresentation Idp Schema Detection Output Represents IDP schema detection results. * `data` (_array of IdpSchemaDetectionInnerRepresentation_) List of schema detection results. **Filter Group:** Small **Available Version:** 67.0 ### IdpExtractDataInputRepresentation Document AI Extract Data Input Input representation for extracting data from a document. * `files` (_array of IdpGenerateSchemaFileInputRepresentation_, required) The list of unstructured data source files to extract data from. Supported file types: PDF, image (PNG, JPG, JPEG), Microsoft Word (.docx), PowerPoint (.pptx), Excel (.xlsx), markdown (.md), and text (.txt). **Available Version:** 63.0 * `idpConfigurationIdOrName` (_string_) ID of the Document AI configuration to use. Either idpConfigurationIdOrName or mlModel and schemaConfig must be present. **Available Version:** 63.0 * `mlModel` (_string_) The ID of the ML model to use for schema extraction. Use the [get Document AI global configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1global-config/get) endpoint to retrieve the list of acceptable values. **Available Version:** 63.0 * `schemaConfig` (_string_) The schema of the data to be extracted in JSON format. Use the root `description` field to provide a schema-level prompt for global instructions, such as setting the extraction language or sections to ignore. This document-wide guidance works with field-level prompts to enhance extraction accuracy across complex documents. **Available Version:** 63.0 ### IdpExtractedDataRepresentation Document AI Extracted Data Output Represents data extracted from a document. * `data` (_array of IdpExtractedFileDataRepresenation_) Extracted data. **Filter Group:** Small **Available Version:** 63.0 ### IdpGenerateSchemaInputRepresentation Document AI Generate Schema Input Input representation for generating a schema for an Document AI configuration. * `files` (_array of IdpGenerateSchemaFileInputRepresentation_, required) The list of unstructured data source files to extract the schema from. **Available Version:** 63.0 * `mlModel` (_string_, required) The ID of the ML model to use for schema extraction. Use the [get Document AI global configuration](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Document-AI/paths/~1ssot~1document-processing~1global-config/get) endpoint to retrieve the list of acceptable values. **Available Version:** 63.0 ### IdpGeneratedSchemaRepresentation Document AI Generated Schema Output Represents a generated schema for an Document AI configuration. * `error` (_string_) Error message if the schema generation fails. **Filter Group:** Small **Available Version:** 63.0 * `schema` (_string_) JSON schema definition. **Filter Group:** Small **Available Version:** 63.0 ### IdpConfigurationsCollectionRepresentation Document AI Configurations Collection Output Represents a collection of Document AI configurations with pagination information. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `configurations` (_array of IdpConfigurationRepresentation_, required) List of Document AI configurations. **Filter Group:** Small **Available Version:** 63.0 ### IdpConfigurationInputRepresentation Document AI Configuration Input Input representation for creating or updating an Document AI configuration. * `activationStatus` (_string_, required) Status of the configuration. **Available Version:** 63.0 Allowed values: `Activated`, `Deactivated`. * `configMetadata` (_object_) A custom collection of key-value attributes. **Available Version:** 63.0 * `description` (_string_) Description of the configuration. **Available Version:** 63.0 * `extractedDloConfig` (_object_) The configuration details for the DLOs to be extracted. **Available Version:** 63.0 Additional properties: `IdpConfigExtractedDloInputRepresentation`. * `fileConfig` (_object_, required) The specs for the file types supported by the Document AI process to be created. **Available Version:** 63.0 Includes all fields of `IdpFileConfigInputRepresentation`. * `label` (_string_, required) Display label of the configuration. **Available Version:** 63.0 * `mlModel` (_string_, required) The API name of the model used to extract the unstructured data. **Available Version:** 63.0 * `name` (_string_, required) Name of the configuration. **Available Version:** 63.0 * `schemaConfig` (_string_, required) The schema of the data to be extracted. **Available Version:** 63.0 * `sourceDmoDeveloperName` (_string_) The API name of the unstructured DMO used as input to the data extraction process. **Available Version:** 63.0 ### IdpConfigurationDetailsRepresentation Document AI Configuration Details Output Detailed representation of an Document AI configuration. Includes all fields of `IdpConfigurationBaseRepresentation`. * `extractedDloConfig` (_string_) The configuration details of the DLOs to be extracted. **Filter Group:** Small **Available Version:** 63.0 * `extractedDlos` (_array of IdpConfigExtractedDloRepresentation_) List of references for the output DLOs. **Filter Group:** Small **Available Version:** 63.0 * `fileConfig` (_object_) The specs for the file types supported by the Document AI process. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `IdpFileConfigRepresentation`. * `schemaConfig` (_string_) The schema of the data to be extracted. **Filter Group:** Small **Available Version:** 63.0 ### IdpConfigurationPatchInputRepresentation Document AI Configuration Patch Input Input representation for patching an Document AI configuration. * `activationStatus` (_string_) Activation status of the configuration. **Available Version:** 63.0 Allowed values: `Activated`, `Deactivated`. * `description` (_string_) New description for the configuration. **Available Version:** 63.0 * `label` (_string_) New display label for the configuration. **Available Version:** 63.0 ### IdpGlobalConfigRepresentation Document AI Global Config Output Represents the global configuration for Document AI. * `supportedContentTypes` (_array of IdpContentTypeRepresentation_) Content types supported for unstructured data extraction. **Filter Group:** Small **Available Version:** 63.0 * `supportedModels` (_array of IdpSupportedModelRepresentation_) Models supported for unstructured data extraction. **Filter Group:** Small **Available Version:** 63.0 * `version` (_string_) The version of the configuration schema. **Filter Group:** Small **Available Version:** 63.0 ### CdpIdentityResolutionsOutputRepresentation Identity Resolutions Output Represents identity resolution rulesets. * `identityResolutions` (_array of CdpIdentityResolutionOutputRepresentation_) List of identity resolution rulesets. **Filter Group:** Small **Available Version:** 57.0 ### CdpIdentityResolutionConfigInput Identity Resolution Config Input Input representation for creating an identity resolution. * `configurationType` (_string_, required) Source object for an identity resolution ruleset. Allowed values: `Account`, `Individual`. * `description` (_string_) Description of the identity resolution ruleset. **Available Version:** 57.0 * `doesRunAutomatically` (_boolean_) Specifies whether automatic job run scheduling is enabled for the ruleset (`true`) or not (`false`). If unspecified, defaults to `false`. **Available Version:** 57.0 * `label` (_string_, required) User friendly name of the identity resolution ruleset. **Available Version:** 57.0 * `matchRules` (_array of object_) List of match rules for the identity resolution ruleset. **Available Version:** 57.0 * `reconciliationRules` (_array of object_, required) List of reconciliation rules for the identity resolution ruleset. **Available Version:** 57.0 * `rulesetId` (_string_) Extended ID of the ruleset used to differentiate between rulesets created for comparison. The ruleset ID must be unique and can't be longer than 4 characters. **Available Version:** 57.0 ### CdpIdentityResolutionOutputRepresentation Identity Resolution Output Represents an identity resolution. * `anonymousUnifiedProfiles` (_integer (int64)_) Count of anonymous unified profiles created by running the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `configurationType` (_string_) Source object for an identity resolution. **Filter Group:** Small **Available Version:** 57.0 Allowed values: `Account`, `Individual`. * `consolidationRate` (_number (double)_) Consolidation rate resulting from the run of an identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `dataSpaceName` (_string_) Data space used as source data for an identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `description` (_string_) Description of the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `doesRunAutomatically` (_boolean_) Specifies whether automatic job run scheduling is enabled for the ruleset (`true`) or not (`false`). If unspecified, defaults to `false`. **Filter Group:** Small **Available Version:** 57.0 * `id` (_string_) Identity resolution ruleset's ID. This is not the identity resolution's extended ruleset ID (`rulesetId`). **Filter Group:** Small **Available Version:** 57.0 * `knownUnifiedProfiles` (_integer (int64)_) Count of known unified profiles created by running the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `label` (_string_) User friendly name of the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `lastJobCompleted` (_string_) Date and time the last job completed. **Filter Group:** Small **Available Version:** 57.0 * `lastJobStatus` (_string_) Last job's status. Possible values are: * `SUCCESS` * `IN_PROGRESS` * `FAIL` * `SCHEDULED` * `SKIPPED` **Filter Group:** Small **Available Version:** 57.0 * `matchRules` (_array of CdpIdentityResolutionMatchRuleOutput_) List of match rules. **Filter Group:** Big **Available Version:** 57.0 * `matchedSourceProfiles` (_integer (int64)_) Count of matched source profiles identified by running the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `objectApiName` (_string_) Object name of the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 * `reconciliationRules` (_array of CdpIdentityResolutionReconciliationRuleOutput_) List of reconciliation rules. **Filter Group:** Big **Available Version:** 57.0 * `rulesetId` (_string_) Extension ID of a ruleset. The ruleset ID must be unique and no longer than 4 characters. This ID is not the identifying ID for the ruleset. **Filter Group:** Small **Available Version:** 57.0 * `rulesetStatus` (_string_) Status of a ruleset job. Possible values are: * `NEW` * `PUBLISHING` * `PUBLISHED` * `ERROR` * `DELETING` * `DELETE_FAILED` **Filter Group:** Small **Available Version:** 57.0 * `sourceProfiles` (_integer (int64)_) Count of source profiles that were processed by a ruleset job. **Filter Group:** Small **Available Version:** 57.0 * `totalUnifiedProfiles` (_integer (int64)_) Count of unified profiles created by running the identity resolution ruleset. **Filter Group:** Small **Available Version:** 57.0 ### CdpIdentityResolutionConfigPatchInput Identity Resolution Config Patch Input Input representation for updating an identity resolution. * `description` (_string_) Description of the identity resolution ruleset. **Available Version:** 57.0 * `doesRunAutomatically` (_boolean_) Specifies whether automatic job run scheduling is enabled for the ruleset (`true`) or not (`false`). If unspecified, defaults to `false`. **Available Version:** 57.0 * `label` (_string_, required) User friendly name of the identity resolution ruleset. **Available Version:** 57.0 * `matchRules` (_array of object_) List of match rules for the identity resolution ruleset. **Available Version:** 57.0 * `reconciliationRules` (_array of object_, required) List of reconciliation rules for the identity resolution ruleset. **Available Version:** 57.0 ### CdpIdentityResolutionRunNowInput Identity Resolution Run Now Input Input representation for running an identity resolution on demand. * `callingApp` (_string_) Calling application. **Available Version:** 57.0 * `callingAppInfo` (_string_) Calling application information. **Available Version:** 57.0 ### CdpIdentityResolutionRunNowOutputRepresentation Identity Resolution Run Now Output Identity resolution ruleset run-now output. * `resultCode` (_string_) Result of an identity resolution ruleset job run. **Filter Group:** Small **Available Version:** 57.0 Allowed values: `ExceededMaximumNumberOfSuccessfulRunsAllowedIn24Hours`, `IdentityResolutionJobIsAlreadyRunning`, `NoPendingChangesJobRunSkipped`, `SuccessfullySubmittedIdentityResolutionJobRunRequest`. ### CdpQueryMetadataOutputRepresentation Query Metadata Output Represents query metadata. * `metadata` (_array of object_) Result metadata set. **Filter Group:** Small **Available Version:** 52.0 ### AllKnowledgeSpaceOutputRepresentation All Knowledge Space Output Represents a collection of knowledge spaces. * `knowledgeSpaces` (_array of KnowledgeSpaceOutputRepresentation_) List of knowledge spaces. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceInputRepresentation Knowledge Space Input Represents the input for creating a knowledge space. Includes all fields of `CdpAssetBaseInputRepresentation`. * `createDefaultLibrary` (_boolean_) Indicates whether to create a default library for the knowledge space (`true`) or not (`false`). If unspecified, the default value is `true`. **Available Version:** 65.0 * `dataSpace` (_string_) Name of the data space that the knowledge space belongs to. **Available Version:** 65.0 * `description` (_string_) Description of the knowledge space. **Available Version:** 65.0 * `developerName` (_string_) Developer name of the knowledge space. **Available Version:** 65.0 * `label` (_string_) Label of the knowledge space. **Available Version:** 65.0 ### KnowledgeSpaceOutputRepresentation Knowledge Space Output Represents a knowledge space. * `clientContext` (_string_) Client context of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `dataSpace` (_string_) Name of the data space that the knowledge space belongs to. **Filter Group:** Small **Available Version:** 65.0 * `description` (_string_) Description of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `developerName` (_string_) Developer name of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceConfigId` (_string_) ID of the knowledge space configuration. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceDefId` (_string_) Definition ID of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) ID of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `label` (_string_) Label of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `libraries` (_array of KnowledgeSpaceLibraryOutputRepresentation_) List of libraries in the knowledge space. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceProvisionInputRepresentation Knowledge Space Provision Input Represents the input for provisioning a knowledge space. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataSpaces` (_array of string_) List of data space names to provision. **Available Version:** 65.0 ### KnowledgeSpaceProvisionOutputRepresentation Knowledge Space Provision Output Represents the result of provisioning a knowledge space. * `success` (_boolean_) Indicates whether the provisioning request succeeded (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 65.0 ### AllKnowledgeSpaceConfigOutputRepresentation All Knowledge Space Config Output Represents a collection of knowledge space configurations. * `knowledgeSpaceConfigs` (_array of KnowledgeSpaceConfigOutputRepresentation_) List of knowledge space configurations. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceConfigInputRepresentation Knowledge Space Config Input Represents the input for creating a knowledge space configuration. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataspace` (_string_) Name of the data space that the knowledge space configuration belongs to. **Available Version:** 65.0 * `developerName` (_string_) Developer name of the configuration. **Available Version:** 65.0 * `knowledgeFileDlo` (_string_) Data lake object (DLO) identifier for the knowledge file source. **Available Version:** 65.0 * `knowledgeFileDmo` (_string_) Data model object (DMO) identifier for the knowledge file source. **Available Version:** 65.0 * `knowledgeFileRefDmo` (_string_) DMO reference for the knowledge file stream. **Available Version:** 65.0 * `knowledgeSpaceAgent` (_string_) Knowledge space agent ID. **Available Version:** 65.0 * `knowledgeSpaceFileBasedAgent` (_string_) File-based agent identifier for NotebookAI. **Available Version:** 65.0 * `knowledgeSpaceIndex` (_string_) Knowledge space search index. **Available Version:** 65.0 * `label` (_string_) Label of the configuration. **Available Version:** 65.0 * `provisioningStatus` (_string_) Provisioning status of the knowledge space. **Available Version:** 65.0 ### KnowledgeSpaceConfigOutputRepresentation Knowledge Space Config Output Represents a knowledge space configuration. * `dataspace` (_string_) Name of the data space that the knowledge space configuration belongs to. **Filter Group:** Small **Available Version:** 65.0 * `developerName` (_string_) Developer name of the configuration. **Filter Group:** Small **Available Version:** 65.0 * `instanceUrl` (_string_) Instance URL of the org. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeFileDlo` (_string_) Data lake object (DLO) identifier for the knowledge file source. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeFileDmo` (_string_) Data model object (DMO) identifier for the knowledge file source. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeFileRefDmo` (_string_) DMO reference for the knowledge file stream. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceAgentActiveVersion` (_string_) Active version of the knowledge space agent. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceAgentId` (_string_) Knowledge space agent ID. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceConfigId` (_string_) ID of the knowledge space configuration. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceFileBasedAgent` (_string_) File-based agent identifier for NotebookAI. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceIndex` (_string_) Knowledge space search index. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceIndexId` (_string_) ID of the knowledge space search index. **Filter Group:** Small **Available Version:** 65.0 * `label` (_string_) Label of the configuration. **Filter Group:** Small **Available Version:** 65.0 * `provisioningStatus` (_string_) Provisioning status of the configuration. **Filter Group:** Small **Available Version:** 65.0 ### AllKnowledgeSpaceLibraryOutputRepresentation All Knowledge Space Library Output Represents a collection of knowledge libraries across all knowledge spaces. * `knowledgeSpaceLibraries` (_array of KnowledgeSpaceLibraryOutputRepresentation_) List of knowledge libraries across all knowledge spaces. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceLibraryInputRepresentation Knowledge Space Library Input Represents the input for creating a knowledge space library. Includes all fields of `CdpAssetBaseInputRepresentation`. * `description` (_string_) Description of the library. **Available Version:** 65.0 * `developerName` (_string_) Developer name of the library. **Available Version:** 65.0 * `knowledgeLibraryId` (_string_) Knowledge library ID. **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) ID of the knowledge space associated with the library. **Available Version:** 65.0 * `label` (_string_) Label of the library. **Available Version:** 65.0 ### KnowledgeSpaceLibraryOutputRepresentation Knowledge Space Library Output Represents a knowledge space library. * `developerName` (_string_) Developer name of the library. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeCategory` (_string_) Knowledge category. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeLibraryId` (_string_) ID of the library. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) ID of the parent knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceName` (_string_) Name of the parent knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `label` (_string_) Label of the library. **Filter Group:** Small **Available Version:** 65.0 * `sources` (_array of KnowledgeSourceOutputRepresentation_) List of knowledge sources in the library. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceUploadPresignedUrlInputRepresentation Knowledge Space Upload Presigned Url Input Represents the input for requesting a presigned URL to upload files to a knowledge space. * `fileNames` (_array of string_) List of file names to upload. **Available Version:** 65.0 * `libraryId` (_string_) ID of the knowledge space library. **Available Version:** 65.0 ### KnowledgeSpaceUploadPresignedURLOutputRepresentation Knowledge Space Upload Presigned U R L Output Represents the presigned URLs for uploading files to a knowledge space. * `presignedUrls` (_array of string_) List of presigned URLs for uploading to a knowledge library. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceIndexFilesInputRepresentation Knowledge Space Index Files Input Represents the input for indexing knowledge space files. Includes all fields of `CdpAssetBaseInputRepresentation`. * `knowledgeArtifactId` (_string_) Unique identifier of the knowledge artifact. **Available Version:** 65.0 * `knowledgeArtifactSource` (_string_) Source system or origin of the knowledge artifact. **Available Version:** 65.0 * `knowledgeSourceFilesList` (_array of object_) List of knowledge source files to index. **Available Version:** 65.0 * `knowledgeSourceId` (_string_) Unique identifier of the knowledge source. Applies only to URL sources. **Available Version:** 65.0 * `searchIndexApiName` (_string_) API name of the search index to use for knowledge indexing. **Available Version:** 65.0 * `websiteUrl` (_string_) Website URL. **Available Version:** 65.0 ### KnowledgeSpaceIndexFilesOutputRepresentation Knowledge Space Index Files Output Represents the result of indexing knowledge space files. * `knowledgeArtifactId` (_string_) Unique identifier of the knowledge artifact. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeArtifactSource` (_string_) Source system or origin of the knowledge artifact. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSourceFilesList` (_array of KnowledgeSourceFileOutputRepresentation_) List of indexed knowledge source files. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSourceId` (_string_) Unique identifier of the knowledge source. **Filter Group:** Small **Available Version:** 65.0 * `offCoreJobId` (_string_) Off-core job ID from the search index API call. **Filter Group:** Small **Available Version:** 65.0 * `searchIndexApiName` (_string_) API name of the search index. **Filter Group:** Small **Available Version:** 65.0 * `websiteUrl` (_string_) Website URL. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceFileStatusInputRepresentation Knowledge Space File Status Input Represents the input for retrieving knowledge space file status. Includes all fields of `CdpAssetBaseInputRepresentation`. * `fileIds` (_array of string_) List of file IDs to retrieve status for. **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) Knowledge space ID. **Available Version:** 65.0 ### KnowledgeSpaceFilesStatusOutputRepresentation Knowledge Space Files Status Output Represents the status of knowledge space files. * `files` (_array of KnowledgeSourceFileOutputRepresentation_) List of knowledge source file statuses. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceFileChunksInputRepresentation Knowledge Space File Chunks Input Represents the input for retrieving knowledge space file chunks. Includes all fields of `CdpAssetBaseInputRepresentation`. * `additionalFilter` (_object_) Additional filter parameters. **Available Version:** 65.0 Additional properties: `object`. * `containerId` (_array of string_) List of container IDs. **Available Version:** 65.0 * `searchIndexName` (_string_) Name of the search index. **Available Version:** 65.0 ### KnowledgeSpaceFileChunksOutputRepresentation Knowledge Space File Chunks Output Represents the file chunks for a knowledge space. * `allChunks` (_string_) Content of all chunks. **Filter Group:** Small **Available Version:** 65.0 * `filepath` (_string_) File path. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeModalInputRepresentation Knowledge Modal Input Represents the input for a knowledge modal. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataSpace` (_string_) Name of the data space that the knowledge modal belongs to. **Available Version:** 65.0 * `filterList` (_object_) Knowledge select filters. **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) Knowledge space ID. **Available Version:** 65.0 * `selectedList` (_object_) List of knowledge select options. **Available Version:** 65.0 * `type` (_string_) Type of knowledge source. **Available Version:** 65.0 ### KnowledgeModalOutputRepresentation Knowledge Modal Output Represents a knowledge modal. * `knowledgeList` (_array of KnowledgeSpaceLibraryOutputRepresentation_) List of knowledge space libraries. **Filter Group:** Small **Available Version:** 65.0 * `searchIndexes` (_array of SemanticSearchDefDetailRepresentation_) List of semantic search summaries. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceDeepResRunResearchOutputRepresentation Knowledge Space Deep Research Run Output Represents the result of starting a deep research job. * `researchId` (_string_) Deep research job identifier. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceRunResearchOutputRepresentation Knowledge Space Run Research Output Represents the status and results of a deep research job. * `config` (_object_) Deep research configuration. **Filter Group:** Small **Available Version:** 67.0 * `error` (_object_) Error details if the job failed. **Filter Group:** Small **Available Version:** 67.0 * `plan` (_object_) Execution plan with steps. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `KnowledgeSpaceDeepResearchPlanOutputRepresentation`. * `query` (_string_) Query text. **Filter Group:** Small **Available Version:** 67.0 * `report` (_object_) Report content. **Filter Group:** Small **Available Version:** 67.0 * `researchId` (_string_) Deep research job identifier. **Filter Group:** Small **Available Version:** 67.0 * `runDetails` (_object_) Execution details. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Job status. Valid values are PENDING, RUNNING, COMPLETED, FAILED, and CANCELLED. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchPlanPatchInputRepresentation Knowledge Space Deep Research Plan Patch Input Represents the input for updating a deep research plan before execution. Includes all fields of `CdpAssetBaseInputRepresentation`. * `editInstructions` (_string_) Natural-language instructions for modifying the research plan. **Available Version:** 67.0 * `plan` (_object_) Direct plan update with explicit steps. **Available Version:** 67.0 Includes all fields of `KnowledgeSpaceDeepResearchPlanPatchPlanInputRepresentation`. * `researchTemplateId` (_string_) ID of the research template to use for the research job. **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchCancelInputRepresentation Knowledge Space Deep Research Cancel Input Represents the input for canceling a deep research job. Includes all fields of `CdpAssetBaseInputRepresentation`. * `partialReport` (_boolean_) Indicates whether to request a partial report from completed steps (`true`) or not (`false`). **Available Version:** 67.0 ### KnowledgeSpaceDeepResReportInputRepresentation Knowledge Space Deep Research Report Input Represents the input for requesting a deep research report. Includes all fields of `CdpAssetBaseInputRepresentation`. * `outputFormat` (_string_) Output format of the deep research report. **Available Version:** 67.0 ### KnowledgeSpaceDeepResReportOutputRepresentation Knowledge Space Deep Research Report Output Represents a deep research report. * `report` (_string_) Content of the deep research report. **Filter Group:** Small **Available Version:** 67.0 * `researchId` (_string_) Deep research job identifier. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchAddSourceInputRepresentation Knowledge Space Deep Research Add Source Input Represents the input for adding deep research as a knowledge source. Includes all fields of `CdpAssetBaseInputRepresentation`. * `fileName` (_string_) File name that overrides the default. If unspecified, the default value is the base name of `reportFilePath`. **Available Version:** 67.0 * `reportFilePath` (_string_) Short-lived sfdrive path where the report is stored. **Available Version:** 67.0 * `researchId` (_string_) Deep research job identifier, used for logging. **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchAddSourceOutputRepresentation Knowledge Space Deep Research Add Source Output Represents the result of adding deep research as a knowledge source. * `knowledgeSourceId` (_string_) ID of the GENERATED\_RESOURCES knowledge source in the library. **Filter Group:** Small **Available Version:** 67.0 * `knowledgeSrcFileRefId` (_string_) ID of the knowledge source file reference record. **Filter Group:** Small **Available Version:** 67.0 * `persistedFilePath` (_string_) Persistent sfdrive path of the copied report. **Filter Group:** Small **Available Version:** 67.0 ### AllKnowledgeSpaceSessionOutputRepresentation All Knowledge Space Session Output Represents a collection of active conversational sessions. * `knowledgeSpaceSessions` (_array of KnowledgeSpaceSessionOutputRepresentation_) List of active conversational sessions. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceSessionInputRepresentation Knowledge Space Session Input Represents the input for creating a knowledge space session. Includes all fields of `CdpAssetBaseInputRepresentation`. * `knowledgeSpaceId` (_string_) Knowledge space ID. **Available Version:** 65.0 * `lastActiveTime` (_string_) Last active time of the session. **Available Version:** 65.0 * `sessionId` (_string_) Session ID. **Available Version:** 65.0 ### KnowledgeSpaceSessionOutputRepresentation Knowledge Space Session Output Represents a knowledge space session. * `agentType` (_string_) Agent type used when the session was created. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceDefId` (_string_) Definition ID of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceId` (_string_) ID of the knowledge space. **Filter Group:** Small **Available Version:** 65.0 * `knowledgeSpaceSessionEntityId` (_string_) Entity ID of the knowledge space session. **Filter Group:** Small **Available Version:** 65.0 * `lastActiveTime` (_string_) Last active time of the session. **Filter Group:** Small **Available Version:** 65.0 * `sessionId` (_string_) ID of the knowledge space session. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceSessionConversationOutputRepresentation Knowledge Space Session Conversation Output Represents the conversation for a knowledge space session. * `messages` (_array of KnowledgeSpaceConversationMsgOutputRepresentation_) List of conversation messages. **Filter Group:** Small **Available Version:** 65.0 ### MlDataAlertQueryInputRepresentation ML Data Alert Query Input Represents the input for a data alert query. * `asset` (_string_) Asset name or ID of the alert. **Available Version:** 61.0 * `assetType` (_string_) Asset type of the alert. **Available Version:** 61.0 Allowed values: `ModelArtifact`. * `sourceTypes` (_array of string_) Deployed or stored artifact of an ML model. **Available Version:** 61.0 Items: Allowed values: `ModelTraining`, `Runtime`. ### MlDataAlertCollectionRepresentation ML Data Alert Collection Output Represents a collection of data alerts for an ML model. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `alerts` (_array of MlDataAlertRepresentation_) A list of data alerts. **Filter Group:** Small **Available Version:** 61.0 * `source` (_object_) Source the data alerts originate from. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. ### MlDataAlertInputRepresentation ML Data Alert Input Represents the input for creating or updating a data alert. * `accepted` (_boolean_) Indicates whether the alert is accepted (`true`) or not (`false`). Include only one of the properties, `accepted` or `dismissed`, with the request. **Available Version:** 61.0 * `dismissed` (_boolean_) Indicates whether the alert is dismissed (`true`) or not (`false`). Include only one of the properties, `accepted` or `dismissed`, with the request **Available Version:** 61.0 * `id` (_string_) ID of the alert. **Available Version:** 61.0 ### MlDataAlertRepresentation ML Data Alert Output Represents a single data alert. * `accepted` (_boolean_) Indicates whether the alert is accepted (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `alertType` (_string_) Type of alert. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Auc`, `CollinearFields`, `CorrelateWithProtectedFields`, `CrossValidationFailed`, `DataLeakage`, `DisparateImpact`, `ExtremeValues`, `FalsePredictionRate`, `HighCardinality`, `MissingCategoricalValues`, `MissingNumericalValues`, `ObviousPredictor`, `RecommendedBuckets`, `Rsquared`, `SingleValue`, `SingleValueWithOther`. * `applicable` (_boolean_) Indicates whether the alert is applicable (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `directives` (_array of MlImprovementDirectiveRepresentation_) List of improvement directives (suggested actions) associated with the alert. **Filter Group:** Small **Available Version:** 61.0 * `dismissed` (_boolean_) Indicates whether the alert is dismissed (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `id` (_string_) ID of the alert. **Filter Group:** Small **Available Version:** 61.0 * `key` (_string_) Unique key for the alert. **Filter Group:** Small **Available Version:** 61.0 * `lastStatusChangeBy` (_object_) User or system that last changed the status of the alert. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpUserRepresentation`. * `lastStatusChangeDate` (_string_) Date when the alert's status was last changed. **Filter Group:** Small **Available Version:** 61.0 * `lastStatusChangeVersion` (_integer_) Version number associated with the alert's most recent status change. **Filter Group:** Small **Available Version:** 61.0 * `message` (_string_) Alert message. **Filter Group:** Small **Available Version:** 61.0 * `relatedData` (_object_) Data that is related to the alert. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlDataAlertDataBaseRepresentation`. * `sourceType` (_string_) Source type of alert. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `ModelTraining`, `Runtime`. * `subject` (_string_) Subject of the alert. **Filter Group:** Small **Available Version:** 61.0 * `url` (_string_) URL of the data alert. **Filter Group:** Small **Available Version:** 61.0 ### MlConfiguredModelCollectionRepresentation ML Configured Model Collection Output Represents Ml Configured Model Collection Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `configuredModels` (_array of MlConfiguredModelRepresentation_, required) List of configured models that are available in the org. **Filter Group:** Small **Available Version:** 59.0 ### MlConfiguredModelRepresentation ML Configured Model Output Represents a machine learning configured model output. Includes all fields of `CdpAssetBaseRepresentation`. * `actionableFields` (_array of CdpMlCustomizableFieldRepresentation_) List of actionable fields. **Filter Group:** Small **Available Version:** 61.0 * `activations` (_array of string_) List of activations. **Filter Group:** Small **Available Version:** 61.0 Items: Allowed values: `Flow`, `PredictionJob`. * `artifact` (_object_) The model artifact. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `capability` (_string_) Model capability. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `BinaryClassification`, `ChatCompletion`, `Completion`, `Embedding`, `Generic`, `MulticlassClassification`, `Regression`. * `connectorType` (_string_) If the configured model references a model connector, this parameter indicates the connector type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Anthropic`, `AzureOpenAI`, `Bedrock`, `Databricks`, `Generic`, `InternalEmbedding`, `OpenAI`, `SageMaker`, `VertexAI`. * `description` (_string_) User-defined description of the configured model. **Filter Group:** Small **Available Version:** 61.0 * `foundationalModel` (_object_) Details for the foundational model. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpMlFoundationalModelRepresentation`. * `generativeModelType` (_string_) Type of generative model. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Mixed`, `Text`. * `inputFields` (_array of CdpMlModelInputFieldBaseRepresentation_) List of input features into the model. **Filter Group:** Small **Available Version:** 59.0 * `inputTypes` (_array of MlModelInputTypeRepresentation_) List of supporting input types for multi-modalities. This includes parameters, such as maxToken for text input limits or maxImages for image input capacity. **Filter Group:** Small **Available Version:** 63.0 * `isBatchSupported` (_boolean_) Indicates whether this model supports batch (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `lastActivatedBy` (_object_) Information about the user who last activated the configured model. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpUserRepresentation`. * `lastActivatedDate` (_string_) Date the configured model was last activated. **Filter Group:** Small **Available Version:** 61.0 * `modelCapabilities` (_array of string_) List of capabilities supported by the model. **Filter Group:** Small **Available Version:** 63.0 Items: Allowed values: `BinaryClassification`, `ChatCompletion`, `Completion`, `Embedding`, `Generic`, `MulticlassClassification`, `Regression`, `SpeechSynthesis`, `Summarization`, `Transcribe`. * `modelDisabledReasons` (_array of string_) Reason(s) why the model status is disabled. **Filter Group:** Small **Available Version:** 64.0 * `modelType` (_string_) Referenced model type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Generative`, `Predictive`, `Unknown`. * `outputFields` (_array of CdpMlModelOutputFieldRepresentation_) List of output features from the model. **Filter Group:** Small **Available Version:** 59.0 * `outputTypes` (_array of MlModelOutputTypeRepresentation_) List of supporting output types for multi-modalities, including parameters and their corresponding values. **Filter Group:** Small **Available Version:** 63.0 * `parameterOverrides` (_array of CdpMlModelParameterOverrideBaseRepresentation_) List of model parameter overrides. **Filter Group:** Small **Available Version:** 61.0 * `parameters` (_array of CdpMlModelParameterDefinitionBaseRepresentation_) List of parameters supported by the model. **Filter Group:** Small **Available Version:** 59.0 * `runtimeType` (_string_) Model runtime type. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `External`, `Internal`. * `setupType` (_string_) Referenced setup type. * `OutOfTheBox` — a model managed by Salesforce. * `ModelConnector` — an external model exposed to Salesforce through a connector. * `EdcNoCode` — a model created using a no-code or low-code model builder. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `EdcNoCode`, `ModelConnector`, `OutOfTheBox`. * `status` (_string_) Model status. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Disabled`, `Enabled`. * `visibility` (_string_) Model visibility. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Hidden`, `Shown`. ### MlConfiguredModelInputRepresentation ML Configured Model Input Input representation for an Ml Configured Model * `actionableFields` (_array of object_, required) List of actionable fields. An actionable field is a data field or variable in your dataset that you can use to drive actions based on the model's predictions. These fields are typically used to trigger workflows, automation, or other follow-up actions in Salesforce. **Filter Group:** Small **Available Version:** 61.0 * `artifact` (_object_, required) Model artifact. **Available Version:** 61.0 * `capability` (_string_, required) The model's capabilities. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `BinaryClassification`, `ChatCompletion`, `Completion`, `Embedding`, `Generic`, `MulticlassClassification`, `Regression`. * `description` (_string_, required) Model description. **Available Version:** 61.0 * `label` (_string_, required) Model's label. **Available Version:** 61.0 * `parameterOverrides` (_array of object_, required) Model parameter overrides. **Available Version:** 61.0 * `status` (_string_, required) Whether the model is enabled or disabled. **Available Version:** 61.0 Allowed values: `Disabled`, `Enabled`. ### CdpMlJobCollectionRepresentation Ml Job Collection Output Represents a list of machine learning jobs. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `jobs` (_array of CdpMlJobBaseRepresentation_) List of jobs. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlJobBaseRepresentation Ml Job Base Output Represents a machine learning job. Includes all fields of `CdpAssetBaseRepresentation`. * `description` (_string_) Description of the job. **Filter Group:** Small **Available Version:** 59.0 * `endTime` (_string_) End time of the job run. **Filter Group:** Small **Available Version:** 59.0 * `input` (_object_) Asset input for the job run. For `Training` types, use the model setup ID. For `Prediction` types, use the model container ID. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `message` (_string_) Message associated with the job run. **Filter Group:** Small **Available Version:** 59.0 * `startTime` (_string_) Start time of the job run. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Type of job. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Prediction`, `Training`. ### CdpMlTaskCollection Ml Task Collection Output Represents a list of machine learning job tasks. * `tasks` (_array of CdpMlTaskBase_) List of tasks. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlTaskBase Ml Task Base Output Represents a machine learning job task. Includes all fields of `CdpAssetBaseRepresentation`. * `endTime` (_string_) End time of the job run. **Filter Group:** Small **Available Version:** 59.0 * `errorCode` (_string_) Error code, if any. **Filter Group:** Small **Available Version:** 59.0 * `message` (_string_) Message associated with the job run. **Filter Group:** Small **Available Version:** 59.0 * `startTime` (_string_) Start time of the job run. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlModelArtifactCollectionRepresentation ML Model Artifact Collection Output Represents an ML model artifact collection. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `modelArtifacts` (_array of CdpMlModelArtifactBaseRepresentation_, required) List of model artifacts. **Filter Group:** Small **Available Version:** 61.0 ### CdpMlModelArtifactBaseRepresentation ML Model Artifact Base Output Represents a base ML model artifact. Includes all fields of `CdpAssetBaseRepresentation`. Discriminator: `modelType` selects the concrete type. * `description` (_string_) Description of the artifact. **Filter Group:** Small **Available Version:** 61.0 * `inputFields` (_array of CdpMlModelInputFieldBaseRepresentation_) Input fields for the model artifact. **Filter Group:** Small **Available Version: 61.0** * `isBatchSupported` (_boolean_) Indicates whether this model supports batch (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `modelConnectorEndpoint` (_object_) Model connector endpoint definition. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlConnectorEndpointRepresentation`. * `modelCount` (_integer_) Number of configured models from this model artifact. **Filter Group:** Small **Available Version:** 61.0 * `modelType` (_string_) Model type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Generative`, `Predictive`, `Unknown`. * `modelDisabledReasons` (_array of string_) Reason(s) why the model status is disabled. **Filter Group:** Small **Available Version:** 64.0 * `outputFields` (_array of CdpMlModelOutputFieldRepresentation_) Model artifact's output fields. **Filter Group:** Small **Available Version: 61.0** * `parameters` (_array of CdpMlModelParameterDefinitionBaseRepresentation_) Model parameters. **Filter Group:** Small **Available Version:** 61.0 * `runtimeType` (_string_) Runtime type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `External`, `Internal`. * `setupContainer` (_object_) Setup container. **Filter Group:** Small **Available Version: 61.0** Includes all fields of `CdpAssetReferenceRepresentation`. * `source` (_object_) Information about the source of the artifact. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `sourceContainer` (_object_) Information about the artifact's source container. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `sourceType` (_string_) The type of model artifact. * `OutOfTheBox` - an artifact managed by Salesforce. * `ModelConnector` - an external artifact exposed to Salesforce through a connector. * `EdcNoCode` - an artifact created using a no-code or low-code model builder. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `EdcNoCode`, `ModelConnector`, `OutOfTheBox`. * `status` (_string_) Model artifact status. **Available Version:** 61.0 Allowed values: `Disabled`, `Draft`, `Enabled`. * `syncStatus` (_string_) Sync status. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Error`, `NotSynced`, `Synced`, `Syncing`. ### CdpMlModelArtifactInputRepresentation ML Model Artifact Input Represents ML model artifact input. * `description` (_string_, required) The model artifact's description. **Available Version:** 61.0 * `label` (_string_, required) Model artifact's label. **Available Version:** 61.0 * `status` (_string_, required) Model artifact's status. **Available Version:** 61.0 Allowed values: `Disabled`, `Draft`, `Enabled`. ### CdpMlSetupVersionCollectionRepresentation ML Setup Version Collection Output Represents a collection of model setup versions that includes metadata and configuration information for each setup version. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `versions` (_array of CdpMlSetupBaseRepresentation_) List of setup versions. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlSetupBaseInputRepresentation ML Setup Base Input Represents the base class for the core input fields needed to create a setup version for an ML model. * `description` (_string_) Description of the setup. **Available Version:** 59.0 * `type` (_string_) Setup type. **Available Version:** 59.0 Allowed values: `EdcNoCode`, `ModelConnector`. ### CdpMlSetupBaseRepresentation ML Setup Base Output Represents the base class for the core metadata and shared fields needed to set up a ML model. Includes all fields of `CdpAssetBaseRepresentation`. * `active` (_boolean_) Indicates whether the setup is active (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 * `description` (_string_) Description of the setup. **Filter Group:** Small **Available Version:** 59.0 * `numberOfPartitions` (_integer_) Number of partitions in a model setup version. **Filter Group:** Small **Available Version:** 59.0 * `partitionsUrl` (_string_) URL for retrieving the partitions associated with a model setup version. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Setup type. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `EdcNoCode`, `ModelConnector`. * `version` (_integer_) Setup version number. **Filter Group:** Small **Available Version:** 59.0 ### MlSetupBaseUpdateInputRepresentation ML Setup Base Update Input Represents the base class for the core fields you can update in a model setup. * `type` (_string_) Setup type. **Available Version:** 59.0 Allowed values: `EdcNoCode`, `ModelConnector`. ### CdpMlSetupVersionPartitionCollectionRepresentation ML Setup Version Partition Collection Output Respresents a collection of model setup version partitions. * `partitions` (_array of CdpMlSetupPartitionBaseRepresentation_) List of partitions. **Filter Group:** Small **Available Version:** 59.0 * `totalSize` (_integer_) Total size of the collection. **Filter Group:** Small **Available Version:** 59.0 * `url` (_string_) URL of the page. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlSetupPartitionBaseRepresentation ML Setup Partition Base Output Represents the base class for the core metadata and shared fields for a model setup partition. Includes all fields of `CdpAssetBaseRepresentation`. * `description` (_string_) Description of the model setup partition. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Setup type. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `EdcNoCode`, `ModelConnector`. ### CdpMlPredictInputBaseRepresentation ML Predict Input Representation Represents prediction input. * `fieldNames` (_array of string_, required) The names of the input fields that the model uses when making the prediction. The fields must be in the same order specified in the model artifact's `inputFields` parameter. * `rows` (_array of object_, required) The set or sets of values of the fields listed in `fieldNames`. For example, if your `fieldNames` are `["State", "Industry", "ACV"]`, your value for `Rows` could be `[["Texas", "Aerospace", "3000000"],["Arizona", "Semiconductors", "5500000"]]`. * `model` (_object_, required) The model's name or ID, for example: ```json { "name": "titanic_simple" } ``` or ```json { "id": "12lX40000000DAKIA2" } ``` **Available Version:** 60.0 * `settings` (_object_) The model configuration settings used to generate the prediction. **Available Version:** 61.0 * `aggregateFunctions` (_array of string_) Reserved for future use. **Available Version:** 61.0 * `maxPrescriptions` (_integer_) Maximum number of recommendations. The allowed range is `-1` through `200`, and the default value is `-1` (unlimited). **Available Version:** 61.0 * `maxTopFactors` (_integer_) Maximum top factor count. The allowed range is `0` through `3`, and the default value is `0`. **Available Version:** 61.0 * `prescriptionImpactPercentage` (_integer_) Indicates the minimum impact percentage of the prescriptions to return. Only prescriptions with a greater or equal impact percentage are returned. The allowed range is `0` through `100`, and the default value is `0`. **Available Version:** 61.0 * `type` (_string_, required) Type of prediction. **Available Version:** 61.0 Allowed values: `RawData`. ### CdpMlPredictResultRepresentation ML Predict Result Output Represent an ML prediction result. * `aggregatePredictions` (_array of CdpMlAggregatePredictionRepresentation_) Aggregate result list. **Filter Group:** Small **Available Version:** 61.0 * `model` (_object_) Model asset reference used as part of the prediction request. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `predictionType` (_string_) Prediction type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `BinaryClassification`, `Generic`, `Regression`. * `predictions` (_array of CdpMlPredictionBaseRepresentation_) A list of prediction results. **Filter Group:** Small **Available Version:** 61.0 * `settings` (_object_) Settings used for the prediction. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpMlPredictSettingsRepresentation`. ### MlPredictionJobDefCollectionRepresentation Ml Prediction Job Def Collection Output Represents a collection of prediction job definitions. * `predictionJobDefinitions` (_array of MlPredictionJobDefBaseRepresentation_) List of prediction jobs. **Filter Group:** Small **Available Version:** 59.0 * `totalSize` (_integer_) Total size of the prediction jobs returned. **Filter Group:** Small **Available Version:** 59.0 * `url` (_string_) URL of the page. **Filter Group:** Small **Available Version:** 59.0 ### MlPredictionJobDefBaseInputRepresentation Ml Prediction Job Def Base Input Represents the input configuration for a prediction job definition. * `activationStatus` (_string_) Activation status of the prediction job. **Available Version:** 59.0 Allowed values: `Active`, `Inactive`. * `apiName` (_string_) API name of the prediction job. **Available Version:** 59.0 * `description` (_string_) Description of the prediction job. **Available Version:** 59.0 * `label` (_string_) Label of the prediction job. **Available Version:** 59.0 * `model` (_object_) Model associated with the prediction job. **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `outputConfig` (_object_) Output data model object (DMO) details. **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefPredictionsConfigInputRepresentation`. * `scoringMode` (_string_) Scoring mode for the prediction job. **Available Version:** 59.0 Allowed values: `Batch`, `Streaming`. * `type` (_string_) Type of prediction job. Use the job def input object that corresponds to the job type. For example, use the Ml Binary Classification Job Def Input for the `BinaryClassification` job type. **Available Version:** 59.0 Allowed values: `BinaryClassification`, `Clustering`, `MulticlassClassification`, `Regression`, `SentimentDetection`, `TopicClassification`. ### MlPredictionJobDefBaseRepresentation Ml Prediction Job Def Base Output Represents the base output for a prediction job definition. * `activationStatus` (_string_) Activation status of the prediction job. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Active`, `Inactive`. * `dataSpace` (_object_) Data space details for the prediction job. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `description` (_string_) Description of the prediction job. **Filter Group:** Small **Available Version:** 59.0 * `lastRunDate` (_string_) Last execution date for the prediction job. **Filter Group:** Small **Available Version:** 59.0 * `lastRunStatus` (_string_) Status of the last execution. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Aborted`, `Failed`, `InProgress`, `NotStarted`, `Pending`, `Submited`, `Success`. * `model` (_object_) Model associated with the prediction job. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `outputConfig` (_object_) Output data model object (DMO) details. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefPredictionsConfigRepresentation`. * `scoringMode` (_string_) Scoring mode for the prediction job. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Batch`, `Streaming`. * `type` (_string_) Type of prediction job. The endpoint returns the job def output object that corresponds to the job type. For example, the Ml Binary Classification Job Def Output is returned for the `BinaryClassification` job type. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `BinaryClassification`, `Clustering`, `MulticlassClassification`, `Regression`, `SentimentDetection`, `TopicClassification`. ### MlRetrieverCollectionRepresentation Ml Retriever Collection Output Represents a paginated list of retrievers. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `retrievers` (_array of MlRetrieverRepresentation_) List of retrievers. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverInputRepresentation Ml Retriever Input Represents the input for creating a retriever. * `configuration` (_object_, required) Initial configuration. Use the configuration input object that corresponds to the type of query. For example, use the Ml Retriever Configuration Custom Sql Input for the `CustomSql` type. **Available Version:** 61.0 Includes all fields of `MlRetrieverConfigurationBaseInputRepresentation`. * `dataSpaces` (_array of string_) List of data space names. Required for `CustomSql` and `NoCode` retrievers. Derive the data space from the referenced retrievers for `Ensemble` retrievers. **Available Version:** 61.0 * `description` (_string_) Description of the retriever. **Available Version:** 61.0 * `label` (_string_, required) Label of the retriever. **Available Version:** 61.0 * `ownerType` (_string_, required) Type of owner. **Available Version:** 61.0 Allowed values: `AiAgent`, `Api`. ### MlRetrieverRepresentation Ml Retriever Output Represents a retriever with its latest and active configurations. Includes all fields of `CdpAssetBaseRepresentation`. * `activeConfiguration` (_object_) Currently active configuration. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverConfigurationBaseRepresentation`. * `configurationsUrl` (_string_) URL of the configurations sub-resource. **Filter Group:** Small **Available Version:** 61.0 * `connection` (_object_) Connection reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `dataSourceType` (_string_) Type of data source. Use `RealTimeSearchIndex` or `SearchIndex` for `NoCode` retrievers, and `DataCloudAsset` for `CustomSql` retrievers. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `DataCloudAsset`, `RealTimeSearchIndex`, `SearchIndex`. * `dataSpaces` (_array of CdpAssetReferenceRepresentation_) List of data spaces. **Filter Group:** Small **Available Version:** 61.0 * `description` (_string_) Description of the retriever. **Filter Group:** Small **Available Version:** 61.0 * `isDefault` (_boolean_) Indicates whether the retriever is the default for its search index (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `isGlobal` (_boolean_) Indicates whether the retriever is global (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `isVirtual` (_boolean_) Indicates whether the retriever is virtual (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `latestConfiguration` (_object_) Most recent configuration version. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverConfigurationBaseRepresentation`. * `ownerType` (_string_) Type of owner. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Adl`, `AiAgent`, `Api`, `Customer`, `IntelligentContext`, `Internal`, `Ui`. * `ownership` (_object_) Owner reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `queryType` (_string_) Type of query. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `CustomSql`, `Ensemble`, `NoCode`. * `retrieverLifetime` (_string_) Lifetime of the retriever. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Persistent`, `Transient`. ### MlRetrieverReviewInputRepresentation Ml Retriever Review Input Represents the input for reviewing a CustomSql retriever. * `existingRetrieverAsset` (_object_) Reference to an existing retriever when reviewing a new configuration. **Available Version:** 67.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `retrieverInput` (_object_, required) Retriever input to review. **Available Version:** 67.0 Includes all fields of `MlRetrieverInputRepresentation`. ### MlRetrieverReviewRepresentation Ml Retriever Review Output Represents the review result for a CustomSql retriever input. * `extractedSelectColumns` (_array of MlRetrieverReviewSelectColumnRepresentation_) List of SELECT columns extracted from the SQL query. **Filter Group:** Small **Available Version:** 67.0 * `findings` (_array of MlRetrieverReviewItemRepresentation_) List of review findings, such as errors and suggestions. **Filter Group:** Small **Available Version:** 67.0 * `hasErrors` (_boolean_) Indicates whether the input has errors that prevent creation (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 ### MlRetrieverUpdateInputRepresentation Ml Retriever Update Input Represents the input for updating a retriever. All fields are optional. * `description` (_string_) Description of the retriever. **Available Version:** 67.0 * `label` (_string_) Label of the retriever. **Available Version:** 67.0 ### MlRetrieverConfigurationCollectionRepresentation Ml Retriever Configuration Collection Output Represents a paginated list of configurations. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `configurations` (_array of MlRetrieverConfigurationRepresentation_) List of configurations. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverConfigurationBaseInputRepresentation Ml Retriever Configuration Base Input Represents the input for creating a retriever configuration. * `isActive` (_boolean_) Indicates whether to activate the configuration on creation (`true`) or not (`false`). **Available Version:** 61.0 * `isCitationEnabled` (_boolean_) Indicates whether to include citation fields (source record ID, label, URL) in results (`true`) or not (`false`). For CustomSql, `isCitationSupported` must be `true`. **Available Version:** 61.0 * `numberOfResults` (_integer_) Maximum number of results to return. Must be a positive integer. If unspecified, the default value is `10`. **Available Version:** 61.0 * `queryType` (_string_, required) Type of query. **Available Version:** 61.0 Allowed values: `CustomSql`, `Ensemble`, `NoCode`. * `retrievalMode` (_string_) Retrieval mode. **Available Version:** 61.0 Allowed values: `Advanced`, `Basic`. ### MlRetrieverConfigurationDetailRepresentation Ml Retriever Configuration Detail Output Represents a configuration with full details. Includes all fields of `MlRetrieverConfigurationBaseRepresentation`. * `citationConfiguration` (_object_) Citation configuration. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverCitationConfigurationRepresentation`. * `fieldPlaceholders` (_array of MlFieldPlaceholderRepresentation_) List of field placeholders with parameter values specified at runtime. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 * `isAdvancedModeSupported` (_boolean_) Indicates whether advanced mode is supported (`true`) or not (`false`). Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 * `isCitationSupported` (_boolean_) Indicates whether citation output is supported (`true`) or not (`false`). Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 * `isEnrichedIndexSupported` (_boolean_) Indicates whether enriched search index chunk resolution is supported (`true`) or not (`false`). Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 * `outputFields` (_array of MlRetrieverOutputFieldRepresentation_) List of output fields. Include the name and label for `CustomSql` and `Ensemble`. Include the name and field for `NoCode`. **Filter Group:** Small **Available Version:** 61.0 * `queryFilter` (_object_) Query filter. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpMlFilterRepresentation`. * `referencedRetrievers` (_array of MlRetrieverRepresentation_) List of sub-retrievers. Applies only to `Ensemble`. **Filter Group:** Small **Available Version:** 61.0 * `retrieverQueryTemplateDefinition` (_object_) Query template definition. Applies only to `CustomSql` and `Ensemble`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverQueryTemplateDefinitionRepresentation`. ### MlRetrieverConfigurationUpdateInputRepresentation Ml Retriever Configuration Update Input Represents the input for updating a configuration. * `isActive` (_boolean_, required) Indicates whether to activate the configuration (`true`) or not (`false`). At most one configuration can be active per retriever. **Available Version:** 61.0 ### CdpQueryMetadataEntitiesOutputRepresentation Query Metadata Entities Output Represents a list of metadata entities. * `done` (_boolean_) Indicates whether all metadata entities have been retrieved (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `metadata` (_array of CdpQueryMetadataEntityOutputRepresentation_) List of metadata entities. **Filter Group:** Small **Available Version:** 66.0 * `nextBatchId` (_string_) ID for the next batch of metadata entities. Present only when done is `false`. When done is `true`, this field is omitted from the response. **Filter Group:** Small **Available Version:** 66.0 ### PrivateNetworkRouteCollectionRepresentation Private Network Route Collection Output Represents a list of Private Network Routes. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `routes` (_array of PrivateNetworkRouteRepresentation_) List of Private Network Routes. **Filter Group:** Small **Available Version:** 65.0 ### PrivateNetworkRouteInputRepresentation Private Network Route Input Input representation to create a Private Network Route. * `cloudProvider` (_object_) Details about the cloud provider for the Private Network Route. **Available Version:** 65.0 Includes all fields of `CloudProviderDetailsInputRepresentation`. * `description` (_string_, required) Description of the Private Network Route. **Available Version:** 65.0 * `label` (_string_, required) Label of the Private Network Route. **Available Version:** 65.0 * `name` (_string_, required) Developer name of the Private Network Route. **Available Version:** 65.0 * `route` (_DatabricksRouteDetailsInputRepresentation | AmazonMSKRouteDetailsInputRepresentation | RedshiftRouteDetailsInputRepresentation | SnowflakeRouteDetailsInputRepresentation_, required) Provider details for the Private Network Route. Use the details input object that corresponds to the type of Private Network Route. For example, use the Amazon MSK Route Details Input for the `AmazonMsk` type. **Available Version:** 65.0 One of: `DatabricksRouteDetailsInputRepresentation`, `AmazonMSKRouteDetailsInputRepresentation`, `RedshiftRouteDetailsInputRepresentation`, `SnowflakeRouteDetailsInputRepresentation`. * `storageRoute` (_object_) Storage details for a route, for example, the URL and service name, for a storage/internal stage in the case of customer-managed and Salesforce-managed solutions. **Available Version:** 66.0 Includes all fields of `RouteDetailsInputRepresentation`. ### PrivateNetworkRouteRepresentation Private Network Route Output Represents a Private Network Route. Includes all fields of `CdpAssetBaseRepresentation`. * `cloudProvider` (_object_) Details about the cloud provider for the Private Network Route. **Filter Group:** Small **Available Version:** 65.0 Includes all fields of `CloudProviderDetailsRepresentation`. * `route` (_DatabricksRouteDetailsRepresentation | AmazonMSKRouteDetailsRepresentation | RedshiftRouteDetailsRepresentation | SnowflakeRouteDetailsRepresentation_) Provider details for the Private Network Route. The endpoint returns the details output object that corresponds to the type of Private Network Route. For example, the Amazon MSK Route Details Output is returned for the `AmazonMsk` type. **Filter Group:** Small **Available Version:** 65.0 One of: `DatabricksRouteDetailsRepresentation`, `AmazonMSKRouteDetailsRepresentation`, `RedshiftRouteDetailsRepresentation`, `SnowflakeRouteDetailsRepresentation`. * `storageRoute` (_object_) Storage details for a route, for example, the URL and service name, for a storage/internal stage in the case of customer-managed and Salesforce-managed solutions. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `RouteDetailsRepresentation`. ### CdpQueryInputRepresentation Query Input Input representation for creating a query. * `sql` (_string_, required) ANSI-standard SQL query. **Available Version:** 52.0 ### CdpQueryOutputV2Representation Query Output V2 Represents query output for the V2 API. * `data` (_array of CdpQueryV2RowRepresentation_) Result data set. Use Query V2 Row for version 55.0 and later. Use Object only for version 54.0. **Filter Group:** Small **Available Version:** 54.0 * `done` (_boolean_) Specifies whether the query is done (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 54.0 * `endTime` (_string_) Query end time. **Filter Group:** Small **Available Version:** 54.0 * `metadata` (_object_) Result metadata set. Use `Map` for version 55.0 and later. Use `Map` only for version 54.0. **Filter Group:** Small **Available Version:** 54.0 Additional properties: `CdpQueryMetadataItemRepresentation`. * `nextBatchId` (_string_) Next batch ID. Use this property as the _nextBatchId_ parameter in the Data 360 Query Batch resource to get the next batch of data. **Filter Group:** Small **Available Version:** 54.0 * `queryId` (_string_) Query ID. **Filter Group:** Small **Available Version:** 54.0 * `rowCount` (_integer_) Number of rows in the result data set. **Filter Group:** Small **Available Version:** 54.0 * `startTime` (_string_) Query start time. **Filter Group:** Small **Available Version:** 54.0 ### QuerySqlInputRepresentation Query SQL Input Represents the input to create a query SQL request. * `querySettings` (_object_) Settings to adjust the query execution behavior: * **date\_style**: Order of Year, Month, and Day for parsing date strings, for example `MDY` or `DMY`. * **lc\_time**: Locale for date literals using ISO language and country code, for example `en_US` or `de_AT`. * **query\_timeout**: Execution limit in milliseconds before the query is terminated, for example, `1800000ms`. **Available Version:** 62.0 Additional properties: `string`. * `rowLimit` (_integer (int64)_) Maximum number of rows to include in the response. The actual number of rows returned can be lower than the requested value if fewer are available or if the result set exceeds internal system size limits. Value must be greater than `0`. **Available Version:** 63.0 * `sql` (_string_, required) SQL expression. To get started with writing queries, see [Write a Simple Query](https://developer.salesforce.com/docs/data/data-cloud-query-guide/guide/write-simple-query.html). For more information about creating SQL statements, see [Data 360 SQL Syntax](https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/dc-sql-reference/syntax.html). **Available Version:** 63.0 * `sqlParameters` (_array of QuerySqlParameterItemRepresentation_) List of value and type information about parameters in the named parameter style. **Available Version:** 63.0 ### QuerySqlRepresentation Query SQL Output Represents the output of the Query SQL. Includes all fields of `QuerySqlBaseRepresentation`. * `status` (_object_) Stores metadata related to the status of query. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `QuerySqlStatusRepresentation`. ### QuerySqlStatusRepresentation Query SQL Status Output Represents status metadata for Query SQL. * `completionStatus` (_string_) Completion status of the query: * `Finished`: Query execution is complete. The results are available in memory and committed to peristent storage. * `ResultsProduced`: Query execution is complete. The results are available in memory. * `Running`: Query is currently being processed. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Finished`, `ResultsProduced`, `Running`, `Unspecified`. * `expirationTime` (_string_) Time when the query expires. You can't make requests to an expired query. **Filter Group:** Small **Available Version:** 63.0 * `progress` (_number (double)_) A number between 0 and 1 that indicates the current progress of the query. * `0` not started * `1` the query execution is complete, and the query results are available for you to retrieve **Filter Group:** Small **Available Version:** 63.0 * `queryId` (_string_) ID of the query for which status information is returned. **Filter Group:** Small **Available Version:** 63.0 * `rowCount` (_integer (int64)_) Number of rows available for extraction. **Filter Group:** Small **Available Version:** 63.0 ### QuerySqlPageRepresentation Query SQL Page Output Represents SQL query output. Includes all fields of `QuerySqlBaseRepresentation`. ### SemanticSearchDefDetailsRepresentation Semantic Search Def Details Output Semantic search definition details representation Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `semanticSearchDefinitionDetails` (_array of SemanticSearchDefDetailRepresentation_, required) List of semantic search definition detail objects. **Filter Group:** Small **Available Version:** 60.0 ### SemanticSearchInputRepresentation Semantic Search Input The input representation for semantic search. Includes all fields of `CdpAssetBaseInputRepresentation`. * `activationStatus` (_string_) Activation status of the semantic search record. **Available Version:** 60.0 * `attachmentDmoDeveloperName` (_string_) Developer name of the attachment `MktDataModelObject`. For example, `loanAgreement__dlm`. **Available Version:** 62.0 * `chunkDmoDeveloperName` (_string_, required) Developer name of the data model object (DMO) used for chunking, excluding the `__dlm` suffix. **Available Version:** 60.0 * `chunkDmoName` (_string_, required) Name of the DMO used for chunking. **Available Version:** 60.0 * `chunkingConfiguration` (_object_, required) Chunking configuration. **Available Version:** 60.0 Includes all fields of `ChunkingConfigInputRepresentation`. * `description` (_string_) Description of semantic search record to be created. **Available Version:** 60.0 * `developerName` (_string_, required) Developer name of the semantic search record to be created. **Available Version:** 60.0 * `indexConfiguration` (_object_) Index configuration for the semantic search record. **Available Version:** 64.0 Includes all fields of `IndexConfigInputRepresentation`. * `label` (_string_, required) Label of semantic search record to be created. **Available Version:** 60.0 * `processingType` (_string_) Processing type of the search index, such as `NEAR_REALTIME` or `REALTIME`. **Available Version:** 63.0 * `rankingConfigurations` (_array of SearchRankingFieldInputRepresentation_) List of ranking configurations for hybrid search. Selecting fields for a ranking configuration is optional. **Available Version:** 60.0 * `searchType` (_string_, required) Type of the search index (`HYBRID` or `VECTOR`). **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_, required) Developer name of the source (parent) `MktDataModelObject`. For example, `loanAgreement__dlm`. **Available Version:** 60.0 * `transcribeDmoDeveloperName` (_string_) Transcribe output DMO developer name. **Available Version:** 60.0 * `transcribeDmoName` (_string_) Transcribe output DMO name. **Available Version:** 60.0 * `transcribeDmoId` (_string_) Transcribe output DMO ID. **Available Version:** 60.0 * `transformConfigurations` (_array of TransformConfigInputRepresentation_) Transform configuration. **Available Version:** 60.0 * `vectorDmoDeveloperName` (_string_, required) Developer name of the vector DMO, excluding the `__dlm` suffix. **Available Version:** 60.0 * `vectorDmoName` (_string_, required) Name of the vector DMO. **Available Version:** 60.0 * `vectorEmbedding` (_object_, required) Vector embedding objects. **Available Version:** 60.0 Includes all fields of `VectorEmbeddingInputRepresentation`. * `vectorEmbeddingConfiguration` (_object_, required) Vector embedding configuration. **Available Version:** 60.0 Includes all fields of `VectorEmbeddingConfigInputRepresentation`. ### SemanticSearchRepresentation Semantic Search Output Represents the output for a semantic search record. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `chunkingStrategies` (_array of string_) List of chunking strategy object IDs. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) ID of the semantic search definition that was updated or created. **Filter Group:** Small **Available Version:** 60.0 * `rankingConfigurations` (_array of string_) List of ranking configuration object IDs that were created for hybrid search. **Filter Group:** Small **Available Version:** 60.0 * `transformations` (_array of string_) The list of transformation IDs. **Filter Group:** Small **Available Version:** 60.0 * `vectorEmbedding` (_object_) The structure for vector embeddings, including any extra fields. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `VectorEmbeddingRepresentation`. ### SemanticSearchConfigRepresentation Semantic Search Config Output Semantic Search Config Representation * `config` (_string_) The semantic search configuration. **Filter Group:** Small **Available Version:** 60.0 ### SemanticSearchDefDetailRepresentation Semantic Search Def Detail Output Semantic Search Definition Detail Representation * `attachmentDmoId` (_string_) Attachment data model object's (DMO's) ID. **Filter Group:** Small **Available Version:** 60.0 * `attachmentDmoName` (_string_) Attachment DMO's name. **Filter Group:** Small **Available Version:** 60.0 * `chunkDmoDeveloperName` (_string_) Chunk DMO's developer name. **Filter Group:** Small **Available Version:** 60.0 * `chunkDmoId` (_string_) Chunk DMO's ID. **Filter Group:** Small **Available Version:** 60.0 * `chunkDmoName` (_string_) Chunk DMO's label. **Filter Group:** Small **Available Version:** 60.0 * `chunkingConfiguration` (_object_) Chunking configuration. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ChunkingConfigurationRepresentation`. * `dataspace` (_string_) Name of the data space. **Filter Group:** Small **Available Version:** 60.0 * `description` (_string_) Description. **Filter Group:** Small **Available Version:** 60.0 * `developerName` (_string_) Developer name. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) ID of the record. **Filter Group:** Small **Available Version:** 60.0 * `indexConfiguration` (_object_) Index configuration for the semantic search record. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `IndexConfigurationRepresentation`. * `indexRefreshedOn` (_string_) Date and time of the search index's last update. **Filter Group:** Small **Available Version:** 64.0 * `label` (_string_) Label. **Filter Group:** Small **Available Version:** 60.0 * `rankingConfigurations` (_array of RankingFieldsDetailsRepresentation_) List of ranking configuration object IDs that were created for hybrid search. **Filter Group:** Small **Available Version:** 60.0 * `searchType` (_string_) Type of the search index (`HYBRID` or `VECTOR`). **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_) Source DMO's developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoId` (_string_) Source DMO's ID. **Filter Group:** Small **Available Version:** 60.0 * `transcribeDmoDeveloperName` (_string_) Transcribe DMO's developer name. **Filter Group:** Small **Available Version:** 60.0 * `transcribeDmoName` (_string_) Transcribe DMO's label. **Filter Group:** Small **Available Version:** 60.0 * `transformConfigurations` (_array of TransformConfigurationRepresentation_) Transform configurations. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoDeveloperName` (_string_) Vector DMO's developer name. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoId` (_string_) Vector DMO's ID. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoName` (_string_) Vector DMO's label. **Filter Group:** Small **Available Version:** 60.0 * `vectorEmbedding` (_object_) Vector embedding. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `VectorEmbeddingDetailsRepresentation`. * `vectorEmbeddingConfiguration` (_object_) Vector embedding configuration. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `VectorConfigurationRepresentation`. * `version` (_string_) Version of the record. **Filter Group:** Small **Available Version:** 60.0 ### CdpSegmentContainerOutputRepresentation Segment Container Output Represents a segment container. * `batchSize` (_integer_) Number of items returned. **Filter Group:** Small **Available Version:** 56.0 * `offset` (_integer_) Number of rows skipped before returning results. **Filter Group:** Small **Available Version:** 56.0 * `orderByExpression` (_string_) Expression indicating how results are ordered. **Filter Group:** Small **Available Version:** 56.0 * `segments` (_array of CdpSegmentOutputRepresentation_) List of segments. **Filter Group:** Small **Available Version:** 56.0 ### CdpSegmentInputRepresentation Segment Input Input representation for creating a segment. * `additionalMetadata` (_object_) Map of additional metadata. Optional for POST. Not supported for PATCH. **Available Version:** 55.0 Additional properties: `string`. * `componentTemplateName` (_string_) Component template mame for the segment. **Available Version:** 63.0 * `dataKitDevName` (_string_) Data kit name for the segment. **Available Version:** 63.0 * `dataSpace` (_string_) Segment data space. In API version 59.0 and later, this property is not available. Use the `dataspace` request parameter instead. **Available Version:** 57.0 * `description` (_string_, required) Segment description. **Available Version:** 55.0 * `developerName` (_string_) Segment developer name. Required for POST. Not supported for PATCH. **Available Version:** 55.0 * `displayName` (_string_, required) Segment display name. **Available Version:** 57.0 * `einsteinGptSegmentsUICriteria` (_object_) Einstein Gpt Segments UI segment criteria. **Available Version:** 58.0 Includes all fields of `CdpSegmentEinsteinGptSegmentsUIInputRepresentation`. * `excludeCriteria` (_string_) Exclude criteria for the segment. **Available Version:** 60.0 * `groupSortLimitFilterCriteria` (_string_) Group sort limit criteria. **Available Version:** 64.0 * `includeCriteria` (_string_) Include criteria for the segment. **Available Version:** 60.0 * `includeDbt` (_object_) Segment data build tool (DBT). **Available Version:** 55.0 Includes all fields of `CdpSegmentDbtInputRepresentation`. * `lookalikeCriteria` (_object_) Lookalike criteria for the segment. **Available Version:** 56.0 Includes all fields of `CdpSegmentLookalikeInputRepresentation`. * `lookbackPeriod` (_string_) Lookback period for the segment. **Available Version:** 62.0 * `publishSchedule` (_string_) Publish refresh schedule (in hours). `One` and `Four` are used to rapidly publish UI and DBT-based segments. **Available Version:** 55.0 Allowed values: `NoRefresh`, `One`, `Two`, `Four`, `Six`, `Twelve`, `TwentyFour`. * `publishScheduleEndDate` (_string_) Date indicating the end of the publish schedule. Optional if `publishSchedule` is unspecified. **Available Version:** 55.0 * `publishScheduleEndDateTime` (_string_) Datetime indicating the end of the publish schedule. **Availble Version:** 55.0 * `publishScheduleInfo` (_DailyScheduleInputRepresentation | CdpHourlyScheduleInputRepresentation | CdpMinutelyScheduleInputRepresentation | MonthlySpecificScheduleInputRepresentation | CdpMonthlyRelativeScheduleInputRepresentation | WeeklyScheduleInputRepresentation | CdpNoneScheduleInputRepresentation_) Additional information about the publish schedule. Use the schedule input object that corresponds to the publish frequency: `Daily`, `Hourly`, `Minutely`, `Monthly`, `Monthly Relative`, `Weekly`, or `None`. For example, use the Daily Schedule Input for the `Daily` publish frequency. **Available Version:** 63.0 One of: `DailyScheduleInputRepresentation`, `CdpHourlyScheduleInputRepresentation`, `CdpMinutelyScheduleInputRepresentation`, `MonthlySpecificScheduleInputRepresentation`, `CdpMonthlyRelativeScheduleInputRepresentation`, `WeeklyScheduleInputRepresentation`, `CdpNoneScheduleInputRepresentation`. * `publishScheduleStartDateTime` (_string_) Datetime indicating the start of the publish schedule. Optional if `publishSchedule` is unspecified. **Available Version:** 55.0 * `segmentCreationFlow` (_string_) Creation flow for the segment. **Available Version:** 61.0 Allowed values: `Datakit`, `EinsteinGpt`, `Headless`, `Visual`. * `segmentOnApiName` (_string_, required) API name of the SegmentOn entity. **Available Version:** 57.0 * `segmentOnDataGraph` (_string_) Data graph of the SegmentOn entity for real-time segments. **Available Version:** 60.0 * `segmentType` (_string_, required) Type of segment. `Dbt` is data build tool. Required for POST. Not supported for PATCH. After a segment is created, the segment type can't be changed. **Available Version:** 55.0 Allowed values: `Dbt`, `Dynamic`, `EinsteinGptSegmentsUI`, `Lookalike`, `Realtimez`, `Waterfall`. ### CdpSegmentOutputRepresentation Segment Output Represents segment output. * `apiName` (_string_) API name of the segment. **Filter Group:** Small **Available Version:** 56.0 * `dataSpace` (_string_) Segment data space. In API version 59.0 and later, this property is not available. Use the `dataspace` request parameter instead. **Filter Group:** Small **Available Versions:** 57.0 * `description` (_string_) Segment description. **Filter Group:** Small **Available Version:** 55.0 * `developerName` (_string_) Segment developer name. **Filter Group:** Small **Available Version:** 55.0 * `displayName` (_string_) Segment display name. **Filter Group:** Small **Available Version:** 57.0 * `excludeCriteria` (_string_) Segment exclude criteria. **Filter Group:** Small **Available Version:** 57.0 * `includeCriteria` (_string_) Segment include criteria. **Filter Group:** Small **Available Version:** 57.0 * `includeDbt` (_object_) Segment DBT pipeline. **Filter Group:** Small **Available Version:** 55.0 Includes all fields of `CdpSegmentDbtPipelineOutputRepresentation`. * `lastPublishedEndDateTime` (_string_) Segment last published end-date time. **Filter Group:** Small **Available Version:** 63.0 * `lastSegmentMemberCount` (_integer (int64)_) Last segment member count. **Filter Group:** Small **Available Version:** 63.0 * `lookalikeCriteria` (_object_) Lookalike criteria for the segment. **Filter Group:** Small **Available Version:** 56.0 Includes all fields of `CdpSegmentLookalikeOutputRepresentation`. * `lookbackPeriod` (_string_) Lookback period of the segment. **Filter Group:** Small **Available Version:** 62.0 * `marketSegmentDefinitionId` (_string_) ID of the market segment definition. **Filter Group:** Small **Available Version:** 55.0 * `marketSegmentId` (_string_) ID of the market segment. **Filter Group:** Small **Available Version:** 56.0 * `nextPublishDateTime` (_string_) Date and time of the next segment publish. **Filter Group:** Small **Available Version:** 57.0 * `parameters` (_array of ParameterRepresentation_) Metadata for dynamic segment parameters. **Filter Group:** Small **Available Version:** 63.0 * `publishInterval` (_string_) Segment publish interval. **Filter Group:** Small **Available Version:** 55.0 * `publishScheduleEndDate` (_string_) Publish schedule end date. **Filter Group:** Small **Available Version:** 55.0 * `publishScheduleEndDateTime` (_string_) Publish schedule end-date time. **Filter Group:** Small **Available Version:** 62.0 * `publishScheduleInfo` (_DailyScheduleRepresentation | CdpHourlyScheduleRepresentation | CdpMinutelyScheduleRepresentation | MonthlySpecificScheduleRepresentation | CdpMonthlyRelativeScheduleRepresentation | WeeklyScheduleRepresentation | CdpNoneScheduleRepresentation_) Additional information about the publish schedule. The endpoint returns the schedule output object that corresponds to the publish frequency: `Daily`, `Hourly`, `Minutely`, `Monthly`, `Monthly Relative`, `Weekly`, or `None`. For example, the Daily Schedule Output is returned for the `Daily` publish frequency. **Filter Group:** Small **Available Version:** 63.0 One of: `DailyScheduleRepresentation`, `CdpHourlyScheduleRepresentation`, `CdpMinutelyScheduleRepresentation`, `MonthlySpecificScheduleRepresentation`, `CdpMonthlyRelativeScheduleRepresentation`, `WeeklyScheduleRepresentation`, `CdpNoneScheduleRepresentation`. * `publishScheduleStartDateTime` (_string_) Publish schedule start date time. **Filter Group:** Small **Available Version:** 55.0 * `publishStatus` (_string_) Segment publish status. **Filter Group:** Small **Available Version:** 55.0 * `segmentMembershipDmo` (_object_) Segment membership tables. **Filter Group:** Small **Available Version:** 58.0 Includes all fields of `CdpSegmentMembershipTableOutputRepresentation`. * `segmentMembershipTable` (_string_) Name of the segment membership table. **Filter Group:** Small **Available Version:** 56.0 * `segmentOnApiName` (_string_) API name of the SegmentOn entity. **Filter Group:** Small **Available Version:** 56.0 * `segmentOnDataGraph` (_string_) Data graph ID of the SegmentOn entity. **Filter Group:** Small **Available Version:** 58.0 * `segmentOnId` (_string_) ID of the DMO segment. **Filter Group:** Small **Available Version:** 55.0 * `segmentStatus` (_string_) Segment status. **Filter Group:** Small **Available Version:** 55.0 * `segmentType` (_string_) Type of segment. **Filter Group:** Small **Available Version:** 56.0 ### CdpSegmentActionInputRepresentation Segment Action Input Represents segment action input for a count request. * `preferApproxCount` (_boolean_, required) Indicates whether to use approximate count (`true`) or not (`false`). Approximate Segment Population feature must be enabled to set the value as (`true`). **Available Version:** 61.0 ### CdpSegmentActionOutputRepresentation Segment Action Output Represents segment action output. Includes all fields of `CdpActionResponseBaseRepresentation`. * `jobId` (_string_) Job ID for the publish job. Returned only for publishSegment resource. **Filter Group:** Small **Available Version:** 56.0 * `partitionId` (_string_) ID of the partition. Returned only for publishSegment resource. **Filter Group:** Small **Available Version:** 56.0 * `publishStatus` (_string_) Publish status of the segment. Returned only for publishSegment resource. **Filter Group:** Small **Available Version:** 57.0 * `segmentApiName` (_string_) API name of the segment. Returned only for deactivateSegmentByName and deactivateSegmentById resources. **Filter Group:** Small **Available Version:** 56.0 * `segmentId` (_string_, required) ID of the segment. **Filter Group:** Small **Available Version:** 56.0 ### CdpSegmentMemberOutputRepresentation Segment Member Output Represents segment member output. * `data` (_array of CdpSegmentMemberRowOutputRepresentation_) Result data set. **Filter Group:** Small **Available Version:** 58.0 * `endTime` (_string_) Query end time. **Filter Group:** Small **Available Version:** 58.0 * `filter` (_string_) Filter information for the query. **Filter Group:** Small **Available Version:** 58.0 * `limit` (_integer_) Batch size information. **Filter Group:** Small **Available Version:** 58.0 * `nextPageUrl` (_string_) URL for the next page. **Filter Group:** Small **Available Version:** 58.0 * `offSet` (_integer_) Offset information. **Filter Group:** Small **Available Version:** 58.0 * `orderBy` (_string_) Order by information. **Filter Group:** Small **Available Version:** 58.0 * `rowCount` (_integer_) Total row count. **Filter Group:** Small **Available Version:** 58.0 * `startTime` (_string_) Query start time. **Filter Group:** Small **Available Version:** 58.0 * `totalCount` (_integer_) Total count of records. **Filter Group:** Small **Available Version:** 58.0 ### CdpQueryDataOutputRepresentation Query Data Output Represents query data output. * `data` (_array of object_) Result data set. **Filter Group:** Small **Available Version:** 54.0 ### CdpPaginatedResponseBaseRepresentation Paginated Response Base Output Base paginated response representation. * `currentPageUrl` (_string_) Current page URL. **Filter Group:** Small **Available Version:** 60.0 * `nextPageUrl` (_string_) Next page URL, if it exists. **Filter Group:** Small **Available Version:** 60.0 * `totalSize` (_integer_) Total size of the collection. **Filter Group:** Small **Available Version:** 60.0 ### CdpAssetBaseRepresentation Asset Base Output Represents a base asset. * `createdBy` (_object_) Who or what created the model configuration, artifact, or other asset. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `CdpUserRepresentation`. * `createdDate` (_string_) Date that the artifact was created. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) 18-character ID of the asset. **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Label of the asset. Not applicable to the [get activation](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getActivation) endpoint. **Filter Group:** Small **Available Version:** 60.0 * `lastModifiedBy` (_object_) Who or what last modified the asset. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `CdpUserRepresentation`. * `lastModifiedDate` (_string_) When the asset was last modified. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the asset. **Filter Group:** Small **Available Version:** 60.0 * `namespace` (_string_) Namespace of the asset. Not applicable to the [get activation](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getActivation) endpoint. **Filter Group:** Small **Available Version:** 60.0 * `url` (_string_) The artifact's, configured model's, or other asset's URL. Not applicable to the [get activation](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=getActivation) endpoint. **Filter Group:** Small **Available Version:** 60.0 ### ActivationExternalPlatformAttributeConfigRepresentation Activation External Platform Attribute Config Output Represents the attribute configuration for an activation external platform. * `attributes` (_array of ActivationExternalPlatformAttributeRepresentation_) List of external platform attributes. **Filter Group:** Small **Available Version:** 64.0 ### ActivationPlatformSummaryRepresentation Activation Platform Summary Output Represents a summary of an activation platform for collection results. * `activationPlatformCreationType` (_string_) How the platform was created. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Json`, `Manual`. * `canPublishNow` (_boolean_) Indicates whether the platform is ready to be published (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `enabled` (_boolean_) Indicates whether the activation platform is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Salesforce ID of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) API name of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `platformProcessingType` (_string_) How the platform processes activations. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Batch`, `Streaming`. * `platformType` (_string_) Category of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Advertising`, `Analytics`, `Marketing`, `Publishing`, `Technology`. * `status` (_string_) Status of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `Error`, `Processing`. ### ActivationPlatformAttributeInputRepresentation Activation Platform Attribute Input Represents the input for an activation attribute. * `applyHash` (_boolean_) Indicates whether hashing is applied to the attribute (`true`) or not (`false`). **Available Version:** 67.0 * `destinationName` (_string_) Destination name for the attribute. **Available Version:** 67.0 * `fieldName` (_string_) Source field name. **Available Version:** 67.0 * `isIdentifier` (_boolean_) Indicates whether the attribute is an identifier (`true`) or not (`false`). **Available Version:** 67.0 * `isRequired` (_boolean_, required) Indicates whether the attribute is required (`true`) or not (`false`). **Available Version:** 67.0 * `label` (_string_) Attribute display label. **Available Version:** 67.0 * `name` (_string_, required) Attribute name. **Available Version:** 67.0 * `objectName` (_string_) Source object name. **Available Version:** 67.0 * `value` (_string_) Constant value for the attribute. **Available Version:** 67.0 ### ActivationPlatformAdditionalMetadataInputRepresentation Activation Platform Additional Metadata Input Represents the input for additional platform metadata, such as event configuration, mappings, and output properties. * `activationPlatformEventMetadata` (_object_) Event metadata configuration. **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventMetadataInputRepresentation`. * `customAttributePrefix` (_string_) Prefix for custom attributes, such as `custom__`. **Available Version:** 67.0 * `customerFileSources` (_array of string_) Customer file source types, such as `FirstParty`, `ThirdParty`, or `FirstPartyAndThirdParty`. **Available Version:** 67.0 * `hashMethod` (_string_) Hash method applied to identifiers. **Available Version:** 67.0 * `mappingSchemas` (_array of ActivationMappingSchemaInputRepresentation_) Available mapping schemas for the platform. **Available Version:** 67.0 * `outputProperties` (_object_) File output configuration properties. **Available Version:** 67.0 Includes all fields of `ActivationPlatformOutputPropertiesInputRepresentation`. * `partnerSupportedIds` (_array of ActivationPlatformPartnerSupportedIdInputRepresentation_) Partner-supported identifier types per destination. **Available Version:** 67.0 ### ActivationPlatformCustomMetadataInputRepresentation Activation Platform Custom Metadata Input Represents the connector credentials for toolkit-created activation platforms. The required fields depend on the connector type. For example, S3 requires `accessKey` and `secretKey`. * `accessKey` (_string_) Access key for the connector. Required for S3. **Available Version:** 67.0 * `connectorType` (_string_, required) Connector type, such as `S3`, `Sftp`, or `AzureBlob`. **Available Version:** 67.0 * `secretKey` (_string_) Secret key for the connector. Required for S3. **Available Version:** 67.0 ### ActivationPlatformFieldInputRepresentation Activation Platform Field Input Represents the input for a configuration field. * `helpText` (_string_) Help text for the field. **Available Version:** 67.0 * `isHidden` (_boolean_) Indicates whether the field is hidden in the UI (`true`) or not (`false`). **Available Version:** 67.0 * `isRequired` (_boolean_, required) Indicates whether the field is required (`true`) or not (`false`). **Available Version:** 67.0 * `label` (_string_) Field display label. **Available Version:** 67.0 * `name` (_string_, required) Field API name. **Available Version:** 67.0 * `type` (_string_, required) Data type of the field. **Available Version:** 67.0 Allowed values: `Date`, `Number`, `Text`. * `values` (_array of ActivationPlatformFieldValueInputRepresentation_) Allowed values for picklist fields. **Available Version:** 67.0 ### ActivationPlatformIdentifierInputRepresentation Activation Platform Identifier Input Represents the input for a platform audience identifier. * `identifierHashMethod` (_string_) Hash method applied to the identifier. **Available Version:** 67.0 Allowed values: `Md5`, `None`, `Sha1`, `Sha256`. * `identifierType` (_string_) Type of audience identifier. **Available Version:** 67.0 Allowed values: `Email`, `Maid`, `Ott`, `Phone`. ### RefreshSettingsInputRepresentation Refresh Settings Input Represents the refresh configuration input for creating or updating an activation platform. * `frequency` (_string_) How often the activation platform refreshes. **Available Version:** 67.0 Allowed values: `FourHours`, `TwelveHours`, `TwentyFourHours`. * `mode` (_string_) Refresh mode for the activation platform. **Available Version:** 67.0 Allowed values: `Full`, `Incremental`. * `periodicFullRefresh` (_string_) How often a periodic full refresh runs. **Available Version:** 67.0 Allowed values: `Every30Days`, `Every60Days`. ### ActivationPlatformAttributeRepresentation Activation Platform Attribute Output Represents an activation attribute for data mapping. * `activationPlatformId` (_string_) ID of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `activationPlatformName` (_string_) Name of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `applyHash` (_boolean_) Indicates whether hashing is applied to the attribute (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `destinationName` (_string_) Destination name for the attribute. **Filter Group:** Small **Available Version:** 67.0 * `fieldName` (_string_) Source field API name, including the namespace. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Attribute ID. **Filter Group:** Small **Available Version:** 67.0 * `identifier` (_object_) Audience identifier associated with the attribute. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformIdentifierRepresentation`. * `isConstant` (_boolean_) Indicates whether the attribute has a constant value (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `isFromSourceObject` (_boolean_) Indicates whether the attribute maps from a source object (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `isIdentifier` (_boolean_) Indicates whether the attribute is an identifier (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `isRequired` (_boolean_) Indicates whether the attribute is required (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Attribute display label. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Attribute API name. **Filter Group:** Small **Available Version:** 67.0 * `objectName` (_string_) Source object API name, including the namespace. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformAdditionalMetadataRepresentation Activation Platform Additional Metadata Output Represents additional metadata for an activation platform, such as event configuration, mappings, and output properties. * `activationPlatformEventMetadata` (_object_) Event metadata configuration. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventMetadataRepresentation`. * `customAttributePrefix` (_string_) Prefix for custom attributes, such as `custom__`. **Filter Group:** Small **Available Version:** 67.0 * `customerFileSources` (_array of string_) Customer file source types, such as `FirstParty`, `ThirdParty`, or `FirstPartyAndThirdParty`. **Filter Group:** Small **Available Version:** 67.0 * `hashMethod` (_string_) Hash method applied to identifiers. **Filter Group:** Small **Available Version:** 67.0 * `mappingSchemas` (_array of ActivationMappingSchemaRepresentation_) Available mapping schemas for the platform. **Filter Group:** Small **Available Version:** 67.0 * `outputProperties` (_object_) File output configuration properties. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformOutputPropertiesRepresentation`. * `partnerSupportedIds` (_array of ActivationPlatformPartnerSupportedIdRepresentation_) Partner-supported identifier types per destination. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformUserRepresentation Activation Platform User Output Represents a user referenced by activation platform audit fields. * `id` (_string_) Record ID (15- or 18-character) of the user. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Display name of the user. **Filter Group:** Small **Available Version:** 67.0 * `profilePhotoUrl` (_string_) URL of the user's profile photo. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformCustomerIdTypeMappingRepresentation Activation Platform Customer Id Type Mapping Output Represents a customer ID type mapping configuration. * `idTypeDataList` (_array of ActivationPlatformCustomerIdTypeRepresentation_) List of ID type data entries. **Filter Group:** Small **Available Version:** 67.0 ### ActivationEventParameterValuesRepresentation Activation Event Parameter Values Output Represents an event parameter definition with its allowed values. * `hierarchy` (_integer_) Hierarchy level, starting at 1. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Parameter name, such as `Event` or `Action Source`. **Filter Group:** Small **Available Version:** 67.0 * `type` (_string_) Type of event parameter. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ActionSource`, `Event`. * `values` (_array of string_) Allowed values for the parameter. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformFieldRepresentation Activation Platform Field Output Represents a configuration field for an activation platform. * `activationPlatformId` (_string_) ID of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `activationPlatformName` (_string_) Name of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `helpText` (_string_) Help text for the field. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Field ID. **Filter Group:** Small **Available Version:** 67.0 * `isHidden` (_boolean_) Indicates whether the field is hidden in the UI (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `isRequired` (_boolean_) Indicates whether the field is required (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Field display label. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Field API name. **Filter Group:** Small **Available Version:** 67.0 * `type` (_string_) Data type of the field. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Date`, `Number`, `Text`. * `values` (_array of ActivationPlatformFieldValueRepresentation_) Allowed values for picklist fields. Exactly one value must have `isDefault` set to `true`. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformIdentifierRepresentation Activation Platform Identifier Output Represents an audience identifier for an activation platform. * `activationPlatformId` (_string_) ID of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `activationPlatformName` (_string_) Name of the parent activation platform. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Identifier ID. **Filter Group:** Small **Available Version:** 67.0 * `identifierHashMethod` (_string_) Hash method applied to the identifier. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Md5`, `None`, `Sha1`, `Sha256`. * `identifierType` (_string_) Type of audience identifier. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Email`, `Maid`, `Ott`, `Phone`. ### RefreshSettingsRepresentation Refresh Settings Output Represents the refresh configuration settings for an activation platform. * `frequency` (_string_) How often the activation platform refreshes. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `FourHours`, `TwelveHours`, `TwentyFourHours`. * `mode` (_string_) Refresh mode for the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Full`, `Incremental`. * `periodicFullRefresh` (_string_) How often a periodic full refresh runs. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Every30Days`, `Every60Days`. ### CdpActivationPaginatedResponseBaseRepresentation Activation Paginated Response Base Output Represents the base paginated response. * `currentPageUrl` (_string (url)_) URL of the current page. **Filter Group:** Small **Available Version:** 67.0 * `nextPageUrl` (_string (url)_) URL of the next page, if one exists. **Filter Group:** Small **Available Version:** 67.0 * `totalSize` (_integer_) Total number of results in the collection. **Filter Group:** Small **Available Version:** 67.0 ### ActionSourceRepresentation Action Source Output Represents an action source valid for an event on a streaming activation platform. * `name` (_string_) Name of the action source, such as Website, App, or Offline. **Filter Group:** Small **Available Version:** 67.0 ### EventRepresentation Event Output Represents a standard event configured on a streaming activation platform. * `name` (_string_) Name of the event, such as Purchase or AddToCart. **Filter Group:** Small **Available Version:** 67.0 ### PartnerObjectTypeRepresentation Partner Object Type Output Represents a partner-object type supported by a streaming activation platform. * `label` (_string_) Display label for the partner-object type. **Filter Group:** Small **Available Version:** 67.0 * `type` (_string_) Partner-object type identifier, such as Pixel, App, or ConversionRule. Values are partner-defined. **Filter Group:** Small **Available Version:** 67.0 ### DataConnectorInputRepresentation Data Connector Input Represents the data connector details input. * `name` (_string_) Name of the activation target. **Available Version:** 60.0 * `outputFormat` (_string_) Output format for the activation target. **Available Version:** 60.0 ### EgressPropertiesInputRepresentation Egress Properties Input Represents the input details for egress properties of the activation target. * `childFolder` (_string_) Path of the child folder. The child folder is created in the parent directory for copying activation files. **Available Version:** 63.0 * `customFilename` (_string_) Custom name of the output file. Either `customFilename` or `predeterminedFilename` must be present. **Available Version:** 63.0 * `filenameDateSuffixFormat` (_string_, required) Date suffix format for the output file name. Use the format `yyyy-MM-dd-HH-mm-ss` or `yyyy-MM-dd-HH-mm-ss-SSS`. **Available Version:** 63.0 * `isSubfolderCreationEnabled` (_boolean_) Indicates whether subfolder creation is enabled (`true`) or not (`false`). If `true`, a custom subfolder is created. The default is `false`. **Available Version:** 63.0 * `outputCompressionFormat` (_string_, required) Compression format for the output file. **Available Version:** 63.0 Allowed values: `Bzip2`, `Gzip`, `None`. * `outputDelimiter` (_string_, required) Field delimiter to use in output files. **Available Version:** 63.0 Allowed values: `BrokenPipe`, `Caret`, `Colon`, `Comma`, `Hash`, `Pipe`, `Semicolon`, `Slash`, `Tab`, `Tilde`, `Underscore`. * `outputFormat` (_string_, required) Output format for the activation target. **Available Version:** 63.0 * `outputMaxFileSizeMegaBytes` (_integer (int64)_, required) Maximum size of the output file in megabytes from `1` through `500`. **Available Version:** 63.0 * `outputMaxRecordsPerFile` (_integer (int64)_) Maximum number of records in the output file from `1` through `100000`. **Available Version:** 63.0 * `predeterminedFilename` (_string_) Predetermined name of the output file. Either `customFilename` or `predeterminedFilename` must be present. **Available Version:** 63.0 Allowed values: `Activation`, `Segment`, `SegmentActivation`. ### DataConnectorRepresentation Data Connector Output Represents base class connector details. Includes all fields of `CdpAssetBaseRepresentation`. * `outputFormat` (_string_) Output format of the activation target. **Filter Group:** Small **Available Version:** 60.0 ### EgressPropertiesRepresentation Egress Properties Output Represents the details for egress properties of the activation target. Includes all fields of `CdpAssetBaseRepresentation`. * `childFolder` (_string_) Path of the child folder. **Filter Group:** Small **Available Version:** 63.0 * `customFilename` (_string_) Custom name of the output file. **Filter Group:** Small **Available Version:** 63.0 * `filenameDateSuffixFormat` (_string_) Date suffix format for the output file name. **Filter Group:** Small **Available Version:** 63.0 * `isSubfolderCreationEnabled` (_boolean_) Indicates whether subfolder creation is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `outputCompressionFormat` (_string_) Compression format for the output file. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Bzip2`, `Gzip`, `None`. * `outputDelimiter` (_string_) Field delimiter for the output file. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `BrokenPipe`, `Caret`, `Colon`, `Comma`, `Hash`, `Pipe`, `Semicolon`, `Slash`, `Tab`, `Tilde`, `Underscore`. * `outputFormat` (_string_) Output format of the activation target. **Filter Group:** Small **Available Version:** 63.0 * `outputMaxFileSizeMegaBytes` (_integer (int64)_) Maximum size of the output file in megabytes. **Filter Group:** Small **Available Version:** 63.0 * `outputMaxRecordsPerFile` (_integer (int64)_) Maximum number of records in the output file. **Filter Group:** Small **Available Version:** 63.0 * `predeterminedFilename` (_string_) Predetermined name of the output file. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Activation`, `Segment`, `SegmentActivation`. ### ActivationTargetPlatformRepresentation Activation Target Platform Output Represents a platform available for creating activation targets, a focused subset of activation platform data. * `apiName` (_string_) Stable identifier for the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `category` (_string_) Category of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Advertising`, `Analytics`, `Marketing`, `Publishing`, `Technology`. * `description` (_string_) Description of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `externalProvider` (_string_) External partner provider for the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Amazon`, `Dv360`, `Facebook`, `Google`, `GoogleAdManager`, `LinkedIn`, `LinkedInCapi`, `MetaCapi`, `Pinterest`, `Snapchat`, `SnapchatCapi`, `TikTok`, `TikTokCapi`. * `name` (_string_) Display name of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `platformType` (_string_) Type of the activation platform. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `AzureBlob`, `DataCloud`, `External`, `GoogleCloudStorage`, `InteractionStudio`, `S3`, `S3V2`, `SfApp`, `Sfcc`, `Sfmc`, `Sftp`, `Strategic`, `StreamingFlow`. * `processingType` (_string_) How the platform processes activations. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Batch`, `Streaming`. * `sortOrder` (_integer_) Sort order used to display platforms in pickers. Lower values appear first. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingDataSpaceRepresentation Communication Capping Data Space Output Represents a communication capping data space association. * `apiName` (_string_) API name of the data space association. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `dataSpaceId` (_string_) ID of the data space. **Filter Group:** Small **Available Version:** 67.0 * `dataSpaceName` (_string_) Name of the data space. **Filter Group:** Small **Available Version:** 67.0 ### McEnterpriseRepresentation Mc Enterprise Output Represents a Marketing Cloud enterprise with its enterprise ID and associated business units. * `businessUnits` (_array of McBusinessUnitRepresentation_) Business units belonging to the enterprise. **Filter Group:** Small **Available Version:** 67.0 * `connectorId` (_string_) Connector ID linking the enterprise to Data Cloud. **Filter Group:** Small **Available Version:** 67.0 * `enterpriseId` (_string_) Marketing Cloud enterprise ID (EID). **Filter Group:** Small **Available Version:** 67.0 * `enterpriseName` (_string_) Display name of the enterprise. **Filter Group:** Small **Available Version:** 67.0 ### AdAccountRepresentation Ad Account Output Represents an ad account on the partner advertising platform. * `accountName` (_string_) Display name of the ad account. **Filter Group:** Small **Available Version:** 67.0 * `accountNumber` (_string_) Ad account number on the partner platform. **Filter Group:** Small **Available Version:** 67.0 * `active` (_boolean_) Indicates whether the ad account is currently active (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `errors` (_array of CdpErrorRepresentation_) Validation errors for the account. **Filter Group:** Small **Available Version:** 67.0 * `hasError` (_boolean_) Indicates whether validation errors exist for the account (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `managerAccountId` (_string_) Manager account ID, if the account is managed by another account. **Filter Group:** Small **Available Version:** 67.0 ### PartnerObjectRepresentation Partner Object Output Represents a partner-platform object associated with an activation target. * `name` (_string_) Display name on the external platform. **Filter Group:** Small **Available Version:** 67.0 * `partnerObjectId` (_string_) Identifier on the external platform. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Status of the partner object. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Active`, `NotActive`. * `type` (_string_) Partner-object type identifier. **Filter Group:** Small **Available Version:** 67.0 ### CdpAssetReferenceInputRepresentation Asset Reference Input Input representation for an asset reference. Includes all fields of `CdpAssetBaseInputRepresentation`. ### ActivationTargetSubjectConfigInputRepresentation Activation Target Subject Config Input Represents the activation target subject configuration input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `developerName` (_string_) Developer name of activation target subject configuration. **Available Version:** 60.0 * `queryPathConfig` (_array of QueryPathConfigListInputRepresentation_) Path of the activation target subject configuration. **Available Version:** 60.0 ### AttributeLimitingExpressionInputConfigRepresentation Attribute Limiting Expression Config Input Represents the limiting expression configuration input for an activation. * `attributeLimitingExpressions` (_array of AttributeLimitingExpressionInputRepresentation_, required) Input list of an attribute's limiting expressions. **Available Version:** 63.0 ### AttributesConfigInputRepresentation Attributes Config Input Represents the configuration input for attributes. * `attributes` (_array of ActivationAdditionalAttributesConfigInputRepresentation_, required) Additional attributes for the activation. **Available Version:** 63.0 ### ContactPointConfigInputRepresentation Contact Point Config Input Represents the activation contact point configuration input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `contactPoints` (_array of ActivationContactPointInputRepresentation_) List of contact points. ### CuratedEntityInputRepresentation Curated Entity Input Represents the input details for a curated entity. * `label` (_string_, required) DMO label of the curated entity. **Available Version:** 63.0 * `name` (_string_, required) DMO API name of the curated entity. **Available Version:** 63.0 ### ActivationDataSourceConfigInputRepresentation Activation Data Source Config Input Represents the configuration input for an activation data source. * `dataSources` (_array of DataSourceNameConfigInputRepresentation_, required) List of data sources for the activation. **Available Version:** 63.0 ### DMOFilterConfigInputRepresentation Represents DMO filter configuration input. ### StaticDataConfigInputRepresentation Static Data Config Input Represents the configuration input for static data. * `staticData` (_array of StaticDataInputRepresentation_, required) List of standard attributes. **Available Version:** 60.0 ### WaterfallSelectedChildSegmentsConfigInputRepresentation Waterfall Selected Child Segments Config Input Represents the input configuration of the selected child segments for a Waterfall activation. * `childSegmentsConfig` (_object_) List of child segment developer names selected for the Waterfall activation. **Available Version:** 67.0 Includes all fields of `WaterfallChildSegmentNamesInputRepresentation`. * `selectedAllSegments` (_boolean_) Indicates whether all child segments of the Waterfall segment are selected (`true`) or not (`false`). **Available Version:** 67.0 ### ActivationTargetSubjectRepresentation Activation Target Subject Output Represents the activation target subject output. Includes all fields of `CdpAssetBaseRepresentation`. * `developerName` (_string_) Developer name for the activation target subject. **Filter Group:** Small **Available Version:** 60.0 * `masterLabel` (_string_) Master label for the activation target subject. **Filter Group:** Small **Available Version:** 60.0 * `queryPathConfig` (_object_) Query path for the activation target. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `QueryPathConfigListRepresentation`. ### AttributeLimitingExpressionConfigRepresentation Attribute Limiting Expression Config Output Represents the limiting expression configurations for an activation. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeLimitingExpressions` (_array of AttributeLimitingExpressionRepresentation_) List of an attribute's limiting expressions. **Filter Group:** Small **Available Version:** 63.0 ### ActivationAttributesConfigRepresentation Activation Attributes Config Output Represents the activation attributes configuration. Includes all fields of `CdpAssetBaseRepresentation`. * `attributes` (_array of ActivationAttributeRepresentation_) Attributes for the activation. ### ContactPointsConfigRepresentation Contact Points Config Output Represents the activation contact point configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `contactPoints` (_array of ContactPointConfigRepresentation_) Contact points of the activation. ### CdpAssetReferenceRepresentation Asset Reference Output Represents an asset reference. Includes all fields of `CdpAssetBaseRepresentation`. ### ActivationDataSourcesRepresentation Activation Data Sources Output Represents the activation data source output. Includes all fields of `CdpAssetBaseRepresentation`. * `dataSources` (_array of ActivationDataSourceConfigRepresentation_) Data sources for the activation. **Filter Group:** Small **Available Version:** 60.0 ### DmoFiltersConfigRepresentation DMO Filters Config Output Represents the configuration of DMO filters. Includes all fields of `CdpAssetBaseRepresentation`. * `filters` (_array of DmoFilterRepresentation_) DMO filters for the activation. ### QueryPathConfigListRepresentation Query Path Config List Output Represents the activation query path configuration list output. Includes all fields of `CdpAssetBaseRepresentation`. * `configs` (_array of QueryPathConfigRepresentation_) List of query path configurations. ### StaticDataConfigRepresentation Static Data Config Output Represents the static data configuration output. * `staticData` (_array of StaticDataRepresentation_) List of campaign data attributes configured for an activation, including standard and custom attributes. **Filter Group:** Small **Available Version:** 60.0 ### WaterfallSelectedChildSegmentsConfigRepresentation Waterfall Selected Child Segments Config Output Represents the configuration of the selected child segments for a Waterfall activation. * `childSegmentsConfig` (_object_) List of child segments selected for the Waterfall activation. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `WaterfallChildSegmentNamesRepresentation`. * `selectedAllSegments` (_boolean_) Indicates whether all child segments of the Waterfall segment are selected (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 ### ChannelPreferenceRepresentation Channel Preference Output Represents a single channel preference option, such as primary phone or secondary email. * `label` (_string_) Localized display label for the preference, such as `Primary` or `Secondary`. **Filter Group:** Small **Available Version:** 67.0 * `option` (_string_) Machine-readable preference option value. **Filter Group:** Small **Available Version:** 67.0 ### ChannelRepresentation Channel Output Represents a contact-point delivery channel. * `apiName` (_string_) API name of the underlying contact-point data model object (DMO), such as `ssot__ContactPointEmail__dlm`. **Filter Group:** Small **Available Version:** 67.0 * `channelType` (_string_) Type of delivery channel. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `DigitalId`, `Email`, `Phone`, `Push`, `Whatsapp`. * `isMapped` (_boolean_) Indicates whether the org has data mapped to the channel's data model object (DMO) in the requested data space (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label for the channel's underlying data model object (DMO). **Filter Group:** Small **Available Version:** 67.0 ### DataSourceRepresentation Data Source Output Represents a data source available for an activation channel and data model object (DMO) pair. * `dataSourceObjects` (_array of string_) API names of the data-source objects backing the data source. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Record ID (18-character) of the data source. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Display name of the data source. **Filter Group:** Small **Available Version:** 67.0 ### MatchBoostProviderRepresentation Match Boost Provider Output Represents an identity provider eligible for match-boost. * `providerId` (_string_) Partner-issued provider ID. **Filter Group:** Small **Available Version:** 67.0 * `providerName` (_string_) Display name of the identity provider. **Filter Group:** Small **Available Version:** 67.0 * `supportedContactPoints` (_array of string_) Contact-point types that the provider can augment. **Filter Group:** Small **Available Version:** 67.0 ### CdpActionResponseBaseRepresentation Action Response Base Output Represents the base response for an action. Abstract parent of: * [Calculated Insight Standard Action Response Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3ACalculated%2BInsight%2BStandard%2BAction%2BResponse%2BOutput) * [Connection Command Action Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AConnection%2BCommand%2BAction%2BOutput) * [Connection Schema Action Response Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AConnection%2BSchema%2BAction%2BResponse%2BOutput) * [Connection Test Action Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AConnection%2BTest%2BAction%2BOutput) * [Data Graph Action Response Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AData%2BGraph%2BAction%2BResponse%2BOutput) * [Data Stream Action Response Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AData%2BStream%2BAction%2BResponse%2BOutput) * [Data Transform Action Response Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AData%2BTransform%2BAction%2BResponse%2BOutput) * [Segment Action Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3ASegment%2BAction%2BOutput) * `errors` (_array of CdpErrorRepresentation_) List of errors that resulted from the action. **Filter Group:** Big **Available Version:** 57.0 * `success` (_boolean_) Indicates whether the action was initiated successfully (`true`) or not (`false`). **Filter Group:** Big **Available Version:** 57.0 ### ActivationDataRepresentation Activation Data Output Represents an activation record in an Audience data model object (DMO). Includes all fields of `CdpAssetBaseRepresentation`. * `activatedEntityFqk` (_string_) Fully Qualified Key (FQK) of the activated entity. **Filter Group:** Small **Available Version:** 61.0 * `activatedOnId` (_string_) ActivateOn entity ID, such as Individual.Id or Unified Individual.Id. **Filter Group:** Small **Available Version:** 61.0 * `activationRecord` (_string_) Activated attributes payload as JSON BLOB **Filter Group:** Small **Available Version:** 61.0 * `deltaType` (_string_) Activation delta type **Filter Group:** Small **Available Version:** 61.0 Allowed values: `[object Object]`, `[object Object]`, `[object Object]`, `[object Object]`. * `publishDate` (_string_) Date that the activation was published. **Filter Group:** Small **Available Version:** 61.0 * `segmentId` (_string_) Unique ID for each segment. **Filter Group:** Small **Available Version:** 61.0 * `segmentOnId` (_string_) Key identifier based on the SegmentOn entity. Same as Activated-entity-id when ActivateOn = SegmentOn. **Filter Group:** Small **Available Version:** 61.0 * `segmentedEntityFqk` (_string_) Fully Qualified Key of the segmented entity. **Filter Group:** Small **Available Version:** 61.0 ### ActivationHistoryRecordRepresentation Activation History Record Output Represents one publish-history record for a market segment activation. * `acceptedPopulation` (_integer_) Number of records accepted by the platform. **Filter Group:** Small **Available Version:** 67.0 * `activationJobId` (_string_) Unique ID of the activation job. **Filter Group:** Small **Available Version:** 67.0 * `activationName` (_string_) Name of the activation. **Filter Group:** Small **Available Version:** 67.0 * `activationPlatformName` (_string_) Name of the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `activationPopulation` (_integer_) Population sent to the activation platform. **Filter Group:** Small **Available Version:** 67.0 * `activationTargetId` (_string_) Record ID (15- or 18-character) of the activation target. **Filter Group:** Small **Available Version:** 67.0 * `activationTargetName` (_string_) Name of the activation target. **Filter Group:** Small **Available Version:** 67.0 * `appendErrorCodeToMessage` (_boolean_) Indicates whether the error code is appended to the error message (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `dataSource` (_string_) Data source associated with the activation. **Filter Group:** Small **Available Version:** 67.0 * `errorCode` (_string_) Error code returned when the publish failed. **Filter Group:** Small **Available Version:** 67.0 * `errorMessage` (_string_) Human-readable error message returned when the publish failed. **Filter Group:** Small **Available Version:** 67.0 * `errorTitle` (_string_) Short error title returned when the publish failed. **Filter Group:** Small **Available Version:** 67.0 * `marketSegmentId` (_string_) Record ID (15- or 18-character) of the market segment. **Filter Group:** Small **Available Version:** 67.0 * `partnerValidationSummary` (_object_) Aggregated partner-side validation results for the publish run. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `PartnerValidationSummaryRepresentation`. * `publishEndTime` (_string (date-time)_) Timestamp when the publish completed. **Filter Group:** Small **Available Version:** 67.0 * `publishStatus` (_string_) Status of the publish run. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Completed`, `Created`, `Error`, `PartnerError`, `PartnerProcessing`, `Pending`, `Queued`, `Restarting`, `Running`, `SegmentError`, `Skipped`, `Started`. * `publishType` (_string_) How the publish was triggered. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Manual`, `Scheduled`. * `rejectedPopulation` (_integer_) Number of records rejected during publish. **Filter Group:** Small **Available Version:** 67.0 * `segmentPopulation` (_integer_) Total population of the market segment. **Filter Group:** Small **Available Version:** 67.0 * `targetSize` (_integer_) Target size for the activation. **Filter Group:** Small **Available Version:** 67.0 ### CdpObjectBaseInputRepresentation Object Base Input Represents base object input. * `dataSpaceName` (_string_) Name of the data space. If unspecified, the `default` data space is used. This property is required for data graph resources. **Available Version:** 59.0 * `description` (_string_) Description of the object to create. **Available Version:** 59.0 * `label` (_string_) Label of the object to create. This property is required for data graph resources. **Available Version:** 59.0 * `name` (_string_) API name of the object to create. This property is required for data graph resources. **Available Version:** 59.0 ### AgentConfigurationInputRepresentation Agent Configuration Input Represents the input for agent configuration. * `contextDataSources` (_object_) Context data sources for the agent. **Available Version:** 66.0 Includes all fields of `AgentContextDataSourcesInputRepresentation`. * `profileDmos` (_array of ProfileDmoInputRepresentation_) List of profile data model objects (DMOs). **Available Version:** 66.0 ### AgentConfigurationRepresentation Agent Configuration Output Represents agent configuration. * `contextDataSources` (_object_) Context data sources for the agent. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `AgentContextDataSourcesRepresentation`. * `profileDmos` (_array of ProfileDmoRepresentation_) List of profile data model objects (DMOs). **Filter Group:** Small **Available Version:** 66.0 ### CdpCalculatedInsightCollectionDataRepresentation Calculated Insight Collection Data Output Representation for calculated insight collection data. * `count` (_integer_) Number of results returned in the page. **Filter Group:** Small **Available Version:** 57.0 * `currentPageToken` (_string_) Token identifying the current page. **Filter Group:** Small **Available Version:** 57.0 * `currentPageUrl` (_string_) Connect REST API URL identifying the current page. **Filter Group:** Small **Available Version:** 57.0 * `items` (_array of CdpCalculatedInsightRepresentation_) List of calculated insights. **Filter Group:** Small **Available Version:** 57.0 * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn't a next page. **Filter Group:** Small **Available Version:** 57.0 * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn't a next page. **Filter Group:** Small **Available Version:** 57.0 * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn't a previous page. **Filter Group:** Small **Available Version:** 57.0 * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn't a previous page. **Filter Group:** Small **Available Version:** 57.0 * `total` (_integer_) Total row count of calculated insights. **Filter Group:** Small **Available Version:** 57.0 ### CdpCalculatedInsightDimensionRepresentation Calculated Insight Dimension Output Represents a calculated insight dimension. * `apiName` (_string_) Api Name * `creationType` (_string_) Creation Type * `dataSource` (_object_) Data Source Includes all fields of `CdpCalculatedInsightDataSourceRepresentation`. * `dataType` (_string_) Data Type * `dateGranularity` (_string_) Date Granularity * `displayName` (_string_) Display Name * `fieldRole` (_string_) Field Role * `formula` (_string_) Formula ### CdpCalculatedInsightMeasureRepresentation Calculated Insight Measure Output Represents a calculated insight measure. * `apiName` (_string_) Api Name * `creationType` (_string_) Creation Type * `dataSource` (_object_) Data Source Includes all fields of `CdpCalculatedInsightDataSourceRepresentation`. * `dataType` (_string_) Data Type * `displayName` (_string_) Display Name * `fieldAggregationType` (_string_) Field Aggregation Type * `fieldRole` (_string_) Field Role * `formula` (_string_) Formula ### CommunicationCappingDataSpaceInputRepresentation Communication Capping Data Space Input Represents the input for a communication capping data space association. * `dataCommunicationCapDefId` (_string_) ID of the communication capping definition. **Available Version:** 67.0 * `dataSpaceId` (_string_) ID of the data space. **Available Version:** 67.0 ### CommunicationCappingRelatedDimInputRepresentation Communication Capping Related Dim Input Represents the input for a communication capping related dimension. * `apiName` (_string_) API name of the related dimension association. **Available Version:** 67.0 * `dataCommCapDimId` (_string_) ID of the communication capping dimension. **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the communication capping definition. **Available Version:** 67.0 ### CommunicationCappingRelatedDimRepresentation Communication Capping Related Dim Output Represents a communication capping related dimension. * `apiName` (_string_) API name of the related dimension. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDimId` (_string_) ID of the communication capping dimension. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDimName` (_string_) Name of the communication capping dimension. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapDefId` (_string_) ID of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingActivationTargetRepresentation Communication Capping Activation Target Output Represents a communication capping activation target. * `activationTargetId` (_string_) ID of the associated activation target. **Filter Group:** Small **Available Version:** 67.0 * `actvTargetName` (_string_) Name of the activation target. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDim` (_CommunicationCappingDimRepresentation_) Dimension metadata associated with the activation target. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDimValue` (_CommunicationCappingDimValueRepresentation_) Dimension value associated with the activation target. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character ID of the activation target record. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingActivationTargetDimInputRepresentation Communication Capping Activation Target Dim Input Represents the input for a dimension-to-dimension-value association for an activation target. * `dataCommCapDimId` (_string_) ID of the dimension. **Available Version:** 67.0 * `dataCommCapDimValueId` (_string_) ID of the dimension value. **Available Version:** 67.0 ### CommunicationCappingDimValueInputRepresentation Communication Capping Dim Value Input Represents the input for a communication capping dimension value. * `apiName` (_string_) API name of the dimension value. **Available Version:** 67.0 * `dataCommCapDimId` (_string_) ID of the parent dimension. **Available Version:** 67.0 * `id` (_string_) ID of the dimension value. **Available Version:** 67.0 * `value` (_string_) Dimension value. **Available Version:** 67.0 ### CommunicationCappingDimValueRepresentation Communication Capping Dim Value Output Represents a communication capping dimension value. * `apiName` (_string_) API name of the dimension value. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDimId` (_string_) ID of the parent dimension. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character ID of the dimension value. **Filter Group:** Small **Available Version:** 67.0 * `value` (_string_) Dimension value. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingRuleDimInputRepresentation Communication Capping Rule Dim Input Represents the input for a dimension association for a communication capping rule. * `dimId` (_string_) ID of the dimension. **Available Version:** 67.0 * `dimValueIds` (_array of string_) IDs of the dimension values. **Available Version:** 67.0 ### CommunicationCappingRuleDimRepresentation Communication Capping Rule Dim Output Represents a dimension association for a communication capping rule. * `apiName` (_string_) API name of the rule dimension. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDim` (_CommunicationCappingDimRepresentation_) Dimension metadata. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapDimValue` (_array of CommunicationCappingDimValueRepresentation_) Dimension values associated with the rule dimension. **Filter Group:** Small **Available Version:** 67.0 * `dataCommCapRuleId` (_string_) ID of the parent communication capping rule. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character ID of the rule dimension. **Filter Group:** Small **Available Version:** 67.0 ### ResourceFiltersInputRepresentation Resource Filters Input Input representation for resource filters for a connection. * `filtersByProperty` (_array of ResourceFilterByPropertyInputRepresentation_, required) List of filters that return only a specific subset of fields and objects for a connection. **Available Version:** 63.0 ### BaseConnectionFieldRepresentation Base Connection Field Output Abstract superclass that represents the output for a connection field. Abstract parent of: * [Connection Field Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AConnection%2BField%2BOutput) * [CRM Connection Field Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3ACRM%2BConnection%2BField%2BOutput) * `creationType` (_string_) For a CRM connection field, the creation type of the field. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Custom`, `Standard`. * `format` (_string_) Date format of the field. **Filter Group:** Small **Available Version:** 62.0 * `isCalculated` (_boolean_) For a CRM connection field, indicates whether the field is calculated (`true`) or not (`false`). A calculated field is derived or a core formula field. **Filter Group:** Small **Available Version:** 63.0 * `isRequired` (_boolean_) Indicates whether the field is required (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) For a CRM connection field, the label of the field. The label is different from the connection's API name. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the Data 360 source field. **Filter Group:** Small **Available Version:** 61.0 * `originalType` (_string_) Data type of the source field. **Filter Group:** Small **Available Version:** 62.0 * `type` (_string_) Data type of the field. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Unsupported`, `Url`. ### CrmConnectionObjectRepresentation CRM Connection Object Output Represents a source object for a CRM connection. Includes all fields of `BaseConnectionObjectRepresentation`. * `creationType` (_string_, required) Creation type of the source object. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Custom`, `Standard`. * `hasChangeEvent` (_boolean_, required) Indicates whether the source object has a change event (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_, required) Label of the source object. (The object's label is not its API name.) **Filter Group:** Small **Available Version:** 63.0 ### SalesforceMarketingCloudStandardConnectionObjectRepresentation Salesforce Marketing Cloud Standard Connection Object Output Represents a standard source object for a Salesforce Marketing Cloud connection. Includes all fields of `BaseConnectionObjectRepresentation`. * `bundleName` (_string_, required) Name of the bundle to which the source object belongs. **Filter Group:** Small **Available Version:** 63.0 ### SalesforceMarketingCloudDataExtensionConnectionObjectRepresentation Salesforce Marketing Cloud Data Extension Connection Object Output Represents a data extension source object for a Salesforce Marketing Cloud connection. Includes all fields of `BaseConnectionObjectRepresentation`. * `customObjectId` (_string_, required) Custom object ID of the source object. **Filter Group:** Small **Available Version:** 63.0 * `dataExtensionStorageSize` (_string_) Human-readable storage size of the data extension (for example, "768.81 MB"). Populated only when `includeDataExtensionSize` is passed in the advanced attributes. Otherwise, the value is null. **Filter Group:** Small **Available Version:** 68.0 * `description` (_string_) Description of the source object. **Filter Group:** Small **Available Version:** 63.0 * `externalKey` (_string_) Source-side external key (`customerKey`) of the data extension. Null when the connector doesn't report it. **Filter Group:** Small **Available Version:** 68.0 * `modifiedDate` (_string_) Last modified date of the data extension, in ISO-8601 format. Null when the connector doesn't report it. **Filter Group:** Small **Available Version:** 68.0 * `ownerId` (_string_) Owner ID of the data extension. Null when the connector doesn't report it. **Filter Group:** Small **Available Version:** 68.0 * `rowCount` (_number (int64)_) Number of rows in the data extension. Null when the connector doesn't report a row count. **Filter Group:** Small **Available Version:** 68.0 ### ConnectionObjectRepresentation Connection Object Output Represents a source object for a connection. Includes all fields of `BaseConnectionObjectRepresentation`. * `attributes` (_object_, required) Attributes of the source object. Attributes are returned in the form `Map`. **Filter Group:** Small **Available Version:** 62.0 * `objectType` (_string_, required) Type of the source object. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Activity`, `Comment`, `Group`, `Permission`, `StructuredData`, `UnstructuredData`, `User`. ### ConnectionPreviewRecordRepresentation Connection Preview Record Output Represents a common record for a connection preview. * `record` (_object_) Connection preview record. **Filter Group:** Small **Available Version:** 62.0 ### ConnectionSchemaRepresentation Connection Schema Output Represents a schema for a connection. * `label` (_string_, required) Label of the connector. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_, required) Developer name of the connector. **Filter Group:** Small **Available Version:** 60.0 * `schemaType` (_string_, required) Schema of the connector. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `DataConnectionEvent`, `IngestApi`, `StreamingApp`. ### ConnectionSchemaInputRepresentation Connection Schema Input Input representation for a connection schema. * `label` (_string_, required) Label of the connector. **Available Version:** 60.0 * `name` (_string_, required) Developer name of the connector. **Available Version:** 60.0 * `schemaType` (_string_, required) Schema of the connector. **Available Version:** 60.0 Allowed values: `DataConnectionEvent`, `IngestApi`, `StreamingApp`. ### DataConnectionParameterInputRepresentation Data Connection Parameter Input Key-value pair for credentials and parameters of a data connection. * `paramName` (_string_, required) Name of the parameter. Each attribute of the connector metadata is a possible parameter name that you provide. **Available Version:** 61.0 * `value` (_string_, required) Value of the parameter. **Available Version:** 61.0 ### ConnectorInfoRepresentation Connector Info Output Represents information about a Data 360 connector. * `description` (_string_) Description of the connector. **Filter Group:** Small **Available Version:** 62.0 * `features` (_array of ConnectorFeatureRepresentation_) List of features of the connector. **Filter Group:** Small **Available Version:** 62.0 * `iconUrl` (_string_) URL for the icon of the connector. **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the connector. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Name of the connector. **Filter Group:** Small **Available Version:** 62.0 * `releaseLevel` (_string_) Release level of the connector. **Filter Group:** Small **Available Version:** 63.0 ### ConnectorFeatureRepresentation Connector Feature Output Represents a feature for a Data 360 connector. * `config` (_object_) Configuration of the feature. **Filter Group:** Small **Available Version:** 62.0 Additional properties: `string`. * `featureType` (_string_) Type of the feature. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataActionTargetCRMConfig Data Action Target Core Config Input Represents the config input for CRM data action targets. Includes all fields of `CdpDataActionTargetConfig`. * `orgId` (_string_) ID for the target CRM org. **Available Version:** 58.0 * `orgLabel` (_string_) Label for the target CRM org. **Available Version:** 58.0 ### CdpDataActionTargetInternalWebConfig Data Action Target Internal Web Config Input Represents the config input for internal web data action targets. Includes all fields of `CdpDataActionTargetConfig`. ### CdpDataActionTargetMCConfig Data Action Target Marketing Cloud Config Input Represents the config input for Marketing Cloud data action targets. Includes all fields of `CdpDataActionTargetConfig`. * `contentKey` (_string_) Content key for Marketing Cloud. **Available Version:** 58.0 * `contentTemplate` (_string_) Content template. **Available Version:** 58.0 ### CdpDataActionTargetWebConfig Data Action Target Web Config Input Represents the config input for web data hook action targets. Includes all fields of `CdpDataActionTargetConfig`. ### CdpDataActionCRMTargetInfo Data Action Target Core Config Output Represents the configuration for a CRM data action target. Includes all fields of `CdpDataActionTargetInfo`. * `label` (_string_) Org label. **Available Version:** 62.0 * `orgId` (_string_) Org ID. **Available Version:** 62.0 ### CdpDataActionTargetInternalWebInfo Data Action Target Internal Web Config Output Represents the configuration for an Internal WebHook data action target. Includes all fields of `CdpDataActionTargetInfo`. ### CdpDataActionMCTargetInfo Data Action Target Marketing Cloud Config Output Represents the configuration for a Marketing Cloud data action target. Includes all fields of `CdpDataActionTargetInfo`. * `contentKey` (_string_) Content key. **Available Version:** 62.0 * `contentTemplate` (_string_) Content template. **Available Version:** 62.0 ### CdpDataActionTargetWebInfo Data Action Target Web Hook Config Output Represents the configuration for a web hook data action target. Includes all fields of `CdpDataActionTargetInfo`. ### DataActionConditionOutputRepresentation Data Action Condition Output Represents DataActionCondition output. * `conditionSourceType` (_string_) Source type of the data action's condition. **Filter Group:** Small **Available Version:** 62.0 * `conditionType` (_string_) Type of the data action's condition. This type differentiates between regular and additional conditions. **Filter Group:** Small **Available Version:** 62.0 * `dataGraphName` (_string_) Name of the data action's graph. **Filter Group:** Small **Available Version:** 62.0 * `fieldName` (_string_) Field name. **Filter Group:** Small **Available Version:** 62.0 * `objectDataGraphName` (_string_) Object data graph name. **Filter Group:** Small **Available Version:** 62.0 * `objectName` (_string_) Object name. **Filter Group:** Small **Available Version:** 62.0 * `operator` (_string_) Data action operator. **Filter Group:** Small **Available Version:** 62.0 * `order` (_string_) Data action order. **Filter Group:** Small **Available Version:** 62.0 * `value` (_string_) Value **Filter Group:** Small **Available Version:** 62.0 ### DataActionEnrichmentOutputRepresentation Data Action Enrichment Output Represents data action enrichment output. * `dataActionProjectedFields` (_array of DataActionProjectedFieldOutputRepresentation_) Data action projected fields. **Filter Group:** Small **Available Version:** 62.0 * `dataActionRelationshipEdges` (_array of DataActionRelationshipEdgeOutputRepresentation_) Data action relationship edges. **Filter Group:** Small **Available Version:** 62.0 * `dataGraphApiName` (_string_) API name of the Data graph. **Filter Group:** Small **Available Version:** 62.0 * `enrichmentName` (_string_) Name of the enrichment. **Filter Group:** Small **Available Version:** 62.0 ### DataActionProjectedFieldOutputRepresentation Data Action Projected Field Output Represents the projected field output for a create data action request. * `fieldAliasName` (_string_) Field's alias name. **Filter Group:** Small **Available Version:** 62.0 * `fieldApiName` (_string_) Field's API name. **Filter Group:** Small **Available Version:** 62.0 * `objectApiName` (_string_) Object's API Name. **Filter Group:** Small **Available Version:** 62.0 * `objectDataGraphName` (_string_) Object's data graph name. **Filter Group:** Small **Available Version:** 62.0 ### DataActionSourceOutputRepresentation Data Action Source Output Represents the data action source output. * `actionsSourceObject` (_string_) Data action's source output. **Filter Group:** Small **Available Version:** 62.0 * `actionsSourceObjectPath` (_string_) Path of the data action's source object. **Filter Group:** Small **Available Version:** 62.0 * `actionsSourceObjectType` (_string_) Type of the data action's source object. **Filter Group:** Small **Available Version:** 62.0 * `developerName` (_string_) Developer name of the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectDevName` (_string_) Developer name for the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectId` (_string_) ID of the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectLinkedUiRecordId` (_string_) Linked UI record ID of the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectLinkedUiRecordName` (_string_) Linked UI record name for the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectMasterLabel` (_string_) Label of the data action's source object. **Filter Group:** Small **Available Version:** 62.0 * `objectName` (_string_) Name of the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `objectType` (_string_) Type of the data action source object. **Filter Group:** Small **Available Version:** 62.0 * `subscriptionModes` (_array of string_) Subscription modes of the data action source object. **Filter Group:** Small **Available Version:** 62.0 Items: Allowed values: `Create`, `Delete`, `Update`. ### CdpAssetBaseInputRepresentation Asset Base Input Represents a base asset. * `id` (_string_) ID of the asset. **Available Version:** 58.0 * `name` (_string_) Name of the asset. **Available Version:** 58.0 * `namespace` (_string_) Namespace of the asset. **Available Version:** 58.0 ### DataSpaceRepresentation Data Space Output Represents a data space. Includes all fields of `CdpAssetBaseRepresentation`. * `filter` (_object_) Data space filter. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataSpaceFilterRepresentation`. ### DataCleanRoomTemplateRepresentation Data Clean Room Template Output Represents a use case template for a clean room. Includes all fields of `CdpAssetBaseRepresentation`. * `configuration` (_object_) Configuration of the use case template. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateConfigRepresentation`. * `description` (_string_) Description of the use case template. **Filter Group:** Small **Available Version:** 63.0 * `metadataConfiguration` (_object_) Configuration metadata containing member-specific settings and use-case-dependent operational parameters. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMetadataConfigurationRepresentation`. * `providerId` (_string_) Provider ID that the template is associated with. **Filter Group:** Small **Available Version:** 63.0 * `queryTemplate` (_object_) Defined query template for the use case template. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `object`. * `templateType` (_string_) Type of use case template. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Custom`, `Salesforce`. * `templateVersion` (_string_) Version of the use case template. **Filter Group:** Small **Available Version:** 63.0 * `useCaseType` (_string_) Type of use case for the template. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Custom`, `Overlap`. ### DataCleanRoomOutputConfigurationRepresentation Data Clean Room Output Configuration Input Represents the input for clean room output configurations. * `connectionAttributes` (_DataCleanRoomAwsS3ConnectionAttributesRepresentation | DataCleanRoomSnowflakeConnectionAttributesRepresentation_) Details about the connection attributes. Use the connection attributes object that correspongs to the connector type. For example: * Use the Data Clean Room AWS S3 Connection Attributes Input for the `CleanroomAwsS3` connector type. * Use the Data Clean Room Snowflake Connection Attributes Input for the `CleanroomSnowflake` connector type. **Available Version:** 66.0 One of: `DataCleanRoomAwsS3ConnectionAttributesRepresentation`, `DataCleanRoomSnowflakeConnectionAttributesRepresentation`. * `externalId` (_string_) Specification ID for the mapping details. **Available Version:** 66.0 * `outputDestinationType` (_string_, required) Type of output destination. **Available Version:** 66.0 Allowed values: `ExternalConnector`, `Lakehouse`. ### DataCleanRoomMemberConfigRepresentation Data Clean Room Member Config Output Represents the member configuration for a clean room collaboration. * `externalId` (_string_) ID of the output destination connection. **Filter Group:** Small **Available Version:** 66.0 * `id` (_string_) ID of the member configuration. **Filter Group:** Small **Available Version:** 66.0 * `outputDestinationConfig` (_DataCleanRoomAwsS3OutputDestinationConfigRepresentation | DataCleanRoomSnowflakeOutputDestinationConfigRepresentation_) Configuration of the output destination attributes. The endpoint returns the output destination config object that corresponds to the type of connector. For example: * The Data Clean Room Aws S3 Output Destination Config Output is returned for the `AwsS3` type. * The Data Clean Room Snowflake Output Destination Config Output is returned for the `Snowflake` type. **Filter Group:** Small **Available Version:** 66.0 One of: `DataCleanRoomAwsS3OutputDestinationConfigRepresentation`, `DataCleanRoomSnowflakeOutputDestinationConfigRepresentation`. * `outputDestinationId` (_string_) ID or reference key of the output destination. **Filter Group:** Small **Available Version:** 66.0 * `outputDestinationType` (_string_) Type of output destination. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `ExternalConnector`, `Lakehouse`. * `templateVersionId` (_string_) ID or reference key to the template version. **Filter Group:** Small **Available Version:** 66.0 ### DataCleanRoomCollaborationResultDataObjectRepresentation Data Clean Room Collaboration Result Data Object Output Represents a data object created by a clean room collaboration. Includes all fields of `CdpAssetBaseRepresentation`. * `status` (_string_) Status of the DMO. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Active`, `Error`, `Inactive`, `Processing`. ### DataCleanRoomProviderSourceConfigInputRepresentation Data Clean Room Provider Source Config Input Represents the source type configuration input for a clean room provider. * `type` (_string_) Source type of the provider. **Available Version:** 63.0 Allowed values: `AWS`, `DATA_CLOUD`. ### CustomUseCaseTemplateInputRepresentation Custom Use Case Template Input Represents the input for a custom use case template for a clean room. * `description` (_string_) Description of the custom use case template. **Available Version:** 63.0 * `name` (_string_) Name of the custom use case template. **Available Version:** 63.0 * `queries` (_array of CustomUseCaseTemplateQueryInputRepresentation_) List of queries defined in the custom use case template. **Available Version:** 63.0 * `tables` (_array of CustomUseCaseTemplateTableInputRepresentation_) List of tables referenced in the template queries. **Available Version:** 63.0 * `useCaseConfigs` (_object_) Configuration of use case template types. Only applicable for `MatchBoost` use case types. For example, use the Match Boose Usecase Config Input for the `MatchBoost` use case type. **Available Version:** 66.0 Additional properties: `MatchBoostUsecaseConfigInputRepresentation`. * `version` (_string_) Version of the custom use case template. **Available Version:** 63.0 ### DataCleanRoomUseCaseTypeInputRepresentation Data Clean Room Use Case Type Input Represents the input for a type of clean room use case. * `useCaseTypes` (_array of string_) List of queries defined in the template. **Available Version:** 63.0 Items: Allowed values: `Custom`, `Overlap`. ### DataCleanRoomProviderSourceConfigRepresentation Data Clean Room Provider Source Config Output Represents the source configuration for a clean room provider. * `type` (_string_) Source type of the provider. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `AWS`, `DATA_CLOUD`. ### DataCleanRoomUseCaseTypeRepresentation Data Clean Room Use Case Type Output Represents the type of clean room use case. Includes all fields of `CdpAssetBaseRepresentation`. * `useCaseTypes` (_array of string_) List of supported use case types. **Filter Group:** Small **Available Version:** 63.0 Items: Allowed values: `Custom`, `Overlap`. ### UseCaseTemplateMappingRepresentation Use Case Template Mapping Output Represents a mapping for a clean room use case template. Includes all fields of `CdpAssetBaseRepresentation`. * `attributes` (_array of UseCaseTemplateMappingAttributeRepresentation_) Mapping attributes for the use case template. **Filter Group:** Small **Available Version:** 63.0 * `collaborationEntity` (_string_) Name of the central entity for the use case template mapping. All attributes are mapped using this collaboration entity. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomCollaborationForUseCaseTypeRepresentation Data Clean Room Collaboration For Use Case Type Output Represents a collaboration for a given use case template. Includes all fields of `CdpAssetBaseRepresentation`. * `dataSpace` (_object_) Name of the data space. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataSpaceRepresentation`. * `description` (_string_) Description of the clean room. **Filter Group:** Small **Available Version:** 66.0 * `members` (_array of DataCleanRoomMemberForUseCaseTypeRepresentation_) List of collaboration members. **Filter Group:** Small **Available Version:** 66.0 * `outputObjectToDevName` (_object_) Map of output object names to their developer names. **Filter Group:** Small **Available Version:** 66.0 Additional properties: `string`. * `status` (_string_) Status of the clean room. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Active`, `Disabled`, `Error`, `Inactive`. * `templateVersion` (_object_) Version information of the template from which the clean room was created. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomTemplateRepresentation`. ### ResourceTransformArgumentRepresentation Resource Transform Argument Output Represents a static argument to an access policy rule's resource transform. The value is always string-encoded regardless of type. * `type` (_string_) Argument type discriminator, such as `STRING`, `NUMBER`, or `BOOLEAN`. **Filter Group:** Small **Available Version:** 67.0 * `value` (_string_) Argument value, string-encoded regardless of type. **Filter Group:** Small **Available Version:** 67.0 ### ConditionGroupRepresentation Condition Group Output Represents a recursive group of conditions joined by AND or OR. * `operands` (_array of ConditionNodeRepresentation_) Operands joined by the operator. Each operand is either a nested group or a leaf condition. **Filter Group:** Small **Available Version:** 67.0 * `operator` (_string_) Logical operator joining the operands (AND or OR). **Filter Group:** Small **Available Version:** 67.0 ### ResourceTransformArgumentInputRepresentation Resource Transform Argument Input A static argument to an AccessPolicy rule's resource transform. Value is always string-encoded regardless of type. * `type` (_string_) Argument type discriminator (STRING, NUMBER, BOOLEAN). Required. **Available Version:** 67.0 * `value` (_string_) Argument value, string-encoded regardless of type. Required. **Available Version:** 67.0 ### ConditionGroupInputRepresentation Condition Group Input Recursive group of conditions joined by AND or OR. * `operands` (_array of ConditionNodeInputRepresentation_) Operands joined by the operator. Each operand is either a nested group or a leaf condition. Required. **Available Version:** 67.0 * `operator` (_string_) Logical operator joining the operands (AND or OR). Required. **Available Version:** 67.0 ### ClassificationAssignmentBulkItemInputRepresentation Classification Assignment Bulk Item Input Represents a single classification with its list of target tags for bulk creation. * `classificationFullyQualifiedName` (_string_, required) Fully-qualified API name of the source classification. **Available Version:** 67.0 * `tagFullyQualifiedNames` (_array of string_, required) Fully-qualified API names of the target tags. Maximum 50. **Available Version:** 67.0 ### BatchResultItemRepresentation Batch Result Item Output Represents a per-item result in a bulk operation response. * `result` (_TaxonomyRepresentation | ClassificationRepresentation | TagRepresentation | ClassificationAssignmentRepresentation | TagAssignmentRepresentation | TagDetectionInstructionRepresentation | array of BatchErrorItemRepresentation_) Result of the operation. On success, contains the created or updated entity or is omitted for delete operations. For failed items (status codes such as `400`, `404`, `412`, or `422`), contains the Batch Error Item Output with error details. The output object depends on the type of result item: * Classification and tag taxonomies return the Taxonomy Output. * Classifications return the Classification Output. * Tags return the Tag Output. * Classification assignments return the Classification Assignment Output. * Tag assignments return the Tag Assignment Output. * Tag detection instructions return the Tag Detection Instruction Output. **Filter Group:** Small **Available Version:** 67.0 One of: `TaxonomyRepresentation`, `ClassificationRepresentation`, `TagRepresentation`, `ClassificationAssignmentRepresentation`, `TagAssignmentRepresentation`, `TagDetectionInstructionRepresentation`, `array of BatchErrorItemRepresentation`. * `statusCode` (_integer_) HTTP status code for the item. For example, `201`, `200`, `204`, `400`, or `404`. **Filter Group:** Small **Available Version:** 67.0 ### CdpUserRepresentation User Output Represents a user. * `id` (_string_) 18-character user ID. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the user. **Filter Group:** Small **Available Version:** 60.0 * `profilePhotoUrl` (_string_) Profile photo of the user to show in the UI. **Filter Group:** Small **Available Version:** 60.0 ### TaxonomyBulkUpdateItemInputRepresentation Taxonomy Bulk Update Item Input Represents the input for a single tag taxonomy update in a bulk update. * `description` (_string_) Description of the tag taxonomy. **Available Version:** 67.0 * `label` (_string_) Label of the tag taxonomy. **Available Version:** 67.0 * `name` (_string_) Developer name of the tag taxonomy. **Available Version:** 67.0 ### ClassificationLookupRepresentation Classification Lookup Output Represents a lightweight reference to a data governance classification. * `fullyQualifiedLabel` (_string_) Hierarchical display label in dotted path format of ancestor labels. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the classification in dotted path format. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the classification. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the classification. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the classification. Terminal segment only. **Filter Group:** Small **Available Version:** 67.0 * `type` (_string_) Type of classification. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. ### TagLookupRepresentation Tag Lookup Output Represents a lightweight reference to a data governance tag. * `fullyQualifiedLabel` (_string_) Hierarchical display label in dotted path format of ancestor labels. **Filter Group:** Small **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the tag in dotted path format. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Unique identifier of the tag. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the tag. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the tag. Terminal segment only. **Filter Group:** Small **Available Version:** 67.0 * `type` (_string_) Type of tag. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. ### TaxonomyLookupRepresentation Taxonomy Lookup Output Represents a lightweight reference to a data governance taxonomy. * `id` (_string_) Unique identifier of the taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `label` (_string_) Display label of the taxonomy. **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Developer name of the taxonomy. Single segment, no hierarchy. **Filter Group:** Small **Available Version:** 67.0 * `taxonomyKind` (_string_) Kind of taxonomy. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Classification`, `Tag`. * `type` (_string_) Type of taxonomy. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Custom`, `System`. ### ClassificationBulkUpdateItemInputRepresentation Classification Bulk Update Item Input Represents the input for a single classification item in a bulk update operation. * `description` (_string_) Updated description. **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the classification to update. **Available Version:** 67.0 * `label` (_string_) Updated display label. **Available Version:** 67.0 * `tagFullyQualifiedNames` (_array of string_) Replaces all tag links. Maximum of 200 items. Provide an empty list to remove all links. Omit to leave unchanged. **Available Version:** 67.0 ### DataGovernanceObjectAccessGrantBulkResultItemRepresentation Data Governance Object Access Grant Bulk Result Item Output Represents a single item result in a bulk operation response. * `result` (_any_) On success, the created grant for a create operation or null for a delete operation. On failure, a list of error objects. **Filter Group:** Small **Available Version:** 67.0 * `statusCode` (_integer_) HTTP status code for the item, such as `200`, `201`, `204`, `400`, or `404`. **Filter Group:** Small **Available Version:** 67.0 ### TagAssignmentTargetInputRepresentation Tag Assignment Target Input Represents a target object and optional field for a tag assignment. * `fieldName` (_string_) API name of the field. Requires `objectName`. **Available Version:** 67.0 * `objectName` (_string_) API name of the data object. **Available Version:** 67.0 ### SuggestTagsJobRepresentation Suggest Tags Job Output Represents a per-object auto-tagging job initiated by the generate action. * `jobId` (_string_) ID of the auto-tagging job (references DataObjectAutoTaggingJob). **Filter Group:** Small **Available Version:** 67.0 * `objectName` (_string_) Target object API name, echoed back from the request for client correlation. **Filter Group:** Small **Available Version:** 67.0 ### TagDetectionInstructionBulkCreateItemRepresentation Tag Detection Instruction Bulk Create Item Input Represents a single tag's detection instruction in a bulk create request. * `instructionTxt` (_string_, required) LLM detection-instruction (prompt) body that defines how the tag is auto-detected. Maximum 100 characters. **Available Version:** 67.0 * `tagFullyQualifiedName` (_string_, required) Fully-qualified API name of the tag the instruction applies to (dotted path). **Available Version:** 67.0 ### TagWithActiveDetectionInstructionRepresentation Tag With Active Detection Instruction Output Represents a tag paired with its currently active detection instruction. * `activeDetectionInstruction` (_object_) Currently active detection instruction for the tag. Null if the tag has no active instruction. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `TagDetectionInstructionRepresentation`. * `tag` (_object_) Tag the detection instruction applies to. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `TagLookupRepresentation`. ### TagBulkUpdateItemInputRepresentation Tag Bulk Update Item Input Represents the input for a single tag item in a bulk update operation. * `classificationFullyQualifiedNames` (_array of string_) Replaces all classification links. Maximum of 200 items. Provide an empty list to remove all links. Omit to leave unchanged. **Available Version:** 67.0 * `description` (_string_) Updated description. **Available Version:** 67.0 * `fullyQualifiedName` (_string_) Fully-qualified API name of the tag to update. **Available Version:** 67.0 * `label` (_string_) Updated display label. **Available Version:** 67.0 * `parentTagFullyQualifiedName` (_string_) Fully-qualified API name of the new parent tag. Provide `null` to move the tag to the root level. Must be in the same taxonomy. **Available Version:** 67.0 ### CdpDataGraphSourceInputRepresentation Data Graph Source Input Data graph source object input representation. Includes all fields of `CdpObjectBaseInputRepresentation`. * `fields` (_array of CdpDataGraphFieldInputRepresentation_) List of fields on the source object that need to be included in the data graph. **Available Version:** 59.0 * `jsonPath` (_string_) Projected JSON path of this object in the output value JSON from root. **Available Version:** 59.0 * `path` (_array of CdpDataGraphPathToParentInputRepresentation_) Path of the source object. **Available Version:** 59.0 * `recencyCriteria` (_array of CdpDataGraphDataRecencyInputRepresentation_) Recency criteria of the source object. **Available Version:** 59.0 * `relatedObjects` (_array of CdpDataGraphSourceInputRepresentation_) List of related child objects that need to be included in the data graph. **Available Version:** 59.0 * `type` (_string_) Type of the source object. **Available Version:** 59.0 Allowed values: `CALCULATED`, `CALCULATED_STREAMING`, `CALCULATED_REAL_TIME`, `STANDARD`, `CUSTOM`, `SYSTEM`, `DERIVED`, `BRIDGE`, `SEGMENT_MEMBERSHIP`, `ML_PREDICTION`, `ACTIVATION_AUDIENCE`, `TRANSFORM`. ### CdpObjectBaseOutputRepresentation Object Base Output Represents base object output. * `createdBy` (_string_) Who or what created the base object. **Filter Group:** Small **Available Version:** 59.0 * `createdDate` (_string_) Date when the base object was created. **Filter Group:** Small **Available Version:** 59.0 * `dataspaceName` (_string_) Name of the data space of the base object. If unspecified, the `default` data space is used. **Filter Group:** Small **Available Version:** 59.0 * `description` (_string_) Description of the base object. **Filter Group:** Small **Available Version:** 59.0 * `id` (_string_) ID of the base object. **Filter Group:** Small **Available Version:** 59.0 * `label` (_string_) Label of the base object. **Filter Group:** Small **Available Version:** 59.0 * `modifiedBy` (_string_) Who or what most recently modified the base object. **Filter Group:** Small **Available Version:** 59.0 * `modifiedDate` (_string_) When the base object was most recently modified. **Filter Group:** Small **Available Version:** 59.0 * `name` (_string_) Name of the base object. **Filter Group:** Small **Available Version:** 59.0 ### CdpDataGraphSourceObjectOutputRepresentation Data Graph Source Object Output Represents data graph source object output. Includes all fields of `CdpObjectBaseOutputRepresentation`. * `fields` (_array of CdpDataGraphFieldOutputRepresentation_) Fields of the data graph source object. **Filter Group:** Small **Available Version:** 59.0 * `fragmentDMOLabel` (_string_) Fragment data model object (DMO) label. **Filter Group:** Small **Available Version:** 59.0 * `fragmentDMOName` (_string_) Fragment data model object (DMO) name. **Filter Group:** Small **Available Version:** 59.0 * `jsonPath` (_string_) JSON path of the data graph source object. **Filter Group:** Small **Available Version:** 59.0 * `path` (_array of CdpDataGraphPathToParentOutputRepresentation_) Path of the data graph source object. **Filter Group:** Small **Available Version:** 59.0 * `recencyCriteria` (_array of CdpDataGraphRecencyCriteriaOutputRepresentation_) Recency criteria of the data graph source object. **Filter Group:** Small **Available Version:** 59.0 * `relatedObjects` (_array of CdpDataGraphSourceObjectOutputRepresentation_) List of related child objects included in the data graph. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Type of the data graph source object. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Activation_Audience`, `Bridge`, `Calculated`, `Calculated_Real_Time`, `Calculated_Streaming`, `Custom`, `Derived`, `Ml_Prediction`, `Segment_Membership`, `Standard`, `System`, `Transform`. ### CdpQueryDataGraphMetadataRepresentation Data Graph Query Metadata Output Represents metadata for a data graph. * `dataspaceName` (_string_) Name of the data space in which the data graph metadata resides. **Filter Group:** Small **Available Version:** 59.0 * `description` (_string_) Description of the data graph metadata. **Filter Group:** Small **Available Version:** 59.0 * `developerName` (_string_) Developer name of the data graph metadata. **Filter Group:** Small **Available Version:** 59.0 * `dgObject` (_object_) Metadata for the data object of the data graph. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `DataGraphObjectDataRepresentation`. * `extendedProperties` (_object_) Extended properties of the data graph metadata. **Filter Group:** Small **Available Version:** 59.0 * `idDmoName` (_string_) API name of the data model object (DMO) that contains the ID table for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `idsDmo` (_object_) Data about the DMO that contains the ID table for the data graph. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `DataGraphIdsDmoRepresentation`. * `primaryObjectName` (_string_) Name of the primary object for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `primaryObjectType` (_string_) Data type of the primary object for the data graph. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Adg`, `AdgActivationAudience`, `AdgExternal`, `Bridge`, `Calculated`, `CalculatedRealTime`, `CalculatedStreaming`, `Curated`, `Custom`, `Derived`, `MlPrediction`, `Package`, `SegmentMembership`, `Standard`, `System`, `Transform`. * `status` (_string_) Status of the data graph. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Error`, `Inprogress`, `Published`, `Ready`, `StatusUnspecified`, `Unrecognized`. * `valuesDmo` (_object_) Data about the data model object (DMO) that contains the JSON records for the data graph. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `DataGraphValuesDmoRepresentation`. * `valuesDmoName` (_string_) API name of the DMO that contains the JSON records for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `version` (_string_) Version of the data graph metadata. **Filter Group:** Small **Available Version:** 59.0 ### DataGraphFullRefreshConfigInputRepresentation Data Graph Full Refresh Config Input Represents the input for a full refresh data graph. * `schedule` (_object_) Details about the full refresh schedule. **Available Version:** 67.0 Includes all fields of `DataGraphScheduleInputRepresentation`. ### DataKitDetails Data Kit Details Output Represents the details of a data kit. * `components` (_array of DataKitComponentInfo_) List of data kit components. **Filter Group:** Small **Available Version:** 63.0 * `developerName` (_string_) Developer name of the data kit. **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_) Label of the data kit. **Filter Group:** Small **Available Version:** 63.0 * `publishingSequence` (_array of DataKitDefaultComponentInfo_) Publishing sequence for the data kit components. **Filter Group:** Small **Available Version:** 63.0 ### DataKitComponentInputRepresentation Data Kit Component Input Represents the input for a data kit component. * `info` (_DataKitComponentInfoBundleInputRepresentation | DataKitComponentInfoBaseInputRepresentation_) Information about the data kit component. Use the component info input object that corresponds to the component type: * `DataStreamBundle`: Data Kit Component Info Bundle Input * All others: Data Kit Component Info Base Input **Available Version:** 63.0 One of: `DataKitComponentInfoBundleInputRepresentation`, `DataKitComponentInfoBaseInputRepresentation`. * `type` (_string_) Type of the data kit component. **Available Version:** 63.0 Allowed values: `ActivationTarget`, `AnalyticsDashboard`, `AnalyticsVisualization`, `AnalyticsWorkspace`, `CalculatedInsight`, `CopyFieldEnrichment`, `CurrencyConfigObject`, `DataAction`, `DataActionTarget`, `DataCleanRoomDataSpecDef`, `DataCleanRoomProvider`, `DataConnection`, `DataCustomCode`, `DataGraph`, `DataLakeObject`, `DataModelObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `EngagementSignal`, `FiscalCalendarConfigObject`, `IdentityResolution`, `IdpConfiguration`, `InternalDataConnector`, `IrRelatedListEnrichment`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `PersnlBatchDecision`, `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, `PersonalizationSchema`, `SecondaryIndex`, `SemanticModel`, `TuaTemplatedObject`. ### DataKitComponentRepresentation Data Kit Component Output Represents a data kit component. * `info` (_DataKitComponentInfoBundleRepresentation | DataKitComponentInfoBaseRepresentation_) Information about the data kit component. The endpoint returns the component info output object that corresponds to the component type: * `DataStreamBundle`: Data Kit Component Info Bundle Output * All others: Data Kit Component Info Base Output **Filter Group:** Small **Available Version:** 63.0 One of: `DataKitComponentInfoBundleRepresentation`, `DataKitComponentInfoBaseRepresentation`. * `type` (_string_) Type of data kit component. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `ActivationTarget`, `AnalyticsDashboard`, `AnalyticsVisualization`, `AnalyticsWorkspace`, `CalculatedInsight`, `CopyFieldEnrichment`, `CurrencyConfigObject`, `DataAction`, `DataActionTarget`, `DataCleanRoomDataSpecDef`, `DataCleanRoomProvider`, `DataConnection`, `DataCustomCode`, `DataGraph`, `DataLakeObject`, `DataModelObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `EngagementSignal`, `FiscalCalendarConfigObject`, `IdentityResolution`, `IdpConfiguration`, `InternalDataConnector`, `IrRelatedListEnrichment`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `PersnlBatchDecision`, `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, `PersonalizationSchema`, `SecondaryIndex`, `SemanticModel`, `TuaTemplatedObject`. ### CdpDataKitDeployComponentRepresentation Data Kit Deploy Component Input Represents a single component for a data kit deployment. * `config` (_CdpDataKitDeployComponentConfigForBundle | CdpDataKitDeployComponentConfigForDLO | CdpDataKitDeployComponentConfigCalculatedInsight | CdpDataKitDeployComponentConfigForDataAction | CdpDataKitDeployComponentConfigForDataActionTarget | CdpDataKitDeployComponentConfigForDataSemanticSearch | CdpDataKitDeployComponentConfigForDataShare | CdpDataKitDeployComponentConfigForIdpConfiguration | CdpDataKitDeployComponentConfigForPredictionJob | CdpDataKitDeployComponentConfigForTuaFramework | CdpDataKitDeployComponentConfigMlConfiguredModel | CdpDataKitDeployComponentConfigMlRetriever | DataCustomCodeInputRep | DataKitDeployActivationTargetRepresentation | DataKitDeployComponentConfigCopyField | DataKitDeployComponentConfigForIRRelatedList | DataKitDeployComponentConfigIdentityResolutionInput | DataKitDeployComponentConfigSemanticModelInputRepresentation | DataKitDeployDataCleanRoomMappingRepresentation | DataKitDeployDataCleanRoomProviderRepresentation | DataKitDeployDataConnectionRepresentation | DataKitDeployDataGraphInputRepresentation | DataKitDeployDataTransformRepresentation | DataKitDeployMarketActivationRepresentation | DataKitDeployMarketSegmentRepresentation | DataKitDeployPersonalizationInputRepresentation | DataKitDeployInputRepresentation_, required) Configuration of the component. Use the input object that corresponds to the component type. For example, use the Data Kit Deploy Component Config For DLO Input for the `DataLakeObject` component type. * Use the Data Kit Deploy Personalization Input for all personalization-related component types, such as `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, and `PersonalizationSchema`. * Use the Data Kit Deploy Input for all others. See [Supported Component Types for Data Kit Deployment](https://developer.salesforce.com/docs/data/connectapi/guide/deploy-data-kit-payloads.html) for the complete list of component types and their corresponding payload configurations. **Available Version:** 57.0 One of: `CdpDataKitDeployComponentConfigForBundle`, `CdpDataKitDeployComponentConfigForDLO`, `CdpDataKitDeployComponentConfigCalculatedInsight`, `CdpDataKitDeployComponentConfigForDataAction`, `CdpDataKitDeployComponentConfigForDataActionTarget`, `CdpDataKitDeployComponentConfigForDataSemanticSearch`, `CdpDataKitDeployComponentConfigForDataShare`, `CdpDataKitDeployComponentConfigForIdpConfiguration`, `CdpDataKitDeployComponentConfigForPredictionJob`, `CdpDataKitDeployComponentConfigForTuaFramework`, `CdpDataKitDeployComponentConfigMlConfiguredModel`, `CdpDataKitDeployComponentConfigMlRetriever`, `DataCustomCodeInputRep`, `DataKitDeployActivationTargetRepresentation`, `DataKitDeployComponentConfigCopyField`, `DataKitDeployComponentConfigForIRRelatedList`, `DataKitDeployComponentConfigIdentityResolutionInput`, `DataKitDeployComponentConfigSemanticModelInputRepresentation`, `DataKitDeployDataCleanRoomMappingRepresentation`, `DataKitDeployDataCleanRoomProviderRepresentation`, `DataKitDeployDataConnectionRepresentation`, `DataKitDeployDataGraphInputRepresentation`, `DataKitDeployDataTransformRepresentation`, `DataKitDeployMarketActivationRepresentation`, `DataKitDeployMarketSegmentRepresentation`, `DataKitDeployPersonalizationInputRepresentation`, `DataKitDeployInputRepresentation`. * `type` (_string_, required) Type of component. **Available Version:** 57.0 Allowed values: `ActivationTarget`, `AnalyticsDashboard`, `AnalyticsVisualization`, `AnalyticsWorkspace`, `CalculatedInsight`, `CopyFieldEnrichment`, `CurrencyConfigObject`, `DataAction`, `DataActionTarget`, `DataCleanRoomDataSpecDef`, `DataCleanRoomProvider`, `DataConnection`, `DataCustomCode`, `DataGraph`, `DataLakeObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `EngagementSignal`, `FiscalCalendarConfigObject`, `IdentityResolution`, `IdpConfiguration`, `InternalDataConnector`, `IrRelatedListEnrichment`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `PersnlBatchDecision`, `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, `PersonalizationSchema`, `SecondaryIndex`, `SemanticModel`, `TuaTemplatedObject`. ### CdpDataKitMembers Data Kit Members Output Represents the data kit member details for one component. * `developerName` (_array of string_) List of component developer names. **Filter Group:** Small **Available Version:** 63.0 * `entityName` (_string_) List of component entity names. **Filter Group:** Small **Available Version:** 63.0 * `id` (_array of string_) List of component entity IDs. **Filter Group:** Small **Available Version:** 63.0 ### DataKitUnDeployComponentDetails Data Kit UnDeploy Component Details Input The details of a component to be un-deployed from a data kit. * `name` (_string_, required) Name of the component to un-deploy. **Available Version:** 63.0 * `type` (_string_, required) Data kit component type. **Available Version:** 63.0 Allowed values: `ActivationTarget`, `CalculatedInsight`, `DataAction`, `DataActionTarget`, `DataConnection`, `DataGraph`, `DataLakeObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `IdentityResolution`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `SemanticModel`. ### DataKitComponentDependencyRepresentation Data Kit Component Dependency Output Represents component dependency details. * `id` (_string_) ID of the dependent object. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) API name of the dependent object. **Filter Group:** Small **Available Version:** 62.0 * `type` (_string_) Type of the dependent object. **Filter Group:** Small **Available Version:** 62.0 ### DatakitComponentDetails Data Kit Component Details Output Represents the component details of a data kit. * `componentId` (_string_) ID of the data kit component. **Filter Group:** Small **Available Version:** 61.0 * `dataKitName` (_string_) Developer name of the data kit. **Filter Group:** Small **Available Version:** 61.0 * `status` (_string_) Status of the data kit component. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Active`, `Deleting`, `Error`, `Processing`. ### DataKitComponentDeploymentStatus Data Kit Component Deployment Status Represents the status of a component's single click deployment. * `code` (_string_) Status code of the deployment job. **Filter Group:** Small **Available Version:** 61.0 * `message` (_string_) Response message of the deployment job. **Filter Group:** Small **Available Version:** 61.0 ### DataObjectInputRepresentation Data Object Input Input representation for a data object in Data 360. Includes all fields of `CdpObjectBaseInputRepresentation`. * `category` (_string_) Category of the data object. **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `eventDateTimeFieldName` (_string_) Name of the event date and time field. This property is required when the value of the category property is `Engagement`. **Available Version:** 60.0 * `fields` (_array of DataObjectFieldInputRepresentation_) Fields in the data object. **Available Version:** 60.0 * `recordModifiedFieldName` (_string_) Record modified field name. **Available Version:** 60.0 * `type` (_string_) Type of data object. **Available Version:** 60.0 Allowed values: `DataLakeObject`, `DataModelObject`. ### DataLakeFieldInputRepresentation Data Lake Field Input Represents the input for a data lake object (DLO) field. * `dataType` (_string_, required) Data type of the field. **Available Version:** 62.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Unsupported`, `Url`. * `isPrimaryKey` (_boolean_, required) Indicates whether the field is a primary key field (`true`) or not (`false`). **Available Version:** 62.0 * `label` (_string_, required) Label of the field. **Available Version:** 60.0 * `name` (_string_, required) API name of the field. **Available Version:** 60.0 ### DataModelObjectConfigInputRepresentation Data Model Object Config Input Represents the configuration for creating a data model object (DMO) atomically with a data lake object. * `label` (_string_) Display label of the DMO. **Available Version:** 67.0 * `name` (_string_) Name of the DMO. Supply the bare name; the platform auto-appends the `__dlm` suffix to the physical table (for example, `Company_Documents` becomes `Company_Documents__dlm`). **Available Version:** 67.0 ### DataLakeSourceInputRepresentation Data Lake Source Input Represents the data source input for a data lake object. * `directoryAndFilesDetails` (_array of DirectoryAndFilesDetailsInputRepresentation_) Directories and files to ingest, used by the cloud-storage push path (Amazon S3, Google Cloud Storage, or Azure) for multi-folder routing. Each entry names a directory (`dirName`, required and non-blank) and a file (`fileName`). A maximum of five entries is supported. Use `directoryAndFilesDetails` for multi-folder routing, or `importDirectory` with `fileName` for a single directory, but not both in the same request. **Available Version:** 67.0 * `sourceConfig` (_object_) Connector-specific extract configuration for the data source. For an unstructured data lake object (UDLO), set `objectType` to `UNSTRUCTURED_DATA` (and, for Google Drive, `objectName` to `UNSTRUCTURED_DATA`). Other keys vary by connector, for example `driveSelection` and `sync` (Google Drive), `crawlDepth` and `selector` (website), or `injectIssues` and `ProjectKey` (Jira). Discover the available keys for a connector with `GET /ssot/connectors/{connectorType}`. Keep these values in sync with the data stream's top-level `advancedAttributes`; both should contain the same values. **Available Version:** 67.0 Additional properties: `string`. * `sourceId` (_string_) ID of the connection used as the data source. Obtain this value from the connection created or reused through `POST /ssot/connections`, or by listing existing connections with `GET /ssot/connections?connectorType={connectorType}`. **Available Version:** 67.0 * `sourceType` (_string_) Type of the data source. **Available Version:** 67.0 Allowed values: `SfDrive`. ### DataLakeFieldRepresentation Data Lake Field Output Represents the output for a data lake object (DLO) field. Includes all fields of `CdpAssetBaseRepresentation`. * `dataType` (_string_) Data type of the DLO field. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Unsupported`, `Url`. * `isPrimaryKey` (_boolean_) Indicates whether this is the data lake field primary key (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 ### DataObjectRepresentation Data Object Output Data object representation. Includes all fields of `CdpAssetBaseRepresentation`. * `category` (_string_) Category. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `eventDateTimeFieldName` (_string_) Name of the event date and time field. This property is required when the value of the category property is `Engagement`. **Filter Group:** Small **Available Version:** 60.0 * `fields` (_array of DataObjectFieldRepresentation_) List of fields. **Filter Group:** Small **Available Version:** 60.0 * `recordModifiedFieldName` (_string_) Record modified field. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type of data object. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `DataLakeObject`, `DataModelObject`. ### CdpFieldSourceTargetMapInputRepresentation Field Source Target Map Input Represents the input for creating a field source target map. Includes all fields of `CdpObjectBaseInputRepresentation`. * `sourceFieldDeveloperName` (_string_) Source DLO field developer name. **Available Version:** 61.0 * `targetFieldDeveloperName` (_string_) Target DMO field developer name. **Available Version:** 61.0 ### CdpFieldSourceTargetMapRepresentation Field Source Target Map Output Represents a field source target mapping. * `developerName` (_string_) Developer name of the field mapping. **Filter Group:** Small **Available Version:** 61.0 * `sourceFieldDeveloperName` (_string_) Developer name of the source DLO field in the mapping. **Filter Group:** Small **Available Version:** 61.0 * `targetFieldDeveloperName` (_string_) Developer name of the target DMO field in the mapping. **Filter Group:** Small **Available Version:** 61.0 ### FieldSrcTrgtRelationshipRepresentation Field Source Target Relationship Output Represents a field source target relationship between data model objects (DMOs). * `cardinality` (_string_) Cardinality between the fields involved in the relationship. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `ManyToOne`, `OneToOne`. * `creationType` (_string_) Creation type of the relationship. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `CalculatedInsight`, `Curated`, `Custom`, `SegmentMembership`, `Standard`, `System`. * `id` (_string_) ID of the relationship. **Filter Group:** Small **Available Version:** 64.0 * `name` (_string_) Developer name of the relationship. **Filter Group:** Small **Available Version:** 64.0 * `owner` (_string_) Owner of the relationship. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `DataCloud`, `Sobject`. * `sourceField` (_object_) Details about the source field involved in the relationship. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `RelationshipFieldRepresentation`. * `sourceObject` (_object_) Details about the source object involved in the relationship. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `RelationshipObjectRepresentation`. * `status` (_string_) Status of the relationship. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Active`, `Creating`, `DeactivateByUser`, `Deleting`, `Error`, `Inactive`, `Updating`. * `targetField` (_object_) Details about the target field involved in the relationship. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `RelationshipFieldRepresentation`. * `targetObject` (_object_) Details about the target object involved in the relationship. **Filter Group:** Small **Available Version:** 64.0 Includes all fields of `RelationshipObjectRepresentation`. ### FieldSrcTrgtRelationshipInputRepresentation Field Source Target Relationship Input Represents the input to create a field source target relationship between data model objects (DMOs). * `cardinality` (_string_, required) Cardinality between the fields involved in the relationship. **Available Version:** 64.0 Allowed values: `ManyToOne`, `OneToOne`. * `dataSpaceName` (_string_) Name of the data space for the relationship creation. **Available Version:** 64.0 * `relationshipOwner` (_string_) Owner of the relationship. **Available Version:** 64.0 Allowed values: `DataCloud`, `Sobject`. * `sourceFieldName` (_string_, required) Developer name of the source field in the relationship. **Available Version:** 64.0 * `sourceObjectName` (_string_) Developer name of the source object in the relationship. **Available Version:** 64.0 * `targetFieldName` (_string_, required) Developer name of the target field in the relationship. **Available Version:** 64.0 * `targetObjectName` (_string_) Developer name of target object in the relationship. **Available Version:** 64.0 ### DataShareObjectRepresentation Data Share Object Output Represents a data share object. Includes all fields of `CdpAssetBaseRepresentation`. * `names` (_array of string_) List of developer names for the data share objects. Can include data lake objects (DLOs), data model objects (DMOs), and calculated insight objects (CIOs). **Filter Group:** Small **Available Version:** 63.0 ### DataSpaceFilterInputRepresentation Data Space Filter Input Represents the input filter for a data space on a data lake object (DLO). * `conditionGroups` (_array of DataSpaceFilterInputRepresentation_) List of filter groups. **Available Version:** 67.0 * `conditions` (_array of DataSpaceFilterConditionCollectionRepresentation_, required) Conditions for the filter. **Available Version:** 62.0 * `conjunctiveOperator` (_string_, required) Operator of the filter. **Available Version:** 62.0 Allowed values: `AndOperator`, `NoneOperator`, `OrOperator`. * `filterCreationType` (_string_) Type of filter creation type, such as `CUSTOM` or `SYSTEM`. **Available Version:** 66.0 ### DataSpaceMemberInputListRepresentation Data Space Member Input List Represents a list of data space members. * `members` (_array of DataSpaceMemberInputRepresentation_, required) Members of a data space. **Available Version:** 62.0 ### DataSpaceMemberErrorRepresentation Data Space Member Error Output Represents the error state of data space members. * `error` (_object_) Error code and details. **Filter Group:** Small **Available Version:** 62.0 Includes all fields of `CdpErrorRepresentation`. * `name` (_string_) Name of the data space member. **Filter Group:** Small **Available Version:** 62.0 ### DataSpaceFilterRepresentation Data Space Filter Output Represents the data space filter on an object. * `conditionGroups` (_array of DataSpaceFilterRepresentation_) List of children condition groups in the filter. **Filter Group:** Small **Available Version:** 67.0 * `conditions` (_array of DataSpaceFilterConditionRepresentation_) List of conditions in the filter. **Filter Group:** Small **Available Version:** 61.0 * `conjunctiveOperator` (_string_) Operator of the filter. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `AndOperator`, `NoneOperator`, `OrOperator`. ### ConnectorInputRepresentation Connector Input Represents the input details for a connector. * `connectorDetails` (_DataConnectorDetailsConfig | IngestApiConnectorDetailsConfig | CrmConnectorDetailsConfig | SalesforceMarketingCloudConnectorDetailsConfig | StreamingConnectorDetailsConfig_) Details about the connector's configuration. Use the connector details config input object that corresponds to the connector type. For example, use the Data Connector Details Config Input for the `Data Connector` connector type. **Available Version:** 60.0 One of: `DataConnectorDetailsConfig`, `IngestApiConnectorDetailsConfig`, `CrmConnectorDetailsConfig`, `SalesforceMarketingCloudConnectorDetailsConfig`, `StreamingConnectorDetailsConfig`. * `connectorType` (_string_) Type of the connector. For example, `DataConnector`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, or `StreamingApp`. **Available Version:** 60.0 ### ExistingDataLakeObjectInputRepresentation Existing Data Lake Object Input Represents the input for a data stream's existing target data lake object (DLO). * `name` (_string_) Developer name of the existing target DLO. The DLO cannot be used by another data stream. **Available Version:** 62.0 ### DataStreamFieldMappingInputRepresentation Data Stream Field Mapping Input Represents the input for data stream field mapping. * `sourceFieldLabel` (_string_) Label of the source formula field. **Available Version:** 60.0 * `targetFieldName` (_string_) Name of the target formula field. **Available Version:** 60.0 * `targetFieldReturntype` (_string_) Return type of the target formula field. **Available Version:** 60.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. * `transformationFormula` (_string_) Transformation formula for the formula field **Available Version:** 60.0 ### RefreshConfigInputRepresentation Refresh Config Input Represents the input for a data stream refresh configuration. * `additionalAttributes` (_object_) Additional attributes for the data stream refresh configuration: * `shouldFetchImmediately`: Indicates whether the first refresh runs immediately on create (`true`) or waits for the first scheduled interval (`false`). This attribute mirrors the top-level `fetchImmediately` field. For an unstructured data lake object (UDLO) on the scheduled external-connector path (Google Drive, website, Jira, or SharePoint), request an immediate first refresh to ingest as soon as the data stream is created. Immediate fetch is honored on the cloud-storage and external-connector paths, and ignored on the UploadedFiles path, which ingests on file upload. * `shouldTreatMissingFilesAsFailures`: Indicates whether a missing source file fails the refresh (`true`) or is skipped (`false`). * `doesPeriodicFullRefresh`: Indicates whether the data stream periodically performs a full refresh (`true`) or not (`false`). **Available Version:** 60.0 Additional properties: `string`. * `fetchImmediately` (_boolean_) Indicates whether immediate fetch is enabled (`true`) or not (`false`). **Available Version:** 65.0 * `frequency` (_array of DataStreamFrequencyInputRepresentation_) Frequency for the data stream refresh. **Available Version:** 60.0 * `isAccelerationEnabled` (_boolean_) Indicates whether acceleration is enabled for the data stream refresh (`true`) or not (`false`). **Available Version:** 62.0 * `refreshMode` (_string_) Refresh mode for the data stream. There's no `NONE` value; to configure a data stream with no scheduled refresh, use the `TOTAL_REPLACE` refresh mode with the `frequency.frequencyType` value `None`. **Available Version:** 60.0 Allowed values: `TOTAL_REPLACE`, `UPSERT`, `INCREMENTAL`, `REPLACE`, `NEAR_REAL_TIME_INCREMENTAL`, `PARTIAL_UPDATE`. ### DataStreamSourceFieldInputRepresentation Data Stream Source Field Input Represents the input for a data stream source field. * `dataType` (_string_) Data type of the data source field. **Available Version:** 60.0 * `format` (_string_) Format of the data source field. **Available Version:** 60.0 * `name` (_string_) Name of the field in the data source. * For CRM objects, use the API name of the field. * For CSV files, use the name of the column in the header row. * For apps, use the name of the JSON (or other format) object field exposed by the app. **Available Version:** 60.0 ### ConnectorRepresentation Connector Output Represents a Data 360 connector. * `connectorDetails` (_DataConnectorDetailsRepresentation | IngestionApiConnectorDetailsRepresentation | CrmConnectorDetailsRepresentation | SalesforceMarketingCloudConnectorDetailsRepresentation | StreamingConnectorDetailsRepresentation_) Details about the Data 360 connector. The endpoint returns the connector details output object that corresponds to the connector type. For example, the Data Connector Details Output is returned for the `Data Connector` connector type. **Filter Group:** Small **Available Version:** 60.0 One of: `DataConnectorDetailsRepresentation`, `IngestionApiConnectorDetailsRepresentation`, `CrmConnectorDetailsRepresentation`, `SalesforceMarketingCloudConnectorDetailsRepresentation`, `StreamingConnectorDetailsRepresentation`. * `connectorType` (_string_) Type of the connector. For example, `DataConnector`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, or `StreamingApp`. **Filter Group:** Small **Available Version:** 60.0 ### DataStreamFieldMappingRepresentation Data Stream Field Mapping Output Represents the field mapping for a data stream. * `formula` (_string_) Field mapping formula for the data stream. **Filter Group:** Small **Available Version:** 60.0 * `sourceFieldName` (_string_) Field name of the data stream mapping source. **Filter Group:** Small **Available Version:** 60.0 * `targetFieldName` (_string_) Field name of the data stream mapping target. **Filter Group:** Small **Available Version:** 60.0 ### RefreshConfigRepresentation Data Stream Refresh Config Output Refresh configuration of the data stream. * `frequency` (_object_) Frequency of the refresh configuration. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataStreamFrequencyRepresentation`. * `hasHeaders` (_boolean_) Indicates whether the refresh configuration has headers (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `isAccelerationEnabled` (_boolean_) Indicates whether acceleration is enabled for the corresponding data lake object (DLO) (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `refreshMode` (_string_) Refresh mode of the refresh configuration. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `TOTAL_REPLACE`, `UPSERT`, `INCREMENTAL`, `REPLACE`, `NEAR_REAL_TIME_INCREMENTAL`, `PARTIAL_UPDATE`. * `shouldFetchImmediately` (_boolean_) Indicates whether the refresh config should fetch immediately (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `shouldTreatMissingFilesAsFailures` (_boolean_) Indicates whether the refresh config should treat missing files as failures (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 ### DataStreamSourceFieldRepresentation Data Stream Source Field Output Represents a data stream source field. * `datatype` (_string_) Data type of the data stream source field. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Date`, `DateTime`, `Number`, `Text`. * `format` (_string_) Format of the data stream source field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the data stream source field. **Filter Group:** Small **Available Version:** 60.0 ### ConnectorPatchInputRepresentation Connector Patch Input Represents patch input for a connector. * `connectorPatchDetailsConfig` (_object_) Details about the connector's configuration. **Available Version:** 60.0 Includes all fields of `ConnectorPatchDetailsConfig`. * `connectorType` (_string_) Type of connector used for deploying the data stream. For example, `StreamingApp`, `SalesforceDotCom`, `IngestApi`, or `DataConnector`. **Available Version:** 60.0 ### FailedResourceCollectionRepresentation Failed Resource Collection Output Represents a collection of failed resources. * `error` (_object_) Error details for the resource. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `CdpErrorRepresentation`. * `id` (_string_) ID of the resource. **Filter Group:** Small **Available Version:** 66.0 * `name` (_string_) Name of the resource. **Filter Group:** Small **Available Version:** 66.0 ### DcSqlDataTransformDefinitionInputRepresentation Dc Sql Data Transform Definition Input Represents the input definition for Dc Sql data transforms. Includes all fields of `DataTransformDefinitionInputRepresentation`. * `manifest` (_object_) Manifest of the DC SQL data transform. **Available Version:** 63.0 Includes all fields of `DcSqlDataTransformManifestInputRepresentation`. ### StlDataTransformDefinitionInputRepresentation Stl Data Transform Definition Input Defines a batch data transform during a creation (post) request. Includes all fields of `DataTransformDefinitionInputRepresentation`. * `nodes` (_object_) Map of transform nodes defined for the batch data transform. **Filter Group:** Small **Available Version:** 62.0 Includes all fields of `DataTransformNodeInputRepresentation`. * `ui` (_object_) UI object info required for rendering in the interactive data transform editor. **Filter Group:** Small **Available Version:** 62.0 ### SqlDataTransformDefinitionInputRepresentation Sql Data Transform Definition Input Defines a streaming data transform during a creation (post) request. Includes all fields of `DataTransformDefinitionInputRepresentation`. * `expression` (_string_) SQL expression for the streaming transform. **Available Version:** 60.0 * `targetDlo` (_string_) Target data lake object (DLO) for the streaming transform. **Filter Group:** Small **Available Version:** 60.0 * `targetDmo` (_string_) Target data model object (DMO) for the streaming transform. **Filter Group:** Small **Available Version:** 60.0 ### DataTransformDefinitionInputRepresentation Data Transform Definition Input * `label` (_string_) Label of the transform definition. **Available Version:** 63.0 * `name` (_string_) Name of the transform definition. **Available Version:** 63.0 * `outputDataObjects` (_array of DataObjectInputRepresentation_) Information about the objects into which the data transform writes the transformed data. **Available Version:** 60.0 * `schedule` (_object_) Schedule for running the transform. Applies to transforms that use the definitions array structure (which can contain one or more definitions). Does not apply to legacy transforms with a single definition field. **Available Version:** 67.0 Includes all fields of `CdpScheduleInputRepresentation`. * `type` (_string_, required) Type of definition. **Available Version:** 60.0 Allowed values: `DbtHidden`, `DcSql`, `Sql`, `SqlHidden`, `Stl`, `StlHidden`. * `version` (_string_, required) Version of the transform. **Available Version:** 60.0 ### BatchActionRepresentation Batch Action Output Batch actions. * `cancelAction` (_string_) URL to cancel the action. **Filter Group:** Small **Available Version:** 60.0 * `refreshStatusAction` (_string_) URL to refresh the status of the action. **Filter Group:** Small **Available Version:** 60.0 * `retryAction` (_string_) URL to retry the action. **Filter Group:** Small **Available Version:** 60.0 * `runAction` (_string_) URL to run the action. **Filter Group:** Small **Available Version:** 60.0 ### DcSqlDataTransformDefinitionRepresentation Dc Sql Data Transform Definition Output Represents the definition of a DC SQL data transform. Includes all fields of `DataTransformDefinitionRepresentation`. * `manifest` (_object_) Manifest of the DC SQL data transform. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `DcSqlDataTransformManifestRepresentation`. ### StlDataTransformDefinitionRepresentation Stl Data Transform Definition Output Represents a base64atch data transform definition. Includes all fields of `DataTransformDefinitionRepresentation`. * `nodes` (_object_) Transform nodes defined for the STL data transform. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DataTransformNodeRepresentation`. * `ui` (_object_) STL data transform UI metadata. **Filter Group:** Small **Available Version:** 60.0 ### SqlDataTransformDefinitionRepresentation Sql Data Transform Defintion Output Represents a streaming data transform definition. Includes all fields of `DataTransformDefinitionRepresentation`. * `expression` (_string_) SQL expression for the data transform. **Filter Group:** Small **Available Version:** 60.0 * `targetDlo` (_string_) Name of the target data lake object (DLO). **Filter Group:** Small **Available Version:** 60.0 ### DataTransformDefinitionRepresentation Base Data Transform Output Represents a data transform node. * `label` (_string_) Label of the data transform definition. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the data transform definition. **Filter Group:** Small **Available Version:** 60.0 * `outputDataObjects` (_array of DataObjectRepresentation_) Information about the objects into which the data transform writes the transformed data. **Filter Group:** Small **Available Version:** 60.0 * `schedule` (_object_) Schedule for running the transform. Applies to transforms that use the definitions array structure (which can contain one or more definitions). Does not apply to legacy transforms with a single definition field. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `CdpScheduleRepresentation`. * `type` (_string_) Type of the data transform definition. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `DbtHidden`, `DcSql`, `Sql`, `SqlHidden`, `Stl`, `StlHidden`. * `version` (_string_) Version of the data transform. **Filter Group:** Small **Available Version:** 60.0 ### CdpErrorRepresentation Error Output Represents an error response. * `errorCode` (_string_) Error code. **Filter Group:** Big **Available Version:** 57.0 * `errorMessage` (_string_) Message stating the reason for the error, if any. **Filter Group:** Big **Available Version:** 57.0 ### ScheduleRepresentation Schedule Representation Output Represents a save node. * `schedule` (_string_) Schedule of the data transform. **Filter Group:** Small **Available Version:** 60.0 * `url` (_string_) URL of the data transform schedule. **Filter Group:** Small **Available Version:** 60.0 ### BatchDataTransformRunHistoryRepresentation Batch Data Transform Run History Output Represents the run history of a batch data transform. Includes all fields of `DataTransformRunHistoryBaseRepresentation`. * `outputStatus` (_array of RunHistoryOutputProgressRepresentation_) Output status of the data transform run. **Filter Group:** Small **Available Version:** 62.0 * `runMode` (_string_) Mode used for the data transform run. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Full`, `Incremental`. * `runModeParameters` (_array of string_) Additional parameters related to the run mode. **Filter Group:** Small **Available Version:** 62.0 * `runModeReason` (_string_) Reason why the data transform ran in the specified mode. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `BtDefinitionChanged`, `DmoMappingsChanged`, `EvaluationError`, `FullSyncInSrcObject`, `FunctionsRequireFullRun`, `IncrementalModeDisabled`, `IrregularDmoPk`, `JoinManyIncrSources`, `MaxRetriesFailed`, `NoRecentFullRun`, `NodesRequireFullRun`, `NotAScheduledRun`, `RetryAfterPartialFailure`, `RunAfterPartialResult`, `TooManyChangesInSrcObject`, `UnsupportedObjectType`, `UnsupportedWriteModes`. ### StreamingDataTransformRunHistoryRepresentation Streaming Data Transform Run History Output Represents the run history of a streaming data transform. Includes all fields of `DataTransformRunHistoryBaseRepresentation`. * `addedRows` (_number (int64)_) Number of rows added during the data transform run. **Filter Group:** Small **Available Version:** 62.0 * `deletedRows` (_number (int64)_) Number of rows deleted during the data transform run. **Filter Group:** Small **Available Version:** 62.0 * `failedRows` (_number (int64)_) Number of rows that failed processing during the data transform run. **Filter Group:** Small **Available Version:** 62.0 * `updatedRows` (_number (int64)_) Number of rows updated during the data transform run. **Filter Group:** Small **Available Version:** 62.0 ### CdpTimeInputRepresentation Time Input Time input source for when to run the schedule. * `hour` (_integer_, required) Hour when the schedule should run. **Available Version:** 60.0 * `minute` (_integer_, required) Minute in the hour when the schedule should run. **Available Version:** 60.0 * `timeZone` (_string_, required) Time zone of the schedule. **Available Version:** 60.0 ### TransformValidationIssueRepresentation Transform Validation Issue Output Data transform validation issue representation. * `definitionName` (_string_) Name of the validation definition issue. **Filter Group:** Small **Available Version:** 65.0 * `errorCode` (_string_) Error code. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `DataTransformLimitExceeded`, `DloNameDoesNotExist`, `DmoOutputValidationError`, `InternalServiceError`, `InvalidDataTransform`, `InvalidDataTransformCapability`, `InvalidDataTransformDataObjects`, `InvalidDataTransformDefMapping`, `InvalidDataTransformDefinition`, `InvalidDataTransformRequest`, `InvalidDataTransformTag`, `InvalidInputPayload`, `InvalidTargetDLO`, `InvalidTargetDMO`, `NameValidationError`, `RestrictedDLO`, `SourceDloNotFound`, `SqlExpressionIsNull`, `StreamingTransformCreateForbidden`, `TagsValidationError`, `TargetDLOIsRebuilding`, `TargetDloNotFound`, `TargetDmoNotFound`, `TargetObjectNameNull`, `TypeValidationError`. * `errorMessage` (_string_) Error message. **Filter Group:** Small **Available Version:** 62.0 * `errorSeverity` (_string_) Error severity. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Error`, `Fatal`, `Warning`. * `type` (_string_) Type of validation issue. **Filter Group:** Small **Available Version:** 65.0 Allowed values: `Definition`, `Transform`. ### IdpGenerateSchemaFileInputRepresentation Document AI Generate Schema File Input This type contains the fields required to generate a schema from a file. * `additionalParams` (_object_) Additional parameters for file processing, for example, `sheetName` for Excel and Google Sheets. **Available Version:** 67.0 Includes all fields of `IdpFileAdditionalParamsInputRepresentation`. * `data` (_string_) Base64-encoded content of the file. The actual file data in base64 format. **Available Version:** 63.0 * `fileId` (_string_) Either a Salesforce file Id or a URI to SF Drive. **Available Version:** 63.0 * `mimeType` (_string_) The file type. **Available Version:** 63.0 ### IdpSchemaDetectionInnerRepresentation Idp Schema Detection Inner Output Represents the data in IDP schema detection results. * `matchingFieldsInSchema` (_integer_) Matching number of fields in the schema. Only returned for the `Single` schema detection mode. **Filter Group:** Small **Available Version:** 67.0 * `matchingScore` (_number (double)_) Matching score for the schema with the requested document. Only returned for the `Single` schema detection mode. **Filter Group:** Small **Available Version:** 67.0 * `pages` (_array of IdpSchemaDetectionPagesRepresentation_) Page details and the matching score for the schema with the requested page. Only returned for the `Multi` schema detection mode. **Filter Group:** Small **Available Version:** 67.0 * `schemaConfiguration` (_string_) Name of the schema configuration. **Filter Group:** Small **Available Version:** 67.0 * `totalFieldsInSchema` (_integer_) Total number of fields in the schema. Only returned for the `Single` schema detection mode. **Filter Group:** Small **Available Version:** 67.0 ### IdpExtractedFileDataRepresenation Document AI Extracted File Data Output Represents extracted file data. * `data` (_string_) Extracted JSON data. The JSON includes metadata for each extracted field, such as `type`, `value`, and `confidence_score`. The `confidence_score` value ranges from `0` to `1.0`. **Filter Group:** Small **Available Version:** 63.0 * `error` (_string_) Error message if the data extraction fails. **Filter Group:** Small **Available Version:** 63.0 ### IdpConfigurationRepresentation Document AI Configuration Output Represents a Document AI configuration. Includes all fields of `IdpConfigurationBaseRepresentation`. ### IdpConfigExtractedDloInputRepresentation Document AI Config Extracted DLO Input This type contains the fields required to configure DLO extraction settings. * `fields` (_array of IdpConfigExtractedDloFieldInputRepresentation_, required) List of extracted DLO fields. **Available Version:** 63.0 * `mappingRules` (_object_) Mapping rules for extracted data. Defines how extracted data should be mapped to target fields. **Available Version:** 63.0 ### IdpFileConfigInputRepresentation Document AI File Config Input This type contains the fields required to configure file processing settings. * `fileTypes` (_array of string_, required) List of allowed file formats for processing. Specifies which file types can be processed by this configuration. **Available Version:** 63.0 ### IdpConfigurationBaseRepresentation Idp Configuration Base Output Represents the Document AI configuration base output. Includes all fields of `CdpAssetBaseRepresentation`. * `activationStatus` (_string_) The configuration activation status. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Activated`, `Deactivated`. * `configMetadata` (_object_) A collection of custom key-value pairs. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `string`. * `dataspace` (_object_) Data space of the configuration. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `description` (_string_) Description of the configuration. **Filter Group:** Small **Available Version:** 63.0 * `lastRunOn` (_string_) The last unstructured data-extraction job run. **Filter Group:** Small **Available Version:** 63.0 * `mlModel` (_string_) The ML model used to extract the unstructured data. **Filter Group:** Small **Available Version:** 63.0 * `runtimeStatus` (_string_) The status of the last off-core unstructured data-extraction job run. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Aborted`, `Failed`, `InProgress`, `NotStarted`, `Pending`, `Ready`, `Submitted`, `Success`. * `sourceDmo` (_object_) The unstructured DMO used as the input for the data extraction process. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `status` (_string_) The status of the latest configuration version that's been synced off-core. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Error`, `NotSynced`, `Synced`, `Syncing`. * `version` (_string_) The current version of the configuration. This is incremented automatically with each edit. **Filter Group:** Small **Available Version:** 63.0 ### IdpConfigExtractedDloRepresentation Document AI Config Extracted DLO Output This type defines how data should be extracted and mapped from documents. * `dlo` (_object_) The output DLO. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `fields` (_array of IdpConfigExtractedDloFieldRepresentation_) List of extracted DLO fields. **Filter Group:** Small **Available Version:** 63.0 * `schemaName` (_string_) The JSON array property name that maps to this DLO. The value is `null` for the root DLO. **Filter Group:** Small **Available Version:** 63.0 ### IdpFileConfigRepresentation Document AI File Config Output Represents the file types supported by the Document AI process. * `allowedFileTypes` (_array of string_) List of file formats that are supported by the Document AI process. **Filter Group:** Small **Available Version:** 63.0 ### IdpContentTypeRepresentation Document AI Content Type Output This type defines the properties of a supported document content type. * `label` (_string_) Label of the file type. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of file. **Filter Group:** Small **Available Version:** 63.0 ### IdpSupportedModelRepresentation Document AI Supported Model Output This type defines the properties of a supported Document AI processing model. * `id` (_string_) Unique identifier for the model. This ID is used to reference the model in other API calls. **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_) Label of the model. **Filter Group:** Small **Available Version:** 63.0 * `provider` (_string_) Provider of the model, such as `Open AI`. **Filter Group:** Small **Available Version:** 63.0 ### CdpIdentityResolutionMatchRuleOutput Identity Resolution Match Rule Output Represents match rule criteria for an identity resolution ruleset. * `criteria` (_array of CdpIdentityResolutionMatchCriterionOutput_) Object and field the match rule applies to and the match method applied. **Filter Group:** Small **Available Version:** 57.0 * `label` (_string_) User friendly name for the identity resolution match rules. **Filter Group:** Small **Available Version:** 57. ### CdpIdentityResolutionReconciliationRuleOutput Identity Resolution Reconciliation Rule Output Represents a reconciliation rule for an object of an identity resolution ruleset. * `entityName` (_string_) API name of the data model object the reconciliation rule applies to. **Filter Group:** Small **Available Version:** 57.0 * `fields` (_array of CdpIdentityResolutionReconciliationFieldRuleOutput_) Field-specific reconciliation rules that override this default rule for the specified field. **Filter Group:** Small **Available Version:** 57.0 * `linkDmoName` (_string_) API name of the unified link object created by the identity resolution process. **Filter Group:** Small **Available Version:** 57.0 * `ruleType` (_string_) Default reconciliation rule applied to fields in the object the reconciliation rule applies to. **Filter Group:** Small **Available Version:** 57.0 Allowed values: `LastUpdated`, `MostFrequent`, `SourceSequence`. * `shouldIgnoreEmptyValue` (_boolean_) Specifies whether to ignore an empty value (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 57.0 * `sources` (_array of CdpIdentityResolutionReconciliationSourceOutput_) If `ruleType` is `SourceSequence`, a list of data sources in priority order. **Filter Group:** Small **Available Version:** 57.0 * `unifiedDmoName` (_string_) API name of the unified data model object created by the identity resolution process. **Filter Group:** Small **Available Version:** 57.0 ### KnowledgeSourceOutputRepresentation Knowledge Source Output Represents a knowledge source. * `files` (_array of KnowledgeSourceFileOutputRepresentation_) List of files in the knowledge source. **Filter Group:** Small **Available Version:** 65.0 * `id` (_string_) ID of the knowledge source. **Filter Group:** Small **Available Version:** 65.0 * `label` (_string_) Label of the knowledge source. **Filter Group:** Small **Available Version:** 65.0 * `searchIndex` (_string_) Search index of the knowledge source. **Filter Group:** Small **Available Version:** 65.0 * `searchIndexDeveloperName` (_string_) Developer name of the search index. **Filter Group:** Small **Available Version:** 65.0 * `searchType` (_string_) Type of the search index. **Filter Group:** Small **Available Version:** 65.0 * `sourceType` (_string_) Type of the knowledge source. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSourceFileOutputRepresentation Knowledge Source File Output Represents a knowledge source file. * `fileName` (_string_) Name of the file. **Filter Group:** Small **Available Version:** 65.0 * `filePath` (_string_) Path of the file. **Filter Group:** Small **Available Version:** 65.0 * `fileRecordId` (_string_) Record ID of the file. **Filter Group:** Small **Available Version:** 65.0 * `fileStatus` (_string_) Status of the file. **Filter Group:** Small **Available Version:** 65.0 * `fileType` (_string_) Type of the file. **Filter Group:** Small **Available Version:** 65.0 * `jobId` (_string_) Job ID. **Filter Group:** Small **Available Version:** 65.0 * `offCoreJobId` (_string_) Off-core job ID from the search index API call. **Filter Group:** Small **Available Version:** 65.0 ### KnowledgeSpaceDeepResearchPlanOutputRepresentation Knowledge Space Deep Research Plan Output Represents a deep research execution plan. * `estimatedDurationMinutes` (_integer_) Estimated duration of the research job, in minutes. **Filter Group:** Small **Available Version:** 67.0 * `steps` (_array of KnowledgeSpaceDeepResearchPlanStepOutputRepresentation_) List of research plan steps. **Filter Group:** Small **Available Version:** 67.0 * `title` (_string_) Plan title describing the research approach. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchPlanPatchPlanInputRepresentation Knowledge Space Deep Research Plan Patch Plan Input Represents the plan payload for deep research plan updates. Includes all fields of `CdpAssetBaseInputRepresentation`. * `steps` (_array of KnowledgeSpaceDeepResearchPlanStepInputRepresentation_) List of research plan steps to execute. **Available Version:** 67.0 ### KnowledgeSpaceConversationMsgOutputRepresentation Knowledge Space Conversation Msg Output Represents a message in a knowledge space conversation. * `citedReferences` (_array of string_) List of cited references. **Filter Group:** Small **Available Version:** 65.0 * `feedbackId` (_string_) Feedback ID for the message. **Filter Group:** Small **Available Version:** 65.0 * `id` (_string_) Unique identifier of the message. **Filter Group:** Small **Available Version:** 65.0 * `isContentSafe` (_boolean_) Indicates whether the content is safe (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 65.0 * `message` (_string_) Message content for the InformResponseMessage type. **Filter Group:** Small **Available Version:** 65.0 * `messageType` (_string_) Type of the message. **Filter Group:** Small **Available Version:** 65.0 * `sequenceId` (_integer_) Sequence ID of the message. **Filter Group:** Small **Available Version:** 65.0 * `text` (_string_) Text content of the message. **Filter Group:** Small **Available Version:** 65.0 * `timestamp` (_integer (int64)_) Timestamp of the message. **Filter Group:** Small **Available Version:** 65.0 ### MlImprovementDirectiveRepresentation ML Improvement Directive Output Represents recommended actions and insights for improving an ML model. * `directiveKey` (_string_) Directive key for the ML model. **Filter Group:** Small **Available Version:** 61.0 * `previewText` (_string_) Preview text for the ML model. **Filter Group:** Small **Available Version:** 61.0 ### MlDataAlertDataBaseRepresentation ML Data Alert Data Base Output Represents the base class for metadata and shared fields used across Data Alert objects of the ML model. ### CdpMlCustomizableFieldRepresentation ML Customizable Field Output Represents an ML customizable field. * `field` (_object_) Customizable field. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpMlModelInputFieldBaseRepresentation`. * `type` (_string_) Customizable field type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `ActionableVariable`, `TopFactor`. ### CdpMlFoundationalModelRepresentation ML Foundational Model Output Represents an ML foundational model. * `foundationalModelName` (_string_) Foundational model name, for example `OpenAIGPT35Turbo_03_01`, which can uniquely identify a foundational model within a given namespace. **Filter Group:** Small **Available Version:** 59.0 * `internalVersionNumber` (_integer_) Internal version number to track the minor version order. **Filter Group:** Small **Available Version:** 59.0 * `majorVersionName` (_string_) Major version name, for example `OpenAIGPT35Turbo`. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `AnthropicClaudeInstant`, `AzureOpenAIGPT35Turbo`, `AzureOpenAIGPT35Turbo_16k`, `AzureOpenAIGPT41`, `AzureOpenAIGPT41Mini`, `AzureOpenAIGPT41Nano`, `AzureOpenAIGPT4Omni`, `AzureOpenAIGPT4OmniMini`, `AzureOpenAIGPT4Turbo`, `AzureOpenAITextEmbeddingAda_002`, `BedrockAnthropicClaude35Sonnet`, `BedrockAnthropicClaude35SonnetV2`, `BedrockAnthropicClaude37Sonnet`, `BedrockAnthropicClaude3Haiku`, `BedrockAnthropicClaude3Opus`, `BedrockAnthropicClaude3Sonnet`, `BedrockAnthropicClaude4Sonnet`, `BedrockCohereCommandLightTextV14`, `BedrockCohereCommandTextV14`, `BedrockLlama4Maverick`, `BedrockMistral7BInstructV0_2`, `BedrockMistral8x7BInstructV0_1`, `BedrockMistralLargeV1`, `EinsteinApexGuruMultiTasker`, `EinsteinDeepSeekR1`, `EinsteinFlashTopic`, `EinsteinLlama4Scout`, `EinsteinTableauGPT`, `EinsteinTextBaseV2`, `EinsteinTextEval`, `EinsteinTextSum`, `Einstein_AbstractiveSummarization_V1`, `Einstein_Clip_Vit_B_32_Multilingual_V1`, `Einstein_E5_Base`, `Einstein_E5_Large`, `Einstein_E5_Large_V2`, `Einstein_E5_Multilingual`, `Einstein_SFR_Embedding_Mistral`, `Einstein_Segmentation_V3`, `Einstein_Wespeaker_Voxceleb_Resnet34_Lm`, `Einstein_Whisper_Large_V3`, `Eleven_Turbo_V2`, `GenericGPT35Turbo`, `GenericGPT35TurboInstruct`, `GenericGPT35Turbo_16k`, `GenericGPT4`, `GenericGPT41`, `GenericGPT41Mini`, `GenericGPT4Omni`, `GenericGPT4OmniMini`, `GenericGPT4Turbo`, `GenericGPT4_32k`, `GenericTextDaVinci002`, `GenericTextDaVinci003`, `GenericTextEmbeddingAda_002`, `Nova_2_PhoneCall`, `OpenAIGPT35Turbo`, `OpenAIGPT35TurboInstruct`, `OpenAIGPT35Turbo_16k`, `OpenAIGPT4`, `OpenAIGPT41`, `OpenAIGPT41Mini`, `OpenAIGPT41Nano`, `OpenAIGPT4Omni`, `OpenAIGPT4OmniMini`, `OpenAIGPT4Turbo`, `OpenAIGPT4_32k`, `OpenAITextDaVinci002`, `OpenAITextDaVinci003`, `OpenAITextEmbedding3_Large`, `OpenAITextEmbedding3_Small`, `OpenAITextEmbeddingAda_002`, `OpenConnector`, `Salesforce_Embedding_2_R`, `VertexAIGemini20Flash001`, `VertexAIGemini20FlashLite001`, `VertexAIGemini25Flash001`, `VertexAIGeminiEmbed001`, `VertexAIGeminiPro10_002`, `VertexAIGeminiPro15`, `VertexAIGeminiPro25`, `WhisperBaseEn_4_27`, `WhisperBase_4_27`. * `minorVersionName` (_string_) Minor version name, for example `0301`. If not present, this model is always referring to the latest minor version. **Filter Group:** Small **Available Version:** 59.0 * `modelIdentifier` (_string_) Model identifier (supported by LLM Gateway). **Filter Group:** Small **Available Version:** 59.0 * `modelProviderName` (_string_) Model provider (supported by LLM Gateway). **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Anthropic`, `AzureOpenAI`, `Bedrock`, `Databricks`, `Generic`, `InternalEmbedding`, `OpenAI`, `OpenConnector`, `SageMaker`, `Salesforce`, `VertexAI`. ### CdpMlModelInputFieldBaseRepresentation ML Model Input Field Base Input Represents a base ML model input field. Includes all fields of `CdpMlModelFieldBaseRepresentation`. * `isDisparateImpact` (_boolean_) Whether this field is a disparate impact field. **Filter Group:** Small **Available Version:** 61.0 * `isPartitionField` (_boolean_) Whether this field is used for partition. **Filter Group:** Small **Available Version:** 61.0 * `isSensitive` (_boolean_) Whether this field is a sensitive field. **Filter Group:** Small **Available Version:** 61.0 ### MlModelInputTypeRepresentation ML Model Input Type Output Represents the input type for a machine learning model. Discriminator: `type` selects the concrete type. * `description` (_string_) Description of the input type. **Filter Group:** Small **Available Version:** 62.0 * `isDefault` (_boolean_) Indicates whether the input type is the default (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the input type. **Filter Group:** Small **Available Version:** 62.0 * `maxDocuments` (_integer_) Maximum document limit for the input type. **Filter Group:** Small **Available Version:** 64.0 * `maxFileSizeMB` (_integer_) Maximum file size limit in MB for the input type. **Filter Group:** Small **Available Version:** 62.0 * `maxImages` (_integer_) Maximum images for the input type. **Filter Group:** Small **Available Version:** 62.0 * `maxInputToken` (_integer_) Maximum input token for the input type. **Filter Group:** Small **Available Version:** 62.0 * `maxPages` (_integer_) Maximum pages for the input type. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Name of the input type. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `ApplicationPdf`, `Float`, `ImageJpeg`, `ImagePng`, `Json`, `Text`. * `value` (_string_) Value of the input type. **Filter Group:** Small **Available Version:** 62.0 ### CdpMlModelOutputFieldRepresentation ML Model Output Field Output Represents an ML model output field. Includes all fields of `CdpMlModelFieldBaseRepresentation`. ### MlModelOutputTypeRepresentation ML Model Output Type Output Represents the output type for a machine learning model. Discriminator: `type` selects the concrete type. * `description` (_string_) Description of the output type. **Filter Group:** Small **Available Version:** 62.0 * `isDefault` (_boolean_) Indicates whether the output type is the default (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the output type. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Name of the output type. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `ApplicationPdf`, `Float`, `ImageJpeg`, `ImagePng`, `Json`, `Text`. * `value` (_string_) Value of the output type. **Filter Group:** Small **Available Version:** 62.0 ### CdpMlModelParameterOverrideBaseRepresentation ML Model Parameter Override Base Output Represents a base ML model parameter override. Discriminator: `type` selects the concrete type. * `parameterName` (_string_) Parameter name. **Filter Group:** Small **Available Version:** 61.0 * `type` (_string_) Parameter type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Continuous`, `Discrete`. ### CdpMlModelParameterDefinitionBaseRepresentation ML Model Parameter Definition Base Output Represents a base ML model parameter. Discriminator: `type` selects the concrete type. * `applicableCapabilities` (_array of string_) The generative model capabilities this parameter is applicable to. **Filter Group:** Small **Available Version:** 61.0 Items: Allowed values: `BinaryClassification`, `ChatCompletion`, `Completion`, `Embedding`, `Generic`, `MulticlassClassification`, `Regression`. * `description` (_string_) Parameter description. **Filter Group:** Small **Available Version:** 61.0 * `overridable` (_boolean_) Whether or not you can override this parameter. **Filter Group:** Small **Available Version:** 61.0 * `parameterName` (_string_) Parameter name. **Filter Group:** Small **Available Version:** 61.0 * `type` (_string_) Parameter type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Continuous - a variable that can take on a value within a given range and is typically associated with measurements and quantities.`, `Discrete - a variable that can take on only a finite or countable number of distinct values. These parameters are used in regression models, where the outcome is categorical, for example, a success or failure.`. ### MlConnectorEndpointRepresentation ML Connector Endpoint Output Representation for an ML connector endpoint. * `authHeader` (_string_) The authentication header * `authentication` (_string_) Connector endpoint authentication type - jwt or authkey based Allowed values: `ApiKey`, `AwsAccessKey`, `GoogleSac`, `Jwt`, `Oauth`. * `connectorType` (_string_) The connector type Allowed values: `Anthropic`, `AzureOpenAI`, `Bedrock`, `Databricks`, `Generic`, `InternalEmbedding`, `OpenAI`, `OpenConnector`, `SageMaker`, `Salesforce`, `VertexAI`. * `endpointUrl` (_string_) URL of the connect endpoint * `foundationalModelName` (_string_) Foundational model name * `label` (_string_) label * `name` (_string_) name * `namedCredential` (_CdpAssetReferenceRepresentation_) * `privateKeyId` (_string_) The private key ID * `region` (_string_) The region for aws auth * `registeredModelApiName` (_string_) Registered Model API name on the Provider * `requestFormat` (_string_) Connector endpoint request format Allowed values: `Csv`, `DataFrameRecords`, `DataFrameSplit`, `Json`, `JsonDense`, `NumpyInput`, `NumpyInstance`. * `responseFormat` (_string_) Connector endpoint response format Allowed values: `Csv`, `DataFrameRecords`, `DataFrameSplit`, `Json`, `JsonDense`, `NumpyInput`, `NumpyInstance`. * `serviceAccountEmail` (_string_) The service account email ### CdpMlAggregatePredictionRepresentation ML Aggregate Prediction Output Represents an ML aggregate prediction. * `factors` (_array of CdpMlAggregatePredictConditionRepresentation_) Top factors associated with this aggregate prediction. **Filter Group:** Small **Available Version:** 61.0 * `prescriptions` (_array of CdpMlAggregatePredictConditionRepresentation_) Prescriptions associated with this aggregate prediction. **Filter Group:** Small **Available Version:** 61.0 * `status` (_string_) Status of aggregate prediction. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Error`, `Success`. * `type` (_string_) Type of aggregate prediction. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Average`, `Median`, `Sum`. * `value` (_number (double)_) Aggregate prediction value. **Filter Group:** Small **Available Version:** 61.0 ### CdpMlPredictionBaseRepresentation ML Prediction Base Output Base representation for a prediction result. * `status` (_string_) Prediction status. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Error`, `Success`. ### CdpMlPredictSettingsRepresentation ML Predict Settings Output Represents ML prediction settings. * `aggregateFunctions` (_array of string_) Reserved for future use. **Filter Group:** Small **Available Version:** 61.0 * `maxPrescriptions` (_integer_) Maximum number of recommendations. The default value is `-1` (unlimited), and the allowed range is `-1` through `200`. **Filter Group:** Small **Available Version:** 61.0 * `maxTopFactors` (_integer_) Maximum number of top factors. The default value is `0`, and the allowed range is `0` through `3`. **Filter Group:** Small **Available Version:** 61.0 * `prescriptionImpactPercentage` (_integer_) Impact percentage of the prescription. Default is 0. **Available Version:** 61.0 ### MlPredictionJobDefPredictionsConfigInputRepresentation Ml Prediction Job Def Predictions Config Input Represents the input configuration for predictions generated by a model. * `description` (_string_) Description of the output data model object (DMO). **Available Version:** 59.0 * `objectLabel` (_string_) Object label of the output DMO. **Available Version:** 59.0 * `objectName` (_string_) API name of the output DMO. **Available Version:** 59.0 ### MlPredictionJobDefPredictionsConfigRepresentation Ml Prediction Job Def Predictions Config Output Represents the configuration for prediction jobs. * `dataObject` (_object_) Details about the output data model object (DMO). **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `fields` (_array of MlPredictionJobDefPredictionMappingRepresentation_) List of model prediction fields and output DMO mappings. **Filter Group:** Small **Available Version:** 59.0 ### MlRetrieverConfigurationBaseRepresentation Ml Retriever Configuration Base Output Represents a retriever configuration. Includes all fields of `CdpAssetBaseRepresentation`. * `input` (_object_) Search index reference. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `isActive` (_boolean_) Indicates whether the configuration is active (`true`) or not (`false`). At most one configuration can be active per retriever. **Filter Group:** Small **Available Version:** 61.0 * `isCitationEnabled` (_boolean_) Indicates whether citation is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `numberOfResults` (_integer_) Maximum number of results to return. Must be a positive integer. **Filter Group:** Small **Available Version:** 61.0 * `retrievalMode` (_string_) Retrieval mode. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Advanced`, `Basic`. * `searchIndexConfiguration` (_object_) Search index configuration reference. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `semanticSearchType` (_string_) Type of semantic search. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Enriched`, `Hybrid`, `Vector`. * `sourceDmo` (_object_) Source data model object (DMO) to query. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `vectorDmo` (_object_) Vector data model object (DMO) containing embeddings for semantic search. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `version` (_integer_) Version number of the configuration. Must be non-negative. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverReviewSelectColumnRepresentation Ml Retriever Review Select Column Output Represents a SELECT column extracted from a CustomSql query. * `fieldName` (_string_) Name or alias of the column. **Filter Group:** Small **Available Version:** 61.0 * `type` (_string_) Data type of the column. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverReviewItemRepresentation Ml Retriever Review Item Output Represents a single review finding for a CustomSql retriever. * `code` (_string_) Finding code. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `AdvancedModeSuggested`, `AssetValidationError`, `CitationDefinitionMissing`, `CitationSuggested`, `CustomCitationLabelMissing`, `CustomCitationLabelNotFound`, `CustomCitationLinkMissing`, `CustomCitationLinkNotFound`, `DataSpaceNameBlank`, `DefaultCitationChunkIdMissing`, `DefaultCitationChunkIdNotAllowedForJit`, `DefaultCitationChunkIdNotFound`, `DefaultCitationChunkIndexNotFound`, `DefaultCitationChunkObjectDataSpaceMismatch`, `DefaultCitationChunkObjectMissing`, `DefaultCitationChunkObjectNotDmo`, `DefaultCitationChunkObjectSuggested`, `DefaultCitationChunkSourceMismatch`, `DefaultCitationLabelNotFound`, `DefaultCitationRecordIdMissing`, `DefaultCitationRecordIdNotFound`, `DefaultCitationSourceObjectDataSpaceMismatch`, `DefaultCitationSourceObjectMissing`, `DefaultCitationSourceObjectNotDmo`, `EnrichedIndexChunkColMissing`, `EnrichedIndexChunkColNotFound`, `EnrichedIndexChunkIdMissing`, `EnrichedIndexChunkIdNotFound`, `EnrichedIndexDataSpaceMismatch`, `EnrichedIndexDefinitionMissing`, `EnrichedIndexNameMissing`, `EnrichedIndexSuggested`, `InputNull`, `InvalidParameterValue`, `InvalidParameter`, `InvalidQueryPreparation`, `MainUserQueryParamFormat`, `MainUserQueryParamMissing`, `MainUserQueryParamNotInTemplate`, `MaxRowsOutOfRange`, `ParameterNameBlank`, `ParameterNameBlankAfterStrip`, `ParameterNameFormat`, `ParameterNameInvalid`, `ParameterNameTooLong`, `ParameterValueRequired`, `PlaceholderTypeInvalid`, `QueryExecutionFailed`, `QueryTemplateMissing`, `ScoreColumnNotFound`, `ScoreColumnSuggestedForMonitoring`, `ScoreColumnSuggestedForReranking`, `UnknownCitationType`. * `fieldPath` (_string_) Path to the field in the request. **Filter Group:** Small **Available Version:** 61.0 * `message` (_string_) Localized message. **Filter Group:** Small **Available Version:** 61.0 * `messageKey` (_string_) Message key for localization. **Filter Group:** Small **Available Version:** 61.0 * `messageParams` (_array of string_) List of parameters for the message template. **Filter Group:** Small **Available Version:** 61.0 * `severity` (_string_) Severity of the finding. `Error` blocks the creation and `Info` is a suggestion. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Error`, `Info`. ### MlRetrieverConfigurationRepresentation Ml Retriever Configuration Output Represents a configuration. Includes all fields of `MlRetrieverConfigurationBaseRepresentation`. ### MlRetrieverCitationConfigurationRepresentation Ml Retriever Citation Configuration Output Represents citation configuration. * `baseUrl` (_string_) Base URL that the `mappedUrlField` value is appended to. For example, if `baseUrl` is "[https://example.com](https://example.com)" and the data model object (DMO) field contains "/docs/article-123", the resulting URL is "[https://example.com/docs/article-123](https://example.com/docs/article-123)". **Filter Group:** Small **Available Version:** 61.0 * `mappedLabelField` (_object_) Mapped label field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverCitationFieldRepresentation`. * `mappedUrlField` (_object_) Mapped URL field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverCitationFieldRepresentation`. * `type` (_string_) Type of citation. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Custom`, `Default`. ### MlFieldPlaceholderRepresentation Ml Field Placeholder Output Represents a field placeholder for providing dynamic values at runtime. * `field` (_object_) Field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `fieldDataType` (_string_) Data type of the field. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `ArrayOfText`, `Boolean`, `Currency`, `Date`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. * `placeholderName` (_string_) Name of the placeholder in the format "{!$parameter}". **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverOutputFieldRepresentation Ml Retriever Output Field Represents an output field. Includes all fields of `MlRetrieverFieldBaseRepresentation`. * `relationshipPathId` (_string_) Record ID of the head relationship. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 * `relationships` (_array of MlDmoFieldSourceTargetRelationshipRepresentation_) List of relationships from the output field DMO to the source DMO. The cardinality must be 1 to 1 or 1 to many from this DMO to the source DMO. Maximum amount is `2`. Applies only to `NoCode`. **Filter Group:** Small **Available Version:** 61.0 ### CdpMlFilterRepresentation Ml Filter Output Represents a filter expression. * `conjunctiveOperator` (_string_) Operator to join filter conditions. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `And`, `Custom`, `Or`. * `criteria` (_array of CdpMlFilterCriterionBaseRepresentation_) List of filter criteria. **Filter Group:** Small **Available Version:** 61.0 * `customBooleanExpression` (_string_) Custom boolean expression. For example, "{!$0} AND {!$1} AND ({!$2} OR {!$3}) AND (NOT {!$4})". Each number is the index of a criterion in the criteria list. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplateDefinitionRepresentation Ml Retriever Query Template Definition Output Represents a query template definition. * `dataCloudAssets` (_array of MlRetrieverQueryTemplateDataCloudAssetRepresentation_) List of Data 360 assets referenced in the SQL query template. Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 * `enrichedSearchIndexDefinition` (_object_) Enriched search index definition. Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverQueryEnrichedSearchIndexDefinitionRepresentation`. * `mainUserQueryParameterName` (_string_) Name of the parameter containing the user query text in the format `":\"parameter\""`. Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 * `queryCitationDefinition` (_MlRetrieverQueryTemplateCitationDefinitionCustomRepresentation | MlRetrieverQueryTemplateCitationDefinitionDefaultRepresentation_) Citation definition for the query. The endpoint returns the citation definition output object that corresponds to the type of citation. Required when `isCitationSupported` is set to `true`. Applies only to `CustomSql`. For example, the Ml Retriever Query Template Citation Definition Custom Output is returned for the `Custom` type. **Filter Group:** Small **Available Version:** 61.0 One of: `MlRetrieverQueryTemplateCitationDefinitionCustomRepresentation`, `MlRetrieverQueryTemplateCitationDefinitionDefaultRepresentation`. * `queryTemplate` (_string_) SQL query template. Can contain parameters in the format ":parameter". **Filter Group:** Small **Available Version:** 61.0 * `queryTemplateMetadata` (_object_) Query template metadata. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `MlRetrieverQueryTemplateMetadataRepresentation`. * `queryTemplatePlaceholders` (_array of MlRetrieverQueryTemplatePlaceholderRepresentation_) List of parameters used in the SQL query template. **Filter Group:** Small **Available Version:** 61.0 * `queryTemplateVersionNumber` (_string_) Version number of the query template. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `V3PARAM`. * `searchOverallScoreColumnName` (_string_) Name of the column containing the overall search relevance score. Applies only to `CustomSql`. **Filter Group:** Small **Available Version:** 61.0 ### CdpQueryMetadataEntityOutputRepresentation Query Metadata Entity Output Represents a metadata entity. * `category` (_string_) Category of the metadata entity. Supported values are: * `Activation_Audience` * `CG_Audience` * `Content` * `Directory_Table` * `Engagement` * `Profile` * `Related` * `Segment_Membership` * `Vector_Embedding` **Filter Group:** Small **Available Version:** 66.0 * `displayName` (_string_) Display name of the entity. **Filter Group:** Small **Available Version:** 66.0 * `name` (_string_) Name of the entity. **Filter Group:** Small **Available Version:** 66.0 * `type` (_string_) Type of metadata entity. Supported values are: * `CalculatedInsight` * `DataLakeObject` * `DataModelObject` **Filter Group:** Small **Available Version:** 66.0 ### CloudProviderDetailsInputRepresentation Cloud Provider Details Input Input representation for the cloud provider of a Private Network Route. * `type` (_string_) Cloud provider that hosts the connector type for the Private Network Route. **Available Version:** 65.0 Allowed values: `AmazonWebServices`. ### DatabricksRouteDetailsInputRepresentation Databricks Route Details Input Input representation of route details for the cloud service used by the Private Network Route: Databricks. Includes all fields of `RouteDetailsInputRepresentation`. * `accountUrl` (_string_, required) URL of the Databricks workspace. **Available Version:** 66.0 ### AmazonMSKRouteDetailsInputRepresentation Amazon MSK Route Details Input Input representation of route details for the cloud service used by the Private Network Route: Amazon Managed Streaming for Apache Kafka (MSK). Includes all fields of `RouteDetailsInputRepresentation`. * `brokerEndpoints` (_array of string_, required) Endpoint of the Amazon MSK broker. **Available Version:** 65.0 ### RedshiftRouteDetailsInputRepresentation Redshift Route Details Input Input representation of route details for the cloud service used by the Private Network Route: Amazon Redshift. Includes all fields of `RouteDetailsInputRepresentation`. ### SnowflakeRouteDetailsInputRepresentation Snowflake Route Details Input Input representation of route details for the cloud service used by the Private Network Route: Amazon Snowflake. Includes all fields of `RouteDetailsInputRepresentation`. * `accountUrl` (_string_, required) URL of the Snowflake account. **Available Version:** 65.0 ### RouteDetailsInputRepresentation Route Details Input Abstract superclass for all route details input types for a Private Network Route. Discriminator: `type` selects the concrete type. Mapping: `Databricks` → `DatabricksRouteDetailsInputRepresentation`, `AmazonMsk` → `AmazonMSKRouteDetailsInputRepresentation`, `Redshift` → `RedshiftRouteDetailsInputRepresentation`, `Snowflake` → `SnowflakeRouteDetailsInputRepresentation`. * `serviceName` (_string_, required) Service name of the endpoint for the Private Network Route. **Available Version:** 65.0 * `type` (_string_, required) Type of the Private Network Route. **Available Version:** 65.0 Allowed values: `Databricks`, `DatabricksInternalStage`, `AmazonMsk`, `Redshift`, `Snowflake`, `SnowflakeInternalStage`. ### CloudProviderDetailsRepresentation Cloud Provider Details Output Represents details about the cloud provider for a Private Network Route. * `azureResourceId` (_any_) Azure resource ID. **Filter Group:** Small **Available Version:** 66.0 * `dataCloudDnsName` (_string_) Domain Name System (DNS) name of Data 360. **Filter Group:** Small **Available Version:** 65.0 * `dataCloudVpceId` (_string_) Virtual Private Cloud (VPC) endpoint ID of Data 360. **Filter Group:** Small **Available Version:** 65.0 * `status` (_string_) Status of the Private Network Route. **Filter Group:** Small **Available Version:** 65.0 Allowed values: `Allocating`, `DeletedRemotely`, `PendingAcceptance`, `PendingActivation`, `Ready`, `RejectedRemotely`, `TeardownInProgress`, `Unprovisioned`. * `type` (_string_) Cloud provider that hosts the connector type for the Private Network Route. **Filter Group:** Small **Available Version:** 65.0 Allowed values: `AmazonWebServices`. ### DatabricksRouteDetailsRepresentation Databricks Route Details Output Represents route details for the cloud service used by the Private Network Route: Databricks. Includes all fields of `RouteDetailsRepresentation`. * `accountUrl` (_string_) URL of the Databricks workspace. **Filter Group:** Small **Available Version:** 66.0 ### AmazonMSKRouteDetailsRepresentation Amazon MSK Route Details Output Represents route details for the cloud service used by the Private Network Route: Amazon Managed Streaming for Apache Kafka (MSK). Includes all fields of `RouteDetailsRepresentation`. * `brokerEndpoints` (_array of string_) Endpoint of the Amazon MSK broker. **Filter Group:** Small **Available Version:** 65.0 ### RedshiftRouteDetailsRepresentation Redshift Route Details Output Represents route details for the cloud service used by the Private Network Route: Amazon Redshift. Includes all fields of `RouteDetailsRepresentation`. ### SnowflakeRouteDetailsRepresentation Snowflake Route Details Output Represents route details for the cloud service used by the Private Network Route: Amazon Snowflake. Includes all fields of `RouteDetailsRepresentation`. * `accountUrl` (_string_) URL of the Snowflake account. **Filter Group:** Small **Available Version:** 65.0 ### RouteDetailsRepresentation Route Details Output Represents route details for a Private Network Route. Discriminator: `type` selects the concrete type. Mapping: `Databricks` → `DatabricksRouteDetailsRepresentation`, `AmazonMsk` → `AmazonMSKRouteDetailsRepresentation`, `Redshift` → `RedshiftRouteDetailsRepresentation`, `Snowflake` → `SnowflakeRouteDetailsRepresentation`. * `serviceName` (_string_) Service name of the endpoint for the Private Network Route. **Filter Group:** Small **Available Version:** 65.0 * `type` (_string_) Type of the Private Network Route. **Filter Group:** Small **Available Version:** 65.0 Allowed values: `Databricks`, `DatabricksInternalStage`, `AmazonMsk`, `Redshift`, `Snowflake`, `SnowflakeInternalStage`. ### CdpQueryV2RowRepresentation Query V2 Row Represents a row in the result of the V2 query API. * `rowData` (_array of object_) Row values. **Filter Group:** Small **Available Version:** 55.0 ### CdpQueryMetadataItemRepresentation Query Metadata Item Represents a query metadata item. * `placeInOrder` (_integer_) Attribute place order in the result * `type` (_string_) Metadata Type for Column * `typeCode` (_integer_) Metadata Type Code ### QuerySqlParameterItemRepresentation Query SQL Parameter Item Input Represents the input for SQL parameter fields. * `name` (_string_) Name of the SQL parameter. **Available Version:** 62.0 * `type` (_string_) Type of SQL parameter. **Available Version:** 62.0 Allowed values: `ArrayOfX`, `BigInt`, `Bool`, `Char`, `Date`, `Double`, `Float`, `Integer`, `Numeric`, `Oid`, `SmallInt`, `Time`, `Timestamp`, `TimestampTZ`, `Unspecified`, `Varchar`. * `value` (_string_) Value of the SQL parameter. **Available Version:** 62.0 ### QuerySqlBaseRepresentation Query SQL Base Output Base representation for query SQL output. * `returnedRows` (_integer (int64)_) Number of rows returned by the query. **Filter Group:** Small **Available Version:** 63.0 * `data` (_array of QuerySqlRowRepresentation_) Data associated with the SQL query. **Filter Group:** Small **Available Version:** 63.0 * `metadata` (_array of QuerySqlMetadataItemRepresentation_) Metadata associated with the SQL query. **Filter Group:** Small **Available Version:** 63.0 ### ChunkingConfigInputRepresentation Chunking Config Input Represents the input for chunking structured/unstructured configurations. * `fieldLevelConfigurations` (_array of FieldLevelConfigurationInputRepresentation_) The field level configurations used in structured flows. **Available Version:** 65.0 * `fileLevelConfiguration` (_object_) The file level configurations used in unstructured flows. **Available Version:** 65.0 ### IndexConfigInputRepresentation Index Config Input Represents the input for a semantic search index configuration. * `contextFieldConfiguration` (_array of ContextFieldConfigurationInputRepresentation_) Configuration of the fields for the `ContextFields__c` column of the Index DMO. Fields can come from source or related DMOs. **Available Version:** 64.0 * `recordFieldConfiguration` (_array of RecordFieldConfigurationInputRepresentation_) Configuration for the fields to be indexed as records. This configuration includes storage optimization, such as `TYPEAHEAD` or `STANDARD`. Fields can come from source or related DMOs. **Available Version:** 64.0 * `shouldVectorizeSearchableFields` (_boolean_) Indicates whether the searchable fields are vectorized (`true`) or not (`false`). **Available Version:** 64.0 ### SearchRankingFieldInputRepresentation Search Ranking Field Input Represents the input for ranking search fields. Includes all fields of `CdpAssetBaseInputRepresentation`. * `aliasName` (_string_) Alias of the field. **Available Version:** 64.0 * `developerName` (_string_) Developer name of the rank field. **Available Version:** 61.0 * `rankType` (_string_) Ranking factor used to influence the ranking of search result field types, `POPULARITY` or `RECENCY`, for hybrid search. **Available Version:** 61.0 * `relatedDmoDeveloperName` (_string_) API name of the related data model object (DMO). **Available Version:** 61.0 * `relatedDmoFieldDeveloperName` (_string_) API name of the related DMO field chosen for ranking factor. **Available Version:** 61.0 * `relatedDmoFieldName` (_string_) Name of the related DMO field chosen for ranking factor. **Available Version:** 61.0 * `relatedDmoName` (_string_) Name of the related DMO. **Available Version:** 61.0 * `relationships` (_array of SourceTargetRelationshipInputRepresentation_) Field relationship paths. **Available Version:** 61.0 ### TransformConfigInputRepresentation Transform Config Input Represents the input for transforming an unstructured configuration. * `fileLevelConfiguration` (_array of TransformFileLevelConfigurationInputRepresentation_) File-level configurations used in the transform. **Available Version:** 61.0 * `transformType` (_string_) Type of the transformation. Only transcribe is currently supported. **Available Version:** 61.0 ### VectorEmbeddingInputRepresentation Vector Embedding Input Represents the input for vector embedding. Includes all fields of `CdpAssetBaseInputRepresentation`. * `einsteinStudioModelId` (_string_) Einstein Studio AI model ID. **Available Version:** 60.0 * `vectorEmbeddingRelatedFields` (_array of VectorEmbeddingRelatedFieldsInputRepresentation_) Extra fields for vector embedding. **Available Version:** 60.0 ### VectorEmbeddingConfigInputRepresentation Vector Embedding Config Input Represents the input for a vector-embedding configuration. * `embeddingModel` (_object_) Deployed ML model that creates embeddings, for example, `e5-large`. **Available Version:** 60.0 Includes all fields of `ConfigInputRepresentation`. * `index` (_object_) Type used in vector indexing, such as `HNSW` or `FLAT`. **Available Version:** 60.0 Includes all fields of `ConfigInputRepresentation`. * `similarityMetric` (_string_) Similarity metric used to calculate distance between vectors, for example, `COSINE`. **Available Version:** 60.0 * `version` (_string_) Version of the record. **Available Version:** 60.0 ### VectorEmbeddingRepresentation Vector Embedding Output Represents the output for vector-embedding. * `id` (_string_) ID of created/updated vector embedding. **Filter Group:** Small **Available Version:** 60.0 * `relatedFields` (_array of string_) List of IDs of created vector embedding related fields. **Filter Group:** Small **Available Version:** 60.0 ### ChunkingConfigurationRepresentation Chunking Configuration Output Represents the output for a chunking configuration. * `fieldLevelConfigurations` (_array of FieldLevelChunkingConfigurationRepresentation_) Field level configurations. **Filter Group:** Small **Available Version:** 60.0 * `perFileExtension` (_array of PerFileExtensionRepresentation_) Per-file extension list. **Filter Group:** Small **Available Version:** 60.0 ### IndexConfigurationRepresentation Index Configuration Output Represents the index configuration for a semantic search record. * `contextFieldConfiguration` (_array of ContextFieldConfigurationRepresentation_) Configuration of the fields for the `ContextFields__c` column of the Index DMO. Fields come from source or related DMOs. **Filter Group:** Small **Available Version:** 64.0 * `recordFieldConfiguration` (_array of RecordFieldConfigurationRepresentation_) Configuration for the fields that are indexed as records. This configuration includes storage optimization, such as `TYPEAHEAD` or `STANDARD`. Fields come from source or related DMOs. **Filter Group:** Small **Available Version:** 64.0 * `shouldVectorizeSearchableFields` (_boolean_) Indicates whether the searchable fields are vectorized (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 64.0 ### RankingFieldsDetailsRepresentation Ranking Fields Details Output Ranking fields details representation. * `developerName` (_string_) Developer name of the ranking field. **Filter Group:** Small **Available Version:** 60.0 * `entitySourceType` (_string_) Developer name of the entity source field. **Filter Group:** Small **Available Version:** 60.0 * `fieldRelationshipPathId` (_string_) Relationships path ID. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) Record's ID. **Filter Group:** Small **Available Version:** 60.0 * `rankType` (_string_) Ranking factor used to influence the ranking of search result field types, (`POPULARITY` or `RECENCY`), for hybrid search. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoDeveloperName` (_string_) Related data model object (DMO) developer name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldDeveloperName` (_string_) Related DMO field developer name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldId` (_string_) Related DMO field ID. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldName` (_string_) Related DMO field name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoId` (_string_) Related DMO ID. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoName` (_string_) Related DMO name. **Filter Group:** Small **Available Version:** 60.0 * `relationships` (_array of FieldRelationshipsPathRepresentation_) List of relationships. **Filter Group:** Small **Available Version:** 60.0 ### TransformConfigurationRepresentation Transform Configuration Output Transform Configuration Detail Representation * `fileLevelConfiguration` (_array of TransformFileLevelConfiguration_) List of file-level configurations for transform. **Filter Group:** Small **Available Version:** 60.0 * `transformType` (_string_) Transform type. **Filter Group:** Small **Available Version:** 60.0 ### VectorEmbeddingDetailsRepresentation Vector Embedding Details Output Represents vector-embedding details. * `developerName` (_string_) Developer name. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) Record ID. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_) Source data model object (DMO) developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoFieldDeveloperName` (_string_) Source DMO field developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoFieldId` (_string_) Source DMO field ID. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoId` (_string_) Source DMO ID. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoDeveloperName` (_string_) Vector DMO developer name. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoFieldDeveloperName` (_string_) Vector DMO field developer name. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoFieldId` (_string_) Vector DMO field ID. **Filter Group:** Small **Available Version:** 60.0 * `vectorDmoId` (_string_) Vector DMO ID. **Filter Group:** Small **Available Version:** 60.0 * `vectorEmbeddingRelatedFields` (_array of VectorEmbeddingRelatedFieldsDetailsRepresentation_) Vector-embedding related fields. **Filter Group:** Small **Available Version:** 60.0 ### VectorConfigurationRepresentation Vector Configuration Output Represents vector-embedding configuration details. * `embeddingModel` (_object_) Embedding model. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `VectorConfigElementRepresentation`. * `index` (_object_) Indexes. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `VectorConfigElementRepresentation`. * `similarityMetric` (_string_) Similarity metric. **Filter Group:** Small **Available Version:** 60.0 ### CdpSegmentEinsteinGptSegmentsUIInputRepresentation Segment Einstein Gpt Segments UI Input Represents the input for an Einstein Gpt Segments UI segment. * `includeCriteria` (_string_) Inlcude criteria for an Einstein Gpt Segments UI segment. **Available Version:** 58.0 ### CdpSegmentDbtInputRepresentation Segment Dbt Input Represents the input for a DBT segment. * `models` (_array of CdpSegmentDbtModelInputRepresentation_) List of models for the DBT segment. **Available Version:** 58.0 ### CdpSegmentLookalikeInputRepresentation Segment Lookalike Input Represents the input for segment lookalike criteria. * `additionalPopulation` (_integer (int64)_) Additional lookalike population criteria. **Available Version:** 56.0 * `seedSegmentName` (_string_) Name of the seed segment. **Available Version:** 56.0 ### DailyScheduleInputRepresentation Daily Schedule Input Represents the input for creating a daily schedule. Includes all fields of `ScheduleInputRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule will run. You can specify multiple days. **Available Version:** 61.0 * `interval` (_integer_) Hourly interval at which segments can be published, from `1` through `24`. **Available Version:** 61.0 * `runFrom` (_object_) Start time for a rapid publish. **Available Version:** 61.0 Includes all fields of `CdpTimeInputRepresentation`. * `runTo` (_object_) End time for a rapid publish. **Available Version:** 61.0 Includes all fields of `CdpTimeInputRepresentation`. ### CdpHourlyScheduleInputRepresentation Hourly Schedule Input Input representation for creating an hourly schedule. Includes all fields of `CdpScheduleInputRepresentation`. * `daysOfWeek` (_array of string_) Day of the week on which the schedule will run. **Available Version:** 60.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Number of hours between runs. **Available Version:** 60.0 ### CdpMinutelyScheduleInputRepresentation Minutely Schedule Input Represents the input for creating a minutely schedule. Includes all fields of `CdpScheduleInputRepresentation`. * `daysOfWeek` (_array of string_) Day of the week on which the schedule will run. **Available Version:** 58.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Number of minutes between runs. **Available Version:** 58.0 ### MonthlySpecificScheduleInputRepresentation Monthly Schedule Input Represents the input for creating a monthly schedule where the days are fixed by numerical date. Includes all fields of `ScheduleInputRepresentation`. * `daysOfMonth` (_array of integer_) Days of the month on which the schedule is to run, specified as a list of numbers from `1` through `31`. Use `-1` to indicate the last day of the month; you can't combine `-1` with other days. **Available Version:** 58.0 ### CdpMonthlyRelativeScheduleInputRepresentation Monthly Relative Schedule Input Represents the input for creating a monthly relative schedule. Includes all fields of `CdpScheduleInputRepresentation`. * `dayOfWeek` (_string_) Day of the week on which the schedule will run. **Available Version:** 58.0 Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `weekOfMonth` (_string_) Relative week of the month when the schedule should be run. **Available Version:** 58.0 Allowed values: `First`, `Fourth`, `Last`, `Second`, `Third`. ### WeeklyScheduleInputRepresentation Weekly Schedule Input Represents the input for creating a weekly schedule. Includes all fields of `ScheduleInputRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule is to run. You can specify one day. **Available Version:** 58.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. ### CdpNoneScheduleInputRepresentation No Schedule Input Input representation when not creating a schedule. Includes all fields of `CdpScheduleInputRepresentation`. ### CdpSegmentDbtPipelineOutputRepresentation Segment DBT Pipeline Output Represents segment DBT pipeline output. * `models` (_array of CdpSegmentDbtModelOutputRepresentation_) List of DBT models. ### CdpSegmentLookalikeOutputRepresentation Segment Lookalike Output Represents a segment output lookalike. * `additionalPopulation` (_integer (int64)_) Additional lookalike population criteria. **Filter Group:** Small **Available Version:** 56.0 * `seedSegmentId` (_string_) Seed segment ID for the lookalike. **Filter Group:** Small **Available Version:** 56.0 ### ParameterRepresentation Parameter Output Represents the output for a dynamic parameter. * `isCollection` (_boolean_) Indicates whether the parameter is part of a collection (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the parameter. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of the parameter. **Filter Group:** Small **Available Version:** 63.0 ### DailyScheduleRepresentation Daily Schedule Output Represents a segment publication schedule that runs every day. Includes all fields of `ScheduleOutputRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule will run. You can specify multiple days. **Filter Group:** Small **Available Version:** 63.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Hourly interval at which segments can be published, from `1` through `24`. **Filter Group:** Small **Available Version:** 63.0 * `runFrom` (_object_) Start time for a rapid publish. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `TimeOutputRepresentation`. * `runTo` (_object_) End time for a rapid publish. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `TimeOutputRepresentation`. ### CdpHourlyScheduleRepresentation Hourly Schedule Output Hourly schedule to execute a job. Includes all fields of `CdpScheduleRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule is to run. **Available Version:** 60.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Number of hours between runs. **Available Version:** 60.0 ### CdpMinutelyScheduleRepresentation Minutely Schedule Output Represents the output for creating a minutely schedule. Includes all fields of `CdpScheduleRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule will run. **Filter Group:** Small **Available Version:** 58.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Number of hours between runs. **Filter Group:** Small **Available Version:** 58.0 ### MonthlySpecificScheduleRepresentation Monthly Schedule Output Represents a segment publication schedule that runs monthly. Includes all fields of `ScheduleOutputRepresentation`. * `daysOfMonth` (_array of integer_) Days of the month on which the schedule is to run, specified as a list of numbers from `1` through `31`. Use `-1` to indicate the last day of the month; you can't combine `-1` with other days. Jobs are skipped in months missing a specified day. **Filter Group:** Small **Available Version:** 63.0 * `interval` (_integer_) Hourly interval at which segments can be published, from `1` through `24`. **Filter Group:** Small **Available Version:** 63.0 ### CdpMonthlyRelativeScheduleRepresentation Monthly Relative Schedule Output Represents the output for creating a monthly relative schedule. Includes all fields of `CdpScheduleRepresentation`. * `dayOfWeek` (_string_) Day of the week on which the schedule is to run. **Filter Group:** Small **Available Version:** 58.0 Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `weekOfMonth` (_string_) Week of the month on which the schedule is to run. **Filter Group:** Small **Available Version:** 58.0 Allowed values: `First`, `Fourth`, `Last`, `Second`, `Third`. ### WeeklyScheduleRepresentation Weekly Schedule Output Represents a segment publication schedule that runs weekly. Includes all fields of `ScheduleOutputRepresentation`. * `daysOfWeek` (_array of string_) Days of the week on which the schedule is to run. You can specify one day. **Filter Group:** Small **Available Version:** 63.0 Items: Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. * `interval` (_integer_) Hourly interval at which segments can be published, from `1` through `52`. **Filter Group:** Small **Available Version:** 58.0 ### CdpNoneScheduleRepresentation No Schedule Output Output representation when not creating a schedule. Includes all fields of `CdpScheduleRepresentation`. ### CdpSegmentMembershipTableOutputRepresentation Segment Membership Table Output Represents a segment membership table. * `historyTable` (_string_) Segment membership history table. **Filter Group:** Small **Available Version:** 58.0 * `latestTable` (_string_) Segment membership latest table. **Filter Group:** Small **Available Version:** 58.0 * `profileTable` (_string_) Segment membership profile table. **Filter Group:** Small **Available Version:** 58.0 ### CdpSegmentMemberRowOutputRepresentation Segment Member Row Output Represents segment member row output. * `deltaType` (_string_) Delta type, for example, `new`, `existing`, or `removed`. **Filter Group:** Small **Available Version:** 58.0 * `id` (_string_) Segment member ID. **Filter Group:** Small **Available Version:** 58.0 * `kqId` (_string_) Fully qualified key ID. **Filter Group:** Small **Available Version:** 58.0 * `snapshotType` (_string_) Type of snapshot. Valid value: `full`. **Filter Group:** Small **Available Version:** 58.0 * `timestamp` (_string_) Timestamp. **Filter Group:** Small **Available Version:** 58.0 * `versionStamp` (_string_) Version timestamp. **Filter Group:** Small **Available Version:** 58.0 ### ActivationExternalPlatformAttributeRepresentation Activation External Platform Attribute Output Represents an attribute for an activation external platform. * `destinationName` (_string_) Name of the external platform attribute's destination. **Filter Group:** Small **Available Version:** 64.0 * `displayName` (_string_) Display name of the external platform attribute. Applicable only for ecoSystem external platforms. **Filter Group:** Small **Available Version:** 64.0 * `valueSource` (_string_) Source of the attribute value. `Mapped` indicates the value is mapped from a data model object (DMO); `Constant` indicates the value is a fixed constant. **Filter Group:** Small **Available Version:** 68.0 Allowed values: `Constant`, `Mapped`. * `values` (_array of string_) One or more constant attribute values. Populated only when `valueSource` is `Constant`. **Filter Group:** Small **Available Version:** 68.0 ### ActivationPlatformEventMetadataInputRepresentation Activation Platform Event Metadata Input Represents the input for event metadata configuration. * `customEventDetails` (_object_) Custom event details with attribute overrides. **Available Version:** 67.0 Includes all fields of `ActivationPlatformCustomEventInputRepresentation`. * `showEventSourceAnnotations` (_boolean_) Indicates whether event source annotations are shown in the UI (`true`) or not (`false`). **Available Version:** 67.0 * `standardEventDetails` (_object_) Standard event details, including event parameters, hierarchy, and attribute mapping info. **Available Version:** 67.0 Includes all fields of `ActivationPlatformStandardEventInputRepresentation`. * `supportedEventTypes` (_array of string_) Supported event types, such as `Standard` and `Custom`. **Available Version:** 67.0 ### ActivationMappingSchemaInputRepresentation Activation Mapping Schema Input Represents the input for a mapping schema. * `description` (_string_) Description of the mapping schema. **Available Version:** 67.0 * `icon` (_string_) Icon identifier. **Available Version:** 67.0 * `isDefault` (_boolean_) Indicates whether the schema is the default mapping schema (`true`) or not (`false`). **Available Version:** 67.0 * `name` (_string_, required) Name of the mapping schema. **Available Version:** 67.0 * `title` (_string_) Display title. **Available Version:** 67.0 ### ActivationPlatformOutputPropertiesInputRepresentation Activation Platform Output Properties Input Represents the input for file output configuration properties. * `compression` (_string_) Compression method applied to output files. **Available Version:** 67.0 Allowed values: `Bzip2`, `Gzip`, `None`. * `delimiter` (_string_) Field delimiter used in output files. **Available Version:** 67.0 Allowed values: `BrokenPipe`, `Caret`, `Colon`, `Comma`, `Hash`, `Pipe`, `Semicolon`, `Slash`, `Tab`, `Tilde`, `Underscore`. * `maxFileSizeInMB` (_integer_) Maximum file size in megabytes. **Available Version:** 67.0 * `maxRecordsPerFile` (_number (int64)_) Maximum records per output file. **Available Version:** 67.0 * `minRecordsPerFile` (_number (int64)_) Minimum records per output file. **Available Version:** 67.0 * `outputFormat` (_string_) Format of the output files. **Available Version:** 67.0 Allowed values: `Csv`, `Json`, `Parquet`. * `outputPartitions` (_number (int64)_) Number of output partitions. **Available Version:** 67.0 ### ActivationPlatformPartnerSupportedIdInputRepresentation Activation Platform Partner Supported Id Input Represents the input for partner-supported identifier types. * `destinationName` (_string_, required) Destination attribute that accepts these ID types. **Available Version:** 67.0 * `supportedIdTypes` (_array of string_) Supported identifier type values. **Available Version:** 67.0 ### ActivationPlatformFieldValueInputRepresentation Activation Platform Field Value Input Represents the input for a field picklist value. * `isDefault` (_boolean_) Indicates whether the value is the default value (`true`) or not (`false`). **Available Version:** 67.0 * `value` (_string_) Picklist value. **Available Version:** 67.0 ### ActivationPlatformEventMetadataRepresentation Activation Platform Event Metadata Output Represents event metadata for streaming activation platforms. * `customEventDetails` (_object_) Custom event details with attribute overrides. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformCustomEventRepresentation`. * `showEventSourceAnnotations` (_boolean_) Indicates whether event source annotations are shown in the UI (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `standardEventDetails` (_object_) Standard event details, including event parameters, hierarchy, and attribute mapping info. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformStandardEventRepresentation`. * `supportedEventTypes` (_array of string_) Supported event types, such as `Standard` and `Custom`. **Filter Group:** Small **Available Version:** 67.0 ### ActivationMappingSchemaRepresentation Activation Mapping Schema Output Represents a mapping schema available for the platform. * `description` (_string_) Description of the mapping schema. **Filter Group:** Small **Available Version:** 67.0 * `icon` (_string_) Icon identifier. **Filter Group:** Small **Available Version:** 67.0 * `isDefault` (_boolean_) Indicates whether the schema is the default mapping schema (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Name of the mapping schema. **Filter Group:** Small **Available Version:** 67.0 * `title` (_string_) Display title. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformOutputPropertiesRepresentation Activation Platform Output Properties Represents file output configuration properties. * `compression` (_string_) Compression method applied to output files. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Bzip2`, `Gzip`, `None`. * `delimiter` (_string_) Field delimiter used in output files. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `BrokenPipe`, `Caret`, `Colon`, `Comma`, `Hash`, `Pipe`, `Semicolon`, `Slash`, `Tab`, `Tilde`, `Underscore`. * `maxFileSizeInMB` (_integer_) Maximum file size in megabytes. **Filter Group:** Small **Available Version:** 67.0 * `maxRecordsPerFile` (_number (int64)_) Maximum records per output file. **Filter Group:** Small **Available Version:** 67.0 * `minRecordsPerFile` (_number (int64)_) Minimum records per output file. **Filter Group:** Small **Available Version:** 67.0 * `outputFormat` (_string_) Format of the output files. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Csv`, `Json`, `Parquet`. * `outputPartitions` (_number (int64)_) Number of output partitions. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformPartnerSupportedIdRepresentation Activation Platform Partner Supported Id Output Represents partner-supported identifier types for a specific destination. * `destinationName` (_string_) Destination attribute that accepts these ID types. **Filter Group:** Small **Available Version:** 67.0 * `supportedIdTypes` (_array of string_) Supported identifier type values. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformCustomerIdTypeRepresentation Activation Platform Customer Id Type Output Represents a single customer ID type entry. * `idType` (_string_) Name of the ID type. **Filter Group:** Small **Available Version:** 67.0 * `values` (_array of string_) Values for the ID type. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformFieldValueRepresentation Activation Platform Field Value Output Represents a picklist value for an activation platform field. * `activationPlatformFieldId` (_string_) ID of the parent field. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) Field value ID. **Filter Group:** Small **Available Version:** 67.0 * `isDefault` (_boolean_) Indicates whether the value is the default value (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 67.0 * `value` (_string_) Picklist value. **Filter Group:** Small **Available Version:** 67.0 ### McBusinessUnitRepresentation Mc Business Unit Output Represents a Marketing Cloud business unit within an enterprise. * `id` (_string_) Business unit ID (MID). **Filter Group:** Small **Available Version:** 67.0 * `name` (_string_) Display name of the business unit. **Filter Group:** Small **Available Version:** 67.0 ### QueryPathConfigListInputRepresentation Query Path Config List Input Represents the query path configuration list input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `configs` (_array of QueryPathConfigInputRepresentation_) Query path configuration. ### AttributeLimitingExpressionInputRepresentation Attribute Limiting Expression Input Represents the limiting expression input for an activation. * `attributeName` (_string_, required) Name of the attribute. **Available Version:** 63.0 * `entityName` (_string_, required) Name of the entity. **Available Version:** 63.0 * `order` (_string_, required) Sort order for the filter. **Available Version:** 63.0 Allowed values: `FilterSortOrderAsc`, `FilterSortOrderDesc`. * `queryPathConfig` (_array of QueryPathConfigListInputRepresentation_, required) Query path configuration input. **Available Version:** 63.0 * `type` (_string_, required) Type of attribute. **Available Version:** 63.0 ### ActivationAdditionalAttributesConfigInputRepresentation Activation Additional Attributes Config Input Represents the additional attributes configuration for the market segment activation input. * `activationPlatformAttrId` (_string_) Activation platform attribute ID. **Available Version:** 60.0 * `dataSourceType` (_string_) Type of the data source. **Available Version:** 60.0 * `entityName` (_string_) List of records in an Audience DMO. **Available Version:** 60.0 * `externalPlatformAttributeName` (_string_) Attribute destination name for an external platform. **Available Version:** 64.0 * `filterExpression` (_object_) Attribute filter expression. **Available Version:** 60.0 Includes all fields of `AttributeFilterExpressionInputRepresentation`. * `isRolluppable` (_boolean_) Indicates whether the attribute can roll up (`true`) or not (`false`). **Available Version:** 60.0 * `label` (_string_) Label of the attribute. **Available Version:** 60.0 * `name` (_string_) Name of the attribute. **Available Version:** 60.0 * `preferredName` (_string_) Preferred name of the attribute. **Available Version:** 60.0 * `queryPathConfig` (_array of QueryPathConfigListInputRepresentation_) Query path from the `activateOn` entity to the additional attribute entity. **Available Version:** 60.0 * `referenceAttributeName` (_string_) Developer name of the reference attribute. **Available Version:** 60.0 * `source` (_string_) Data export source type. **Available Version:** 60.0 Allowed values: `Direct`, `Related`. * `type` (_string_) Data export attribute type. **Available Version:** 60.0 Allowed values: `Computed_Dimension`, `Computed_Measure`, `Model`, `Model_Related`, `Non_Aggregatable_Computed_Measure`. ### ActivationContactPointInputRepresentation Activation Contact Point Input Represents the activation contact point input. * `attributesConfig` (_array of ContactPointAttributesConfigInputRepresentation_, required) Attributes for the contact point. **Available Version:** 60.0 * `entityName` (_string_, required) Entity name for the contact point. **Available Version:** 60.0 * `externalPlatformHashMethod` (_string_, required) External platform hash method for the contact point. **Available Version:** 60.0 * `filterExpression` (_array of ContactPointFilterExpressionInputRepresentation_, required) Filter expression for the contact point. **Available Version:** 60.0 * `queryPathConfig` (_array of QueryPathConfigListInputRepresentation_, required) Query path configuration list. **Available Version:** 63.0 * `sourcesConfig` (_array of ContactPointSourcesConfigInputRepresentation_, required) Source configurations for the contact point. **Available Version:** 60.0 * `type` (_string_, required) Type of contact point. **Available Version:** 60.0 Allowed values: `Email`, `Maid`, `Ott`, `Phone`, `Push`, `SubscriberKeyEmail`, `SubscriberKeyPhone`, `WhatsApp`. ### DataSourceNameConfigInputRepresentation Data Source Name Config Input Represents the data source name configuration input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `dataSourceName` (_string_, required) Data source API name for the activation. **Available Version:** 60.0 ### StaticDataInputRepresentation Static Data Input Represents the input for static data. * `name` (_string_, required) Name of the campaign data attribute. For custom attributes, provide any user-defined name-value pair. For standard attributes, use one of these name-value pairs: * Activation Name: `ACTIVATION_NAME` * Activation ID: `ACTIVATION_ID` * Segment Name: `SEGMENT_NAME` * Segment ID: `SEGMENT_ID` * Activation Publish Start Time: `PUBLISH_TIMESTAMP` * Activation Run ID: `ACTIVATION_RUN_ID` **Available Version:** 60.0 * `value` (_string_, required) Value of the campaign data attribute. For custom attributes, provide the constant value to include in the activation output. For standard attributes, provide the exact value associated with the selected standard attribute name. The system replaces this value with the actual metadata value at activation run time. **Available Version:** 60.0 ### WaterfallChildSegmentNamesInputRepresentation Waterfall Child Segment Names Input Represents a list of child segments input for a Waterfall activation. * `childSegments` (_array of string_) List of child segment developer names. **Available Version:** 67.0 ### AttributeLimitingExpressionRepresentation Attribute Limiting Expression Output Represents a limiting expression for an activation. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeName` (_string_) Name of the attribute. **Filter Group:** Small **Available Version:** 63.0 * `entityName` (_string_) Name of the entity. **Filter Group:** Small **Available Version:** 63.0 * `order` (_string_) Sort order for the filter. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `FilterSortOrderAsc`, `FilterSortOrderDesc`. * `queryPathConfig` (_string_) Query path for the attribute. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of attribute. **Filter Group:** Small **Available Version:** 63.0 ### ActivationAttributeRepresentation Activation Attribute Output Represents the activation attribute output. Includes all fields of `CdpAssetBaseRepresentation`. * `activationPlatformAttrId` (_string_) Activation platform ID for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 * `attributeLabel` (_string_) Label for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 * `dataSourceType` (_string_) Data source type for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 * `entityName` (_string_) Entity name for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 * `externalPlatformAttributeName` (_string_) Attribute destination name for an external platform. **Filter Group:** Small **Available Version:** 64.0 * `filterExpression` (_object_) Filter expression for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `AttributeFilterExpressionRepresentation`. * `preferredName` (_string_) Preferred name for the activation attribute. **Filter Group:** Small **Available Version:** 60.0 * `queryPathConfig` (_object_) Query path for the activation attribute. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `QueryPathConfigListRepresentation`. * `referenceAttributeName` (_string_) Name for the activation's reference attribute. **Filter Group:** Small **Available Version:** 63.0 * `source` (_string_) Activation attribute attributeSource. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Direct`, `Related`. * `type` (_string_) Type of the activation attribute. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Computed_Dimension`, `Computed_Measure`, `Model`, `Model_Related`, `Non_Aggregatable_Computed_Measure`. ### ContactPointConfigRepresentation Contact Point Config Output Represents the activation contact point configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `contactPointEntityId` (_string_) ID of the entity that this contact point configuration points to. **Filter Group:** Small **Available Version:** 63.0 * `contactPointEntityName` (_string_) Name of the entity that this contact point configuration points to. **Filter Group:** Small **Available Version:** 63.0 * `contactPointPath` (_string_) Path for the contact point. **Filter Group:** Small **Available Version:** 60.0 * `fieldConfig` (_object_) List of attributes from the contact point entity. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `ActivationContactPointsFieldConfigRepresentation`. * `filterExpression` (_object_) DMO filter expression for the contact point entity. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `ContactPointFilterExpressionRepresentation`. * `queryPathConfig` (_object_) Query path configuration to the entity from the activation subject entity. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `QueryPathConfigListRepresentation`. * `sourceConfig` (_object_) Source configuration for the contact point. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `ActivationContactPointsSourceConfigRepresentation`. * `type` (_string_) Type of contact point. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Email`, `Maid`, `Ott`, `Phone`, `Push`, `SubscriberKeyEmail`, `SubscriberKeyPhone`, `WhatsApp`. ### ActivationDataSourceConfigRepresentation Activation Data Source Config Output Represents the configuration output for an activation data source. * `name` (_string_) Name of the activation data source. **Filter Group:** Small **Available Version:** 63.0 ### DmoFilterRepresentation DMO Filter Input Represents the DMO filter output. Includes all fields of `CdpAssetBaseRepresentation`. * `entityFilter` (_object_) Entity filter for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BaseComparisonRepresentation`. * `entityFilterType` (_string_) Type of entity filter for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 * `entityName` (_string_) Entity name for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 * `filterLimit` (_object_) Limit for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `DmoFilterLimitRepresentation`. * `inheritedFilter` (_object_) Inherited filter for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BaseComparisonRepresentation`. * `inheritedFilterType` (_string_) Type of inherited filter for the DMO filter. **Filter Group:** Small **Available Version:** 60.0 * `queryPathConfigForActivateOnToContainer` (_object_) Query path from the activation to the container. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `QueryPathConfigListRepresentation`. * `queryPathConfigFromContainerToEntity` (_object_) Query path from the container to the entity. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `QueryPathConfigListRepresentation`. ### QueryPathConfigRepresentation Query Path Config Output Represents the query path configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `queryPath` (_array of QueryPathRepresentation_) List of query paths. ### StaticDataRepresentation Static Data Output Represents the static data output. * `name` (_string_) Column name of the campaign data attribute in output. For standard attributes, this is the selected standard attribute name. For custom attributes, this is the user-defined attribute name. **Filter Group:** Small **Available Version:** 60.0 * `value` (_string_) Column value of the campaign data attribute in the output. For custom attributes, this is the constant value you provided. For standard attributes, this is the actual metadata value populated by the system at activation run time from the value you selected (such as `ACTIVATION_NAME`, `ACTIVATION_ID`, `SEGMENT_NAME`, `SEGMENT_ID`, `PUBLISH_TIMESTAMP`, or `ACTIVATION_RUN_ID`). **Filter Group:** Small **Available Version:** 60.0 ### WaterfallChildSegmentNamesRepresentation Waterfall Child Segment Names Output Represents a list of child segments for a Waterfall activation. * `childSegments` (_array of string_) List of child segment developer names. **Filter Group:** Small **Available Version:** 67.0 ### PartnerValidationSummaryRepresentation Partner Validation Summary Output Represents aggregated partner-side validation results for a publish run. * `validationSummaryErrorCount` (_array of PartnerValidationErrorCountRepresentation_) Validation error counts by type. **Filter Group:** Small **Available Version:** 67.0 ### AgentContextDataSourcesInputRepresentation Agent Context Data Sources Input Represents the input for agent context data sources. * `dataGraphs` (_array of DataGraphInputRepresentation_) List of data graphs. **Available Version:** 66.0 ### ProfileDmoInputRepresentation Profile Dmo Input Represents the input for a profile data model object (DMO). * `name` (_string_) Name of the profile data model object (DMO). **Available Version:** 66.0 ### AgentContextDataSourcesRepresentation Agent Context Data Sources Output Represents agent context data sources. * `dataGraphs` (_array of DataGraphRepresentation_) List of data graphs. **Filter Group:** Small **Available Version:** 66.0 ### ProfileDmoRepresentation Profile Dmo Output Represents a profile data model object (DMO) configuration. Includes all fields of `CdpAssetBaseRepresentation`. ### CdpCalculatedInsightDataSourceRepresentation Calculated Insight Data Source Output Represents a calculated insight data source. * `sourceApiName` (_string_) Source Api Name * `type` (_string_) Type ### ResourceFilterByPropertyInputRepresentation Resource Filter By Property Input Input representation to filter fields and objects for a connection by property. * `name` (_string_) Name of the property to filter against the `values` based on the `filterGroup`. **Available Version:** 60.0 * `filterOperator` (_string_, required) Filter operation to perform on the `name` and `values`. **Available Version:** 62.0 Allowed values: `EqualsOp`, `LikeOp`, `SubstrOp`. * `values` (_array of string_, required) List of values on which to filter the `name` based on the `filterOperator`. **Available Version:** 62.0 ### BaseConnectionObjectRepresentation Base Connection Object Output Abstract superclass that represents a source object for a connection. * `name` (_string_) Name of the source object for the connection. **Filter Group:** Small **Available Version:** 62.0 ### CdpDataActionTargetConfig Data Action Target Config Input Base class for data action target config input. * `apiContract` (_string_) API contract for the data action target. **Available Version:** 58.0 * `targetEndpoint` (_string_) Target endpoint. **Available Version:** 58.0 ### CdpDataActionTargetInfo Data Action Target Info Output Representation for a data action target's configuration. Configuration parameters are case sensitive. * `apiContract` (_string_) API contract. **Filter Group:** Small **Available Version:** 62.0 * `targetEndpoint` (_string_) Target endpoint. **Filter Group:** Small **Available Version:** 62.0 ### DataActionRelationshipEdgeOutputRepresentation Data Action Relationship Edge Output Represents the DataActionRelationshipEdgeOutput * `sourceFieldApiName` (_string_) Source field's API name. **Filter Group:** Small **Available Version:** 62.0 * `sourceObjectApiName` (_string_) Source object's API Name. **Filter Group:** Small **Available Version:** 62.0 * `targetFieldApiName` (_string_) Target field's API name. **Filter Group:** Small **Available Version:** 62.0 * `targetObjectApiName` (_string_) Target object's API name. **Filter Group:** Small **Available Version:** 62.0 * `targetObjectDataGraphName` (_string_) Target object's data graph name. **Filter Group:** Small **Available Version:** 62.0 ### UseCaseTemplateConfigRepresentation Use Case Template Config Output Represents the configuration details for a clean room template. Includes all fields of `CdpAssetBaseRepresentation`. * `memberConfigs` (_array of UseCaseTemplateMemberConfigRepresentation_) Configuration for the use case template members. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomMetadataConfigurationRepresentation Data Clean Room Metadata Configuration Output Represents the metadata configuration for a clean room. * `memberConfig` (_array of DataCleanRoomMetadataMemberConfigRepresentation_) List of member-specific metadata configurations. **Filter Group:** Small **Available Version:** 66.0 * `usecaseConfig` (_DataCleanRoomMatchBoostUsecaseConfigRepresentation_) Use-case-specific configuration. Only applicable for `MatchBoost` use case types. For example, the Data Clean Room Match Boost Usecase Config Output is returned for the `MatchBoost` use case type. **Filter Group:** Small **Available Version:** 66.0 One of: `DataCleanRoomMatchBoostUsecaseConfigRepresentation`. ### DataCleanRoomAwsS3ConnectionAttributesRepresentation Data Clean Room AWS S3 Connection Attributes Input Represents the attributes for an AWS S3 connection. Includes all fields of `DataCleanRoomConnectionAttributesRepresentation`. * `roleArn` (_string_) IAM role used to connect to the provided S3 URL. **Available Version:** 66.0 * `s3Url` (_string_) Full path of the S3 bucket with folders where the user wants the data to be shared. **Available Version:** 66.0 ### DataCleanRoomSnowflakeConnectionAttributesRepresentation Data Clean Room Snowflake Connection Attributes Input Represents the attributes for a Snowflake connection. Includes all fields of `DataCleanRoomConnectionAttributesRepresentation`. * `accountUrl` (_string_) URL of the provider's Snowflake account. **Available Version:** 66.0 * `databaseName` (_string_) Name of the database containing the provider's final dataset. **Available Version:** 66.0 * `schemaName` (_string_) Name of the schema containing the provider's final dataset. **Available Version:** 66.0 * `serviceUser` (_string_) Name of the user authorized to access the shared database and schema. **Available Version:** 66.0 * `warehouseName` (_string_) Name of the warehouse used to host or process the provider's final dataset. **Available Version:** 66.0 ### DataCleanRoomAwsS3OutputDestinationConfigRepresentation Data Clean Room Aws S3 Output Destination Config Output AWS S3 output destination configuration for Data Clean Room Includes all fields of `DataCleanRoomOutputDestinationConfigRepresentation`. * `roleArn` (_string_) IAM role ARN for S3 access. **Filter Group:** Small **Available Version:** 66.0 * `s3Url` (_string_) S3 bucket URL with full path. **Filter Group:** Small **Available Version:** 66.0 ### DataCleanRoomSnowflakeOutputDestinationConfigRepresentation Data Clean Room Snowflake Output Destination Config Output Snowflake output destination configuration for Data Clean Room Includes all fields of `DataCleanRoomOutputDestinationConfigRepresentation`. * `accountUrl` (_string_) Snowflake account URL. **Filter Group:** Small **Available Version:** 66.0 * `databaseName` (_string_) Snowflake database name. **Filter Group:** Small **Available Version:** 66.0 * `schemaName` (_string_) Snowflake schema name. **Filter Group:** Small **Available Version:** 66.0 * `serviceUser` (_string_) Snowflake service user. **Filter Group:** Small **Available Version:** 66.0 * `warehouseName` (_string_) Snowflake warehouse name. **Filter Group:** Small **Available Version:** 66.0 ### CustomUseCaseTemplateQueryInputRepresentation Custom Use Case Template Query Input Represents the input for querying a custom use case template for a clean room. * `queryConfigs` (_array of CustomUseCaseTemplateQueryConfig_) List of queries defined in the custom use case template. **Available Version:** 63.0 ### CustomUseCaseTemplateTableInputRepresentation Custom Use Case Template Table Input Represents the input for a clean room custom use case template table. * `tableConfigs` (_array of CustomUseCaseTemplateTableConfig_) List of tables referenced in the template query. **Available Version:** 63.0 ### MatchBoostUsecaseConfigInputRepresentation Match Boost Usecase Config Input Represents the input for match boost use case template types. Includes all fields of `DataCleanRoomUsecaseConfigInputRepresentation`. * `outputObjects` (_array of MatchBoostOutputObjectInputRepresentation_) List of output objects for the use case template. **Available Version:** 66.0 * `supportedContactPoints` (_array of string_) List of contact points supported by the provider. **Available Version:** 66.0 Items: Allowed values: `Email`, `PhoneNumber`. ### UseCaseTemplateMappingAttributeRepresentation Use Case Template Mapping Attribute Output Represents the mapping attributes for a clean room use case template. Includes all fields of `CdpAssetBaseRepresentation`. * `alias` (_string_) Alias for the mapping attribute. **Filter Group:** Small **Available Version:** 63.0 * `attributeId` (_string_) ID of the mapping attribute. **Filter Group:** Small **Available Version:** 63.0 * `defaultValue` (_string_) Default value of the mapping attribute if it is not mapped. **Filter Group:** Small **Available Version:** 63.0 * `filterOptions` (_object_) Filter criteria to be applied to the attribute values. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateMappingAttributeFilterOptionRepresentation`. * `path` (_array of UseCaseTemplateMappingPathAttributeRepresentation_) Path that defines the relationship between this attribute and the collaboration entity. **Filter Group:** Small **Available Version:** 63.0 * `subjectAttribute` (_object_) Pair that identifies the mapping between the template field and the mapped field. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateMappingSubjectAttributeRepresentation`. * `tableName` (_string_) Logical table name with which the attribute is associated. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomMemberForUseCaseTypeRepresentation Data Clean Room Member For Use Case Type Output Represents a collaboration member for a given use case template. Includes all fields of `CdpAssetBaseRepresentation`. * `collaborationEntity` (_string_) Developer name of the collaboration entity. **Filter Group:** Small **Available Version:** 66.0 * `memberId` (_string_) ID of the member. **Filter Group:** Small **Available Version:** 66.0 * `memberOrgId` (_string_) ID of the member org. **Filter Group:** Small **Available Version:** 66.0 * `memberStatus` (_string_) Status of the member. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Active`, `Inactive`, `Mapping_Incomplete`. * `memberType` (_string_) Type of member. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Consumer`, `Provider`. * `providerId` (_string_) ID or reference key to provider record. **Filter Group:** Small **Available Version:** 66.0 * `providerName` (_string_) Name of the provider. **Filter Group:** Small **Available Version:** 66.0 * `specificationId` (_string_) ID or reference key to specification record. **Filter Group:** Small **Available Version:** 66.0 ### ConditionNodeRepresentation Condition Node Output Represents a node in a recursive AccessPolicy condition tree (group or condition). Exactly one of group or condition is present. * `condition` (_object_) Leaf condition at this node. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ConditionLeafRepresentation`. * `group` (_object_) Nested condition group at this node. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ConditionGroupRepresentation`. ### ConditionNodeInputRepresentation Condition Node Input Node in a recursive AccessPolicy condition tree (group or condition). Exactly one of group or condition must be provided. * `condition` (_object_) Leaf condition at this node. Provide either condition or group, but not both. **Available Version:** 67.0 Includes all fields of `ConditionLeafInputRepresentation`. * `group` (_object_) Nested condition group at this node. Provide either group or condition, but not both. **Available Version:** 67.0 Includes all fields of `ConditionGroupInputRepresentation`. ### BatchErrorItemRepresentation Batch Error Item Output Represents the error information for a failed data governance bulk operation item. * `errorCode` (_string_) Machine-readable error code. **Filter Group:** Small **Available Version:** 67.0 * `message` (_string_) Human-readable error message. **Filter Group:** Small **Available Version:** 67.0 ### CdpDataGraphFieldInputRepresentation Data 360 Data Graph Field Input Data graph field input representation. * `ciFieldType` (_string_, required) Calculated insight field type. **Available Version:** 59.0 * `dataType` (_string_, required) Data type of the field. **Available Version:** 59.0 * `isKeyColumn` (_boolean_, required) Indicates whether the field is a primary key (`true`) or not (`false`). **Available Version:** 59.0 * `isProjected` (_boolean_, required) Indicates whether this field needs to be projected in output value JSON (`true`) or not (`false`). **Available Version:** 59.0 * `keyQualifierName` (_string_, required) Key qualifier name. **Available Version:** 59.0 * `sourceFieldName` (_string_, required) API name of the field of the object. **Available Version:** 59.0 * `usageTag` (_string_, required) Tag that indicates whether the field represents a key qualifier field (`KEY_QUALIFIER`) or not (`NONE`). **Available Version:** 59.0 ### CdpDataGraphPathToParentInputRepresentation Data Graph Path to Parent Input Data graph source object path input representation. * `fieldName` (_string_, required) Field name of this object that joins with parentFieldName. **Available Version:** 59.0 * `parentFieldName` (_string_, required) Field name of the parent object that participated in the path. **Available Version:** 59.0 ### CdpDataGraphDataRecencyInputRepresentation Data Graph Recency Input Data graph recency criteria input representation. * `fieldName` (_string_, required) API name of the field to which recency criteria is applied. **Available Version:** 59.0 * `value` (_integer_, required) Value of the criteria. **Available Version:** 59.0 * `valueType` (_string_, required) Type of value. Valid values are `time` and `record`. **Available Version:** 59.0 * `valueUnit` (_string_, required) For time, valid value is `DAY`. For record, valid value is `RECORD`. **Available Version:** 59.0 ### CdpDataGraphFieldOutputRepresentation Data 360 Data Graph Field Output Represents a data graph field. Includes all fields of `CdpObjectBaseOutputRepresentation`. * `dataType` (_string_) Data type of the data graph field. **Filter Group:** Small **Available Version:** 59.0 * `isKeyColumn` (_boolean_) Indicates whether this field is the key column (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 * `isProjected` (_boolean_) Indicates whether this field is projected (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 * `sourceFieldLabel` (_string_) Label of the source field. **Filter Group:** Small **Available Version:** 59.0 * `sourceFieldName` (_string_) Developer name of the source field. **Filter Group:** Small **Available Version:** 59.0 * `usageTag` (_string_) Usage tag. **Filter Group:** Small **Available Version:** 59.0 ### CdpDataGraphPathToParentOutputRepresentation Data Graph Path to Parent Output Represents data graph path-to-parent output. * `fieldLabel` (_string_) Field label. **Filter Group:** Small **Available Version:** 59.0 * `fieldName` (_string_) Field name. **Filter Group:** Small **Available Version:** 59.0 * `parentFieldLabel` (_string_) Parent field label. **Filter Group:** Small **Available Version:** 59.0 * `parentFieldName` (_string_) Parent field name. **Filter Group:** Small **Available Version:** 59.0 ### CdpDataGraphRecencyCriteriaOutputRepresentation Data Graph Recency Criteria Output Represents data graph recency criteria output. * `fieldLabel` (_string_) Field label of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `fieldName` (_string_) Field name of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `value` (_integer_) Value of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `valueType` (_string_) Value type of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `valueUnit` (_string_) Value unit of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 ### DataGraphObjectDataRepresentation Data Graph Object Data Output Represents object data for a data graph. * `dataGraphSourceDevName` (_string_) Developer name of the source data graph for the data object. **Filter Group:** Small **Available Version:** 61.0 * `developerName` (_string_) Developer name of the data object for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `fields` (_array of DataGraphFieldRepresentation_) List of fields for the data object of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `filterCriteria` (_string_) Filter criteria for the data object of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `memberDmoName` (_string_) Name of the member data model object (DMO) for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `paths` (_array of DataGraphRelationshipRepresentation_) List of data path relationships for the object data of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `recencyCriteria` (_array of RecencyCriteriaRepresentation_) List of recency criteria for the object data of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `relatedObjects` (_array of DataGraphObjectDataRepresentation_) Recursive list of related data objects for the data graph. **Filter Group:** Small **Available Version:** 59.0 * `type` (_string_) Data type of the data object for the data graph. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Adg`, `AdgActivationAudience`, `AdgExternal`, `Bridge`, `Calculated`, `CalculatedRealTime`, `CalculatedStreaming`, `Curated`, `Custom`, `Derived`, `MlPrediction`, `ObjectTypeUnspecified`, `Package`, `SegmentMembership`, `Standard`, `System`, `Transform`. ### DataGraphIdsDmoRepresentation Data Graph IDs DMO Output Represents data about the data model object (DMO) that contains the ID table for the data graph. * `developerName` (_string_) Developer name of the DMO. **Filter Group:** Small **Available Version:** 61.0 * `fields` (_array of DataGraphIdsDmoFieldRepresentation_) List of fields for the DMO. **Filter Group:** Small **Available Version:** 59.0 ### DataGraphValuesDmoRepresentation Data Graph Values DMO Output Represents data about the data model object (DMO) that contains the JSON records for the data graph. * `developerName` (_string_) Developer name of the DMO. **Filter Group:** Small **Available Version:** 61.0 * `fields` (_array of DataGraphValuesDmoFieldRepresentation_) List of fields for the DMO. **Filter Group:** Small **Available Version:** 59.0 ### DataGraphScheduleInputRepresentation Data Graph Schedule Input Represents the input for a data graph schedule. * `frequency` (_integer_) Frequency of the schedule refresh. **Available Version:** 67.0 * `timeGranularity` (_string_) Type of time granularity. **Available Version:** 67.0 ### DataKitComponentInfo Data Kit Component Info Output Represents a component of a data kit. * `componentType` (_string_) Type of data kit component. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `ActivationTarget`, `AnalyticsDashboard`, `AnalyticsVisualization`, `AnalyticsWorkspace`, `CalculatedInsight`, `CopyFieldEnrichment`, `CurrencyConfigObject`, `DataAction`, `DataActionTarget`, `DataCleanRoomDataSpecDef`, `DataCleanRoomProvider`, `DataConnection`, `DataCustomCode`, `DataGraph`, `DataLakeObject`, `DataModelObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `EngagementSignal`, `FiscalCalendarConfigObject`, `IdentityResolution`, `IdpConfiguration`, `InternalDataConnector`, `IrRelatedListEnrichment`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `PersnlBatchDecision`, `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, `PersonalizationSchema`, `SecondaryIndex`, `SemanticModel`, `TuaTemplatedObject`. * `developerName` (_string_) Developer name of the data kit component. **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_) Label of the data kit component. **Filter Group:** Small **Available Version:** 63.0 ### DataKitDefaultComponentInfo Data Kit Default Component Info Output Represents information about the default data kit component. Includes all fields of `DataKitComponentInfo`. ### DataKitComponentInfoBundleInputRepresentation Data Kit Component Info Bundle Input Represents the input for bundle-specific component information. Includes all fields of `DataKitComponentInfoInputRepresentation`. * `connectorType` (_string_) Type of data kit bundle connector. **Available Version:** 63.0 Allowed values: `AccountEngagement`, `Commerce`, `Crm`, `External`, `IngestApi`, `Mc`, `MoreConnectors`, `S3`, `StreamingApp`. * `streams` (_array of CdpDataKitStream_) List of data streams. **Available Version:** 63.0 ### DataKitComponentInfoBaseInputRepresentation Data Kit Component Info Base Input Represents the input for data kit component information. Includes all fields of `DataKitComponentInfoInputRepresentation`. * `label` (_string_) Label of the data kit component. **Available Version:** 63.0 ### DataKitComponentInfoBundleRepresentation Data Kit Component Info Bundle Output Represents bundle-specific component information. Includes all fields of `DataKitComponentInfoRepresentation`. * `connectorType` (_string_) Type of data kit bundle connector. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `AccountEngagement`, `Commerce`, `Crm`, `External`, `IngestApi`, `Mc`, `MoreConnectors`, `S3`, `StreamingApp`. * `streams` (_array of DataKitStreamRepresentation_) List of data streams. **Filter Group:** Small **Available Version:** 63.0 ### DataKitComponentInfoBaseRepresentation Data Kit Component Info Base Output Represents information about a data kit component. Includes all fields of `DataKitComponentInfoRepresentation`. * `label` (_string_) Label of the data kit component. **Filter Group:** Small **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForBundle Data Kit Deploy Component Config For Bundle Input Represents the input component configuration for data kit bundles. Includes all fields of `CdpDataKitDeployComponentConfig`. * `bundleConfig` (_CdpDataKitDeployBundleConfigForAccountEngagement | CdpDataKitDeployBundleConfigForCommerce | CdpDataKitDeployBundleConfigForConnectorsFramework | CdpDataKitDeployBundleConfigForCrm | CdpDataKitDeployBundleConfigForExternal | CdpDataKitDeployBundleConfigForIngestApi | CdpDataKitDeployBundleConfigForStreamingApp_) Configuration for the bundle. Use the bundle config input object that corresponds to the connector type. For example, use the Data Kit Deploy Bundle Config For Account Engagement Input for the `AccountEngagement` connector type. * Use the Data Kit Deploy Bundle Config For Connectors Framework Input for the `MoreConnectors` and `S3` connector types. **Available Version:** 57.0 One of: `CdpDataKitDeployBundleConfigForAccountEngagement`, `CdpDataKitDeployBundleConfigForCommerce`, `CdpDataKitDeployBundleConfigForConnectorsFramework`, `CdpDataKitDeployBundleConfigForCrm`, `CdpDataKitDeployBundleConfigForExternal`, `CdpDataKitDeployBundleConfigForIngestApi`, `CdpDataKitDeployBundleConfigForStreamingApp`. * `bundleName` (_string_) Name of the bundle. **Available Version:** 57.0 * `connectorType` (_string_) Connector type for the bundle. **Available Version:** 57.0 Allowed values: `AccountEngagement`, `Commerce`, `Crm`, `External`, `IngestApi`, `MoreConnectors`, `S3`, `StreamingApp`. * `forceNoRefresh` (_boolean_) Indicates whether to force a no refresh configuration on the data stream (`true`) or not (`false`). **Available Version:** 57.0 * `kqConfig` (_array of DataKitKQConfigRepresentation_) List of key qualifier configurations applied on data stream templates of the bundle. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForDLO Data Kit Deploy Component Config For DLO Input Represents the input component configuration for DLOs. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the DLO. **Available Version:** 60.0 * `dataSourceObjectDevName` (_string_) Developer name of the DLO. **Available Version:** 60.0 * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) Data space filter criteria for adding filters while deploying a DLO. **Available Version:** 60.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 60.0 * `label` (_string_) Label name of the DLO. **Available Version:** 60.0 ### CdpDataKitDeployComponentConfigCalculatedInsight Data Kit Deploy Component Config Calculated Insight Input Represents the input component configuration for calculated insights. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the calculated insight in the data kit to be deployed. **Available Version:** 59.0 * `apiNameOverride` (_string_) Name of the new calculated insight deployed using the template. **Available Version:** 59.0 * `label` (_string_) Master label of the calculated insight. **Available Version:** 59.0 * `publishInterval` (_string_) Publish interval for the calculated insight. **Available Version:** 59.0 Allowed values: `ExternallyManaged`, `NotScheduled`, `One`, `Six`, `Streaming`, `SystemManaged`, `Twelve`, `TwentyFour`. * `publishScheduleEndDate` (_string_) Calculated insight publish schedule end date. The expected format is `yyyy-MM-dd`. **Available Version:** 62.0 * `publishScheduleStartDateTime` (_string_) Calculated insight publish schedule start date. The expected format is `yyyy-MM-dd`. **Available Version:** 62.0 ### CdpDataKitDeployComponentConfigForDataAction Data Kit Deploy Component Config For Data Action Input Represents the input component configuration for data actions. Includes all fields of `CdpDataKitDeployComponentConfig`. * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `developerName` (_string_) Developer name of the data action. **Available Version:** 63.0 * `developerNameOverride` (_string_) Developer name of the data action override. **Available Version:** 63.0 * `label` (_string_) Label of the data action object. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForDataActionTarget Data Kit Deploy Component Config For Data Action Target Input Represents the input component configuration for data action targets. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the data action target. **Available Version:** 63.0 * `apiNameOverride` (_string_) API name of the data action target override. **Available Version:** 63.0 * `endPointUrlOverride` (_string_) API name of the data action target endpoint URL override. **Available Version:** 63.0 * `label` (_string_) Label of the data action target object. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForDataSemanticSearch Data Kit Deploy Component Config For Data Semantic Search Input Represents the input component configuration for data semantic search. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the semantic search object. **Available Version:** 63.0 * `dataKitName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the semantic search object. **Available Version:** 63.0 * `name` (_string_) Name of the specific semantic search instance. **Available Version:** 63.0 * `searchIndexName` (_string_) Developer name of the underlying search index used by this component. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForDataShare Data Kit Deploy Component Config For Data Share Input Represents the input component configuration for data shares. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) Definition name of the target data share. **Available Version:** 63.0 * `cios` (_array of string_) Developer names of the calculated insight objects. **Available Version:** 63.0 * `dataShareDeveloperName` (_string_) Definition name of the source data share. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `description` (_string_) Description for the data share. **Available Version:** 63.0 * `dlos` (_array of string_) Developer names of the DLOs. **Available Version:** 63.0 * `dmos` (_array of string_) Developer names of the DMOs. **Available Version:** 63.0 * `label` (_string_) Label of the data share. **Available Version:** 63.0 * `templateDevName` (_string_) Template developer name of the data share template that's used for creating the share in the data kit. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForIdpConfiguration Data Kit Deploy Component Config For Idp Configuration Input Represents the input component configuration for Document AI. Includes all fields of `CdpDataKitDeployComponentConfig`. * `templateDevName` (_string_) Developer name of the Document AI template. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForPredictionJob Data Kit Deploy Component Config For Prediction Job Input Represents the input component configuration for ML prediction jobs. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the ML prediction job object. **Available Version:** 63.0 * `dataKitName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the ML prediction job object. **Available Version:** 63.0 * `predictionJobName` (_string_) Developer name of the specific prediction job. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigForTuaFramework Data Kit Deploy Component Config For Tua Framework Input Represents the input component configuration for TUA objects. Includes all fields of `CdpDataKitDeployComponentConfig`. * `changeSetIdentifier` (_string_) Unique ID for the change set. **Available Version:** 63.0 * `componentType` (_string_) Type of TUA object component. **Available Version:** 63.0 Allowed values: `ActivationTarget`, `AnalyticsDashboard`, `AnalyticsVisualization`, `AnalyticsWorkspace`, `CalculatedInsight`, `CopyFieldEnrichment`, `CurrencyConfigObject`, `DataAction`, `DataActionTarget`, `DataCleanRoomDataSpecDef`, `DataCleanRoomProvider`, `DataConnection`, `DataCustomCode`, `DataGraph`, `DataLakeObject`, `DataModelObject`, `DataSemanticSearch`, `DataShare`, `DataStreamBundle`, `DataTransform`, `EngagementSignal`, `FiscalCalendarConfigObject`, `IdentityResolution`, `IdpConfiguration`, `InternalDataConnector`, `IrRelatedListEnrichment`, `MarketSegment`, `MarketSegmentActivation`, `MlConfiguredModel`, `MlPredictionJob`, `MlRetriever`, `PersnlBatchDecision`, `PersonalizationObjective`, `PersonalizationPoint`, `PersonalizationRecommender`, `PersonalizationSchema`, `SecondaryIndex`, `SemanticModel`, `TuaTemplatedObject`. * `dataKitDevName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `developerName` (_string_) Developer name of the TUA object. **Available Version:** 63.0 * `label` (_string_) Label of the TUA object. **Available Version:** 63.0 ### CdpDataKitDeployComponentConfigMlConfiguredModel Data Kit Deploy Component Config Ml Configured Model Input Represents the input component configuration for ML configured models. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the ML configured model. **Available Version:** 63.0 * `connectorType` (_string_) Type of ML configured model connector. **Available Version:** 63.0 Allowed values: `Anthropic`, `AzureOpenAI`, `Bedrock`, `Databricks`, `Generic`, `InternalEmbedding`, `OpenAI`, `OpenConnector`, `SageMaker`, `Salesforce`, `VertexAI`. * `label` (_string_) Label of the ML configured model. **Available Version:** 63.0 * `modelType` (_string_) Type of ML configured model. **Available Version:** 63.0 Allowed values: `Generative`, `Predictive`, `SpeechSynthesis`, `Summarization`, `Transcribe`, `Unknown`. ### CdpDataKitDeployComponentConfigMlRetriever Data Kit Deploy Component Config Ml Retriever Input Represents the input component configuration for ML retrievers. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the retriever. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the retriever. **Available Version:** 63.0 * `retrieverQueryType` (_string_) Query type of the retriever. **Available Version:** 63.0 Allowed values: `Ensemble`, `NoCode`, `ProCode`. ### DataCustomCodeInputRep Data Kit Deploy Data Custom Code Input Represents the input component configuration for data custom code. Includes all fields of `CdpDataKitDeployComponentConfig`. * `templateDevName` (_string_) Developer name of the custom code template. **Available Version:** 63.0 ### DataKitDeployActivationTargetRepresentation Data Kit Deploy Activation Target Input Represents the input component configuration for activation targets. Includes all fields of `CdpDataKitDeployComponentConfig`. * `componentName` (_string_) Developer name of the activation target. **Available Version:** 63.0 * `targetDisplayName` (_string_) Label of the activation target. **Available Version:** 63.0 ### DataKitDeployComponentConfigCopyField Data Kit Deploy Component Config Copy Field Input Represents the input component configuration for copy field enrichments. Includes all fields of `CdpDataKitDeployComponentConfig`. * `templateDevName` (_string_) Developer name of the copy field enrichment template. **Available Version:** 63.0 ### DataKitDeployComponentConfigForIRRelatedList Data Kit Deploy Component Config For IR Related List Input Represents the input component configuration for IR-related lists. Includes all fields of `CdpDataKitDeployComponentConfig`. * `developerName` (_string_) Developer name of the IR-related list. **Available Version:** 63.0 * `label` (_string_) Label of the IR-related list. **Available Version:** 63.0 ### DataKitDeployComponentConfigIdentityResolutionInput Data Kit Deploy Component Config Identity Resolution Input Represents the input component configuration for identity resolutions. Includes all fields of `CdpDataKitDeployComponentConfig`. * `dataKitDevName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `identityResolutionDevName` (_string_) Developer name of the identity resolution. **Available Version:** 63.0 * `label` (_string_) Label of the identity resolution. **Available Version:** 63.0 ### DataKitDeployComponentConfigSemanticModelInputRepresentation Data Kit Deploy Component Config Semantic Model Input Represents the input component configuration for semantic search models. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the semantic search model. **Available Version:** 63.0 * `baseSDMs` (_array of string_) Base SDM API names of the semantic search model. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `displayName` (_string_) Label of the semantic search model. **Available Version:** 63.0 ### DataKitDeployDataCleanRoomMappingRepresentation Data Kit Deploy Data Clean Room Mapping Input Represents the input component configuration for clean room specification mapping. Includes all fields of `CdpDataKitDeployComponentConfig`. * `componentName` (_string_) Name of the data kit component. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 ### DataKitDeployDataCleanRoomProviderRepresentation Data Kit Deploy Data Clean Room Provider Input Represents the input component configuration for clean room providers. Includes all fields of `CdpDataKitDeployComponentConfig`. * `componentName` (_string_) Developer name of the clean room provider. **Available Version:** 63.0 * `packageName` (_string_) Label of the clean room provider. **Available Version:** 63.0 ### DataKitDeployDataConnectionRepresentation Data Kit Deploy Data Connection Input Represents the input component configuration for data connections. Includes all fields of `CdpDataKitDeployComponentConfig`. * `name` (_string_) Developer name of the connection. **Available Version:** 63.0 * `newCredentials` (_array of DataConnectionParameterInputRepresentation_) Connection credentials to use in the target org. **Available Version:** 63.0 * `overrideLabel` (_string_) Override label to use in the target org. **Available Version:** 63.0 * `overrideParameters` (_array of DataConnectionParameterInputRepresentation_) Connection parameters to override in the target org. **Available Version:** 63.0 ### DataKitDeployDataGraphInputRepresentation Data Kit Deploy Data Graph Input Represents the input component configuration for data graphs. Includes all fields of `CdpDataKitDeployComponentConfig`. * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the data graph. **Available Version:** 63.0 * `name` (_string_) Developer name of the data graph. **Available Version:** 63.0 * `primaryDMO` (_string_) Developer name of the primary DMO. **Available Version:** 63.0 * `templateDevName` (_string_) Developer name of the data graph template. **Available Version:** 63.0 ### DataKitDeployDataTransformRepresentation Data Kit Deploy Data Transform Input Represents the input component configuration for data transforms. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API Name of the data transform. **Available Version:** 63.0 * `componentProperties` (_object_) Component properties for different data transform types. **Available Version:** 63.0 Additional properties: `string`. * `connection` (_string_) Specific connection utilized for DLO-based transforms. **Available Version:** 63.0 * `currencyIsoCode` (_string_) Currency ISO code for data transform creation. **Available Version:** 63.0 * `dataObjectOverrides` (_array of DataTransformDataObjectOverride_) Overrides for specific input and output data object names defined in the transform. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `dataTransformDevName` (_string_) Developer name of the data transform. **Available Version:** 63.0 * `dataTransformType` (_string_) Type of data transform. **Available Version:** 63.0 * `definitionOverrides` (_array of DataTransformDefinitionOverride_) Specific name or label overrides for data definitions sourced from the origin organization. **Available Version:** 63.0 * `label` (_string_) Label of the data transform. **Available Version:** 63.0 ### DataKitDeployMarketActivationRepresentation Data Kit Deploy Market Activation Input Represents the input component configuration for market activations. Includes all fields of `CdpDataKitDeployComponentConfig`. * `componentName` (_string_) Developer name of the activation. **Available Version:** 63.0 * `dataKitName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `targetDisplayName` (_string_) Label of the activation. **Available Version:** 63.0 ### DataKitDeployMarketSegmentRepresentation Data Kit Deploy Market Segment Input Represents the input component configuration for market segments. Includes all fields of `CdpDataKitDeployComponentConfig`. * `dataKitName` (_string_) Developer name of the data kit. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the market segment. **Available Version:** 63.0 * `name` (_string_) Developer name of the market segment. **Available Version:** 63.0 * `targetDisplayName` (_string_) Target label for the market segment. **Available Version:** 63.0 * `targetSegmentDeveloperName` (_string_) Target developer name for the market segment. **Available Version:** 63.0 ### DataKitDeployPersonalizationInputRepresentation Data Kit Deploy Personalization Input Represents the input component configuration for personalization objects. Includes all fields of `CdpDataKitDeployComponentConfig`. * `apiName` (_string_) API name of the personalization object. **Available Version:** 63.0 * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the personalization object. **Available Version:** 63.0 * `templateDeveloperName` (_string_) Developer name of the personalization object template. **Available Version:** 63.0 ### DataKitDeployInputRepresentation Data Kit Deploy Input Represents the basic input component configuration for data kit objects. Includes all fields of `CdpDataKitDeployComponentConfig`. * `dataSpaceName` (_string_) Name of the data space to deploy the data kit component in. **Available Version:** 63.0 * `label` (_string_) Label of the data kit component. **Available Version:** 63.0 * `name` (_string_) API name of the data kit component. **Available Version:** 63.0 * `templateName` (_string_) Developer name of the template. **Available Version:** 63.0 ### DataObjectFieldInputRepresentation Data Object Field Input Represents the input fields in the data object. * `isPrimaryKey` (_boolean_, required) Indicates whether this field is a primary key (`true`) or not (`false`). **Available Version:** 60.0 * `keyQualifierFieldName` (_string_) Key qualifier field name. **Available Version:** 60.0 * `label` (_string_, required) Label of the field. **Available Version:** 60.0 * `name` (_string_, required) Name of the field. **Available Version:** 60.0 * `type` (_string_) Data type of the field. **Available Version:** 60.0 Allowed values: `Boolean`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### DirectoryAndFilesDetailsInputRepresentation Directory And Files Details Input Represents the directory and file details for a data source. * `dirName` (_string_) Name of the directory in the cloud-storage source that contains the files to ingest. Required; each entry must have a non-blank `dirName`. **Available Version:** 67.0 * `fileName` (_string_) Name of the file to ingest from the source directory. **Available Version:** 67.0 ### DataObjectFieldRepresentation Data Object Field Output Represents a data object field. * `isPrimaryKey` (_boolean_) Indicates whether this is the primary key (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `keyQualifierField` (_string_) Key qualifier field's developer name. **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Field's label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Field's developer name. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### RelationshipFieldRepresentation Relationship Field Output Represents details about the field involved in a relationship between data model objects (DMOs). * `label` (_string_) Label of the field in the relationship. **Filter Group:** Small **Available Version:** 64.0 * `name` (_string_) Developer name of the field in the relationship. **Filter Group:** Small **Available Version:** 64.0 * `type` (_string_) Type of the field in the relationship. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `CalculatedInsightField`, `DatamodelField`, `Sobjectfield`. ### RelationshipObjectRepresentation Relationship Object Output Represents details about the object involved in a relationship between data model objects (DMOs). * `keyQualifierField` (_string_) Key qualifier field of the object in the relationship. **Filter Group:** Small **Available Version:** 64.0 * `label` (_string_) Label of the object in the relationship. **Filter Group:** Small **Available Version:** 64.0 * `name` (_string_) Developer name of the object in the relationship. **Filter Group:** Small **Available Version:** 64.0 ### DataSpaceFilterConditionCollectionRepresentation Data Space Filter Condition Collection Input Represents a data space input filter on a data lake object (DLO). * `conditions` (_array of DataSpaceFilterConditionInputRepresentation_, required) Conditions for the filter. **Available Version:** 62.0 ### DataSpaceMemberInputRepresentation Data Space Member Input Represents the member details for updating a data space. * `filter` (_array of DataSpaceFilterInputRepresentation_, required) Filter applied on the data space member. **Available Version:** 62.0 * `memberName` (_string_, required) Developer name of the data space member. **Available Version:** 62.0 ### DataSpaceFilterConditionRepresentation Data Space Filter Condition Output Represents the data space filter condition. * `fieldName` (_string_) Field name to apply the filter condition. **Filter Group:** Small **Available Version:** 61.0 * `filterValue` (_string_) Value of the filter condition. **Filter Group:** Small **Available Version:** 61.0 * `operator` (_string_) Operator of the filter condition. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `ContainsAnyOperator`, `EqualsOperator`, `GreaterThanOperator`, `InOperator`, `IsEmptyStringOperator`, `IsNotEmptyStringOperator`, `IsNotNullOperator`, `IsNullOperator`, `LastNumberOfDaysOperator`, `LessThanOperator`, `NotEqualsOperator`, `NotInOperator`. * `tableName` (_string_) Name of the table to apply the filter condition. **Filter Group:** Small **Available Version:** 61.0 ### DataConnectorDetailsConfig Data Connector Details Config Input Represents the configuration details for a data connector. Includes all fields of `ConnectorDetailsConfig`. * `name` (_string_) Name of the data connector. **Available Version:** 62.0 ### IngestApiConnectorDetailsConfig Ingest API Connector Details Config Input Represents the configuration details for an Ingestion API connector. Includes all fields of `ConnectorDetailsConfig`. * `events` (_array of string_) List of developer names of events from the schema selected from the connected app. **Available Version:** 63.0 * `name` (_string_) Name of the Ingestion API connector. **Available Version:** 63.0 ### CrmConnectorDetailsConfig CRM Connector Details Config Input Represents the configuration details for a CRM connector. Includes all fields of `ConnectorDetailsConfig`. * `name` (_string_) Name of the CRM connector. **Available Version:** 63.0 * `sourceObject` (_string_) Developer name of the source object. **Available Version:** 63.0 ### SalesforceMarketingCloudConnectorDetailsConfig Salesforce Marketing Cloud Connector Details Config Input Represents the configuration details for a Salesforce Marketing Cloud connector. Includes all fields of `ConnectorDetailsConfig`. * `eid` (_string_) Enterprise ID of the Marketing Cloud account. **Filter Group:** Small **Available Version:** 63.0 * `mid` (_string_) Member ID (business unit) of the Marketing Cloud account. **Filter Group:** Small **Available Version:** 63.0 * `subType` (_string_) The subtype of the connector details, either `SalesforceMarketingCloudStandard` or `SalesforceMarketingCloudDataExtension`. **Filter Group:** Small **Available Version:** 63.0 ### StreamingConnectorDetailsConfig Streaming Connector Details Config Input Represents the configuration details for a streaming connector. Includes all fields of `ConnectorDetailsConfig`. * `category` (_string_) Category of the connector events. **Available Version:** 63.0 Allowed values: `Directory_Table`, `Engagement`, `Insights`, `Other`, `Profile`. * `events` (_array of string_) List of developer names of events from the schema selected from the connected app. **Available Version:** 63.0 * `name` (_string_) Name of the streaming connector. **Available Version:** 63.0 * `streamingAppType` (_string_) Type of streaming app. **Available Version:** 63.0 Allowed values: `MobileApp`, `ServerApp`, `WebApp`. ### DataStreamFrequencyInputRepresentation Data Stream Frequency Input Represents the input for a data stream refresh frequency. * `frequencyType` (_string_) Type of frequency. **Available Version:** 60.0 Allowed values: `Daily`, `Hourly`, `Minutely`, `Monthly`, `MonthlyRelative`, `Weekly`, `None`, `Transform`. * `hours` (_array of integer_) Hours in the frequency. **Available Version:** 60.0 * `refreshDayOfMonth` (_array of integer_) Refresh day of the month. **Available Version:** 60.0 * `refreshDayOfWeek` (_string_) Refresh day of the week. **Available Version:** 60.0 Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. ### DataConnectorDetailsRepresentation Data Connector Details Output Represents the output for a data connector. Includes all fields of `ConnectorDetailsRepresentation`. ### IngestionApiConnectorDetailsRepresentation Ingestion API Connector Details Output Represents the output for an Ingestion API connector. Includes all fields of `ConnectorDetailsRepresentation`. * `events` (_array of string_) Develoepr names of the Ingestion API connector events. **Available Version:** 61.0 ### CrmConnectorDetailsRepresentation CRM Connector Details Output Represents the output for a CRM connector. Includes all fields of `ConnectorDetailsRepresentation`. * `sourceObject` (_string_) Developer name of the source object. **Available Version:** 61.0 ### SalesforceMarketingCloudConnectorDetailsRepresentation Salesforce Marketing Cloud Connector Details Output Represents the output for a Salesforce Marketing Cloud connector. Includes all fields of `ConnectorDetailsRepresentation`. * `eid` (_string_) Enterprise ID of the Marketing Cloud account. **Filter Group:** Small **Available Version:** 63.0 * `mid` (_string_) Member ID (business unit) of the Marketing Cloud account. **Filter Group:** Small **Available Version:** 63.0 ### StreamingConnectorDetailsRepresentation Streaming Connector Details Output Represents the output for a streaming connector. Includes all fields of `ConnectorDetailsRepresentation`. * `category` (_string_) Category of the streaming connector. **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `events` (_array of string_) Developer names of the streaming connector events. **Available Version:** 60.0 * `streamingAppType` (_string_) Type of streaming connector app, such as `WebApp` or `MobileApp`. **Available Version:** 60.0 ### DataStreamFrequencyRepresentation Data Stream Frequency Output Information about when a data stream is refreshed. * `frequencyType` (_string_) How often the data stream is refreshed. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Daily`, `Hourly`, `Minutely`, `Monthly`, `MonthlyRelative`, `Weekly`, `None`. * `hours` (_array of integer_) List of the hours at which the data stream is refreshed. **Filter Group:** Small **Available Version:** 60.0 * `refreshDayOfMonth` (_array of integer_) Which day of the month the data stream is refreshed. **Filter Group:** Small **Available Version:** 60.0 * `refreshDayOfWeek` (_string_) Which day of the week the data stream is refreshed. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`. ### ConnectorPatchDetailsConfig Connector Patch Details Config Output Represents the configuration details for a connector type. ### DcSqlDataTransformManifestInputRepresentation Dc Sql Data Transform Manifest Input Input representation of the DCSQL transform manifest format * `macros` (_object_) Map of DC SQL manifest macros. **Available Version:** 63.0 Additional properties: `object`. * `nodes` (_object_) Map of DC SQL manifest nodes. **Available Version:** 63.0 Additional properties: `object`. * `sources` (_object_) Map of DC SQL manifest sources. **Available Version:** 63.0 Additional properties: `object`. ### DataTransformNodeInputRepresentation Data Transform Node Input Represents a single node in a series of nodes that make up a batch data transform. * `action` (_string_, required) Action that determines the type of node. Use the node input object that corresponds to the type of action. For example, use the Aggregate Node Input for the `Aggregate` action. **Available Version:** 60.0 Allowed values: `Aggregate`, `Append_V2`, `Bucket`, `ComputeRelative`, `DateFormatConversion`, `Extension`, `Extract`, `Filter`, `Formula`, `Join`, `Load`, `OutputD360`, `Recommendation`, `Save`, `Schema`, `Split`, `SqlFilter`, `TypeCast`, `Update`. * `schema` (_object_) Schema changes for the node. **Available Version:** 60.0 Includes all fields of `SchemaParametersInputRepresentation`. * `sources` (_array of string_, required) Source node IDs. **Available Version:** 60.0 ### DcSqlDataTransformManifestRepresentation Dc Sql Data Transform Manifest Output Represents the manifest format of a DC SQL transform. * `macros` (_object_) Description of the manifest. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `object`. Map of manifest macros. **Filter Group:** Small **Available Version:** 63.0 * `arguments` (_array of DcSqlDataTransformMacroArgumentRepresentation_) List of arguments. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the macro. **Filter Group:** Small **Available Version:** 63.0 * `resource_type` (_string_) Type of node resource. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `macro`, `model`, `source`. * `nodes` (_object_) Map of nodes. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `object`. Properties of the manifest node. **Filter Group:** Small **Available Version:** 63.0 * `compiled_code` (_string_) Compiled code. **Filter Group:** Small **Available Version:** 63.0 * `config` (_object_) Configuration of the manifest node. **Available Version:** 63.0 Includes all fields of `DcSqlDataTransformNodeConfigurationRepresentation`. * `depends_on` (_object_) Node dependencies. **Available Version:** 63.0 Includes all fields of `DcSqlDataTransformDependsOnRepresentation`. * `name` (_string_) Name of the node. **Filter Group:** Small **Available Version:** 63.0 * `relation_name` (_string_) Name of the table that this node writes to. **Filter Group:** Small **Available Version:** 63.0 * `resource_type` (_string_) Type of node resource. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `macro`, `model`, `source`. * `sources` (_object_) Map of manifest sources. **Filter Group:** Small **Available Version:** 63.0 Additional properties: `object`. Properties of the manifest sources. **Filter Group:** Small **Available Version:** 63.0 * `relation_name` (_string_) Name of the table this transform reads from. **Filter Group:** Small **Available Version:** 63.0 * `resource_type` (_string_) Type of node resource. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `macro`, `model`, `source`. ### DataTransformNodeRepresentation Data Transform Node Output Represents a batch data transform node. * `action` (_string_, required) Action that determines the type of node. The endpoint returns the node output object that corresponds to the type of action. For example, the Aggregate Node Output is returned for the `Aggregate` action. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Aggregate`, `Append_V2`, `Bucket`, `ComputeRelative`, `DateFormatConversion`, `Extension`, `Extract`, `Filter`, `Formula`, `Join`, `Load`, `OutputD360`, `Recommendation`, `Save`, `Schema`, `Split`, `SqlFilter`, `TypeCast`, `Update`. * `schema` (_object_) Schema changes to output. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaParametersRepresentation`. * `sources` (_array of string_, required) Input nodes. **Filter Group:** Small **Available Version:** 60.0 ### CdpScheduleRepresentation Schedule Output Represents a schedule. Includes all fields of `CdpScheduleBaseRepresentation`. * `frequency` (_string_, required) Frequency on which this schedule is run. Only `None` and `Hourly` are valid for Data Transforms. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Hourly`, `None`. * `nextScheduledDate` (_string_, required) Next scheduled date (in UTC) for this schedule. **Filter Group:** Small **Available Version:** 60.0 * `time` (_object_, required) Time when the schedule starts. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `CdpTimeRepresentation`. ### DataTransformRunHistoryBaseRepresentation Data Transform Run History Base Output Represents the run history of a data transform. The run history for batch data transforms contains different information than the run history for streaming data transforms, so the response payloads are different. * `definitionName` (_string_) Name of the data transform definition. **Filter Group:** Small **Available Version:** 63.0 * `duration` (_number (int64)_) Duration of the data transform run in seconds. **Filter Group:** Small **Available Version:** 62.0 * `endTime` (_string_) End date and time of the data transform run. **Filter Group:** Small **Available Version:** 62.0 * `errorMessage` (_string_) If an error occurred, contains the error's description. If no error occurred, this parameter isn't returned. **Filter Group:** Small **Available Version:** 62.0 * `isVersionChanged` (_boolean_) Indicates whether the data transform version changed since the last job (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 62.0 * `processedRows` (_integer (int64)_) Either the number of input or output rows processed, whichever is larger. **Filter Group:** Small **Available Version:** 62.0 * `requestId` (_string_) Request ID correlating this data transform run with upstream services. **Filter Group:** Small **Available Version:** 67.0 * `startTime` (_string_) Start time of the data transform job. **Filter Group:** Small **Available Version:** 62.0 * `status` (_string_) Status of the data transform run. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Canceled`, `Failure`, `InProgress`, `None`, `PartialFailure`, `PartiallyCanceled`, `Pending`, `RebuildFailure`, `RebuildPending`, `RebuildSuccess`, `Rebuilding`, `SkippedNoChanges`, `Success`. * `type` (_string_, required) Type of data transform. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Batch`, `Streaming`. ### RunHistoryOutputProgressRepresentation Run History Output Progress Output For a batch data transform, contains information about the output node that the transformed data is written to. * `completedDate` (_string_) Date and time when the data transform finished writing to the output node. **Filter Group:** Small **Available Version:** 62.0 * `dataObjectName` (_string_) Developer name of the object used as the data transform's output node. **Filter Group:** Small **Available Version:** 62.0 * `dataObjectType` (_string_) Type of object used for the data transform's output node. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `DataLakeObject`, `DataModelObject`. * `name` (_string_) Name of the data transform's output node. **Filter Group:** Small **Available Version:** 62.0 * `status` (_string_) Status of the result in the output node. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Error`, `Pending`, `Running`, `Success`. * `totalRows` (_integer (int64)_) Total number of rows written to the output node. **Filter Group:** Small **Available Version:** 62.0 ### IdpFileAdditionalParamsInputRepresentation Represents the additional parameters for file processing in IDP. * `sheetName` (_string_) Name of the sheet to extract data from, for Excel and Google Sheets files. **Available Version:** 67.0 ### IdpSchemaDetectionPagesRepresentation Idp Schema Detection Pages Output Represents the pages in an IDP schema detection output. * `matchingScore` (_number (double)_) Matching score for the associated schema. **Filter Group:** Small **Available Version:** 67.0 * `pageNumber` (_integer_) Page number from the document. **Filter Group:** Small **Available Version:** 67.0 ### IdpConfigExtractedDloFieldInputRepresentation Document AI Config Extracted DLO Field Input This type contains the fields required to configure an extracted field. * `name` (_string_, required) Name of the extracted field. This is the identifier for the field in the extracted data. **Available Version:** 63.0 * `label` (_string_, required) Display label for the extracted field. This is the human-readable name for the field. **Available Version:** 63.0 * `dataType` (_string_, required) Data type of the extracted field. Specifies how the field data should be interpreted. **Available Version:** 63.0 Allowed values: `STRING`, `NUMBER`, `DATE`, `BOOLEAN`. * `required` (_boolean_, required) Whether the field is required. Indicates if this field must have a value in the extracted data. **Available Version:** 63.0 * `validationRules` (_object_) Validation rules for the extracted field. Defines additional validation criteria for the field data. **Available Version:** 63.0 ### IdpConfigExtractedDloFieldRepresentation Document AI Config Extracted DLO Field Output This type defines the properties and validation rules for an extracted field. * `dloField` (_object_) The output DLO field. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `schemaName` (_string_) The JSON array property name that maps to this DLO. The value is `null` for the root DLO. **Filter Group:** Small **Available Version:** 63.0 ### CdpIdentityResolutionMatchCriterionOutput Identity Resolution Match Criterion Output Represents a match rule criterion for an identity resolution ruleset. * `caseSensitiveMatch` (_boolean_) Specifies whether the criterion match is case sensitive (`true`) or not (`false`). Available only when matching is based on the [party identifier](https://help.salesforce.com/s/articleView?id=data.c360_a_match_rules.htm&type=5). **Filter Group:** Small **Available Version:** 58.0 * `entityName` (_string_) API name of the data model object the match rule applies to. **Filter Group:** Small **Available Version:** 57.0 * `fieldName` (_string_) Name of the field the criterion applies to. **Filter Group:** Small **Available Version:** 57.0 * `matchMethodType` (_string_) Match method for a match rule criterion. **Filter Group:** Small **Available Version:** 57.0 Allowed values: `Exact`, `ExactNormalized`, `Fuzzy`, `FuzzyHigh`, `FuzzyLow`. * `partyIdentificationInfo` (_object_) Party Identification information. **Filter Group:** Small **Available Version:** 57.0 Includes all fields of `CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput`. * `shouldMatchOnBlank` (_boolean_) Specifies whether blank fields can be used for matching (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 57.0 ### CdpIdentityResolutionReconciliationFieldRuleOutput Identity Resolution Reconciliation Field Rule Output Represents the reconciliation rule for a field of an identity resolution ruleset. * `fieldName` (_string_) The field that this reconciliation rule applies to. **Filter Group:** Small **Available Version:** 57.0 * `ruleType` (_string_) Default reconciliation rule applied to fields in the object the reconciliation rule applies to. **Filter Group:** Small **Available Version:** 57.0 Allowed values: `LastUpdated`, `MostFrequent`, `SourceSequence`. * `shouldIgnoreEmptyValue` (_boolean_) Specifies whether to ignore an empty value (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 57.0 * `sources` (_array of CdpIdentityResolutionReconciliationSourceOutput_) If `ruleType` is `SourceSequence`, a prioritized list of data sources. **Filter Group:** Small **Available Version:** 57.0 ### CdpIdentityResolutionReconciliationSourceOutput Identity Resolution Reconciliation Source Output Source for an identity resolution default reconciliation rule or field-specific rule using the SourceSequence match method. * `name` (_string_) If the `ruleType` for a reconciliation rule is `SourceSequence`, API name of a source data lake object. **Filter Group:** Small **Available Version:** 57.0 ### KnowledgeSpaceDeepResearchPlanStepOutputRepresentation Knowledge Space Deep Research Plan Step Output Represents a step in a deep research plan. * `description` (_string_) Description of what the step does. **Filter Group:** Small **Available Version:** 67.0 * `title` (_string_) Title or name of the step. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceDeepResearchPlanStepInputRepresentation Knowledge Space Deep Research Plan Step Input Represents a step in a deep research plan. Includes all fields of `CdpAssetBaseInputRepresentation`. * `description` (_string_) Description of what the step does. **Available Version:** 67.0 * `title` (_string_) Title or name of the step. **Available Version:** 67.0 ### CdpMlModelFieldBaseRepresentation ML Model Field Base Output Represents a base ML model field. Includes all fields of `CdpMlFieldRepresentation`. * `dataType` (_string_) The field's data type. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Boolean`, `Date`, `Number`, `Text`. * `position` (_integer_) Field's position. **Filter Group:** Small **Available Version:** 61.0 ### CdpMlAggregatePredictConditionRepresentation ML Aggregate Predict Condition Output Represents an ML aggregate prediction contribution. Includes all fields of `CdpMlPredictionContributionBaseRepresentation`. * `count` (_integer_) Number of rows included in the aggregate condition. **Filter Group:** Small **Available Version:** 61.0 ### MlPredictionJobDefPredictionMappingRepresentation Ml Prediction Job Def Prediction Mapping Output Represents the output for prediction job mappings. * `mappedField` (_object_) Mapped field details from the output data model object (DMO). **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefMappedFieldRepresentation`. * `modelField` (_object_) Model feature details from a model output feature, if any. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `sourceField` (_object_) Source field details from an input DMO, if any. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefMappedFieldRepresentation`. ### MlRetrieverCitationFieldRepresentation Ml Retriever Citation Field Output Represents a citation field reference. Includes all fields of `MlRetrieverFieldBaseRepresentation`. ### MlRetrieverFieldBaseRepresentation Ml Retriever Field Base Output Represents a field reference. Includes all fields of `CdpAssetBaseRepresentation`. * `relatedDmo` (_object_) Related data model object (DMO) reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `relatedDmoField` (_object_) Related DMO field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. ### MlDmoFieldSourceTargetRelationshipRepresentation Ml Dmo Field Source Target Relationship Output Represents a relationship between two data model objects (DMOs). Includes all fields of `CdpAssetBaseRepresentation`. * `parentRelationshipId` (_string_) ID of the parent relationship. **Filter Group:** Small **Available Version:** 61.0 * `relationSourceDmo` (_object_) Source DMO reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `relationSourceDmoField` (_object_) Source DMO field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `relationTargetDmo` (_object_) Target DMO reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `relationTargetDmoField` (_object_) Target DMO field reference. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpAssetReferenceRepresentation`. ### CdpMlFilterCriterionBaseRepresentation Ml Filter Criterion Base Output Represents a filter criterion. Discriminator: `type` selects the concrete type. * `operator` (_string_) Operator of the filter. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `EqualTo`, `GreaterThan`, `GreaterThanOrEqualTo`, `In`, `LessThan`, `LessThanOrEqualTo`, `Like`, `NotEqualTo`, `NotIn`. * `type` (_string_) Type of filter. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `CalculatedInsightObjectField`, `DataModelObjectField`, `ModelInputField`, `SemanticSearchVectorEmbedRelatedField`. * `values` (_array of CdpMlFilterValueRepresentation_) List of values to apply in the filter. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplateDataCloudAssetRepresentation Ml Retriever Query Template Data Cloud Asset Output Represents a Data Cloud asset referenced in the query template. * `assetApiName` (_string_) API name of the asset. **Filter Group:** Small **Available Version:** 61.0 * `assetType` (_string_) Type of asset. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `CalculatedInsight`, `DataLakeObject`, `DataModelObject`, `SearchIndex`. ### MlRetrieverQueryEnrichedSearchIndexDefinitionRepresentation Ml Retriever Query Enriched Search Index Definition Output Represents an enriched search index definition. * `chunkColumnName` (_string_) Name or alias of the SELECT column containing chunk content. **Filter Group:** Small **Available Version:** 61.0 * `chunkRecordIdColumnName` (_string_) Name or alias of the SELECT column containing the chunk record ID. **Filter Group:** Small **Available Version:** 61.0 * `searchIndexApiName` (_string_) API name of the enriched search index. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplateCitationDefinitionCustomRepresentation Ml Retriever Query Template Citation Definition Custom Output Represents a custom citation definition where label and link are defined by user-specified columns. CustomSql only. Includes all fields of `MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation`. * `customBaseUrl` (_string_) Base URL that the `customLinkColumnName` value is appended to. For example, if `customBaseUrl` is "[https://example.com](https://example.com)" and the column contains "/docs/article-123", the resulting URL is "[https://example.com/docs/article-123](https://example.com/docs/article-123)". **Filter Group:** Small **Available Version:** 67.0 * `customLinkColumnName` (_string_) Name or alias of the SELECT column used as the citation link. When `customBaseUrl` is provided, this field's value is appended to it to construct the complete URL. **Filter Group:** Small **Available Version:** 67.0 ### MlRetrieverQueryTemplateCitationDefinitionDefaultRepresentation Ml Retriever Query Template Citation Definition Default Output Retriever query template citation definition for Default citation type. CustomSql only. Includes all fields of `MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation`. * `chunkObjectApiName` (_string_) API name of the chunk data model object (DMO) from a search index whose source DMO matches the `sourceObjectApiName`. Applies only when `sourceObjectApiName` is an unstructured (UDMO/HUDMO) DMO; ignored otherwise. When set, enables harmonized viewer and multimodal citations. **Filter Group:** Small **Available Version:** 67.0 * `chunkRecordIdColumnName` (_string_) Name or alias of the SELECT column used as the chunk record ID. Required when the `chunkObjectApiName` search index is not real-time; must NOT be set when that index is real-time (JIT). **Filter Group:** Small **Available Version:** 67.0 * `sourceObjectApiName` (_string_) API name of the source DMO whose records are cited. Required when citationType is `Default`. **Filter Group:** Small **Available Version:** 67.0 * `sourceRecordIdColumnName` (_string_) Name or alias of the SELECT column used as the source record ID. Required when citationType is `Default`. **Filter Group:** Small **Available Version:** 67.0 ### MlRetrieverQueryTemplateMetadataRepresentation Ml Retriever Query Template Metadata Output Represents query template metadata. * `selectColumns` (_array of MlRetrieverQueryTemplateMetadataSelectColumnRepresentation_) List of SELECT columns in the SQL query. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplatePlaceholderRepresentation Ml Retriever Query Template Placeholder Output Represents a parameter in the SQL query template. * `placeholderDataType` (_string_) Data type of the parameter. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `ArrayOfText`, `Boolean`, `Date`, `DateTime`, `Number`, `Text`. * `placeholderDescription` (_string_) Description of the parameter. **Filter Group:** Small **Available Version:** 61.0 * `placeholderLabel` (_string_) Label of the parameter. **Filter Group:** Small **Available Version:** 61.0 * `placeholderName` (_string_) Name of the parameter. For `CustomSql` with `placeholderType: NamedParameter`, the format is `":\"parameter\""`. For `NoCode` with `placeholderType: Placeholder`, the format is `"{!$parameter}"`. Must be unique in the SQL query template. **Filter Group:** Small **Available Version:** 61.0 * `placeholderType` (_string_) Type of parameter. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `NamedParameter`, `Placeholder`. * `placeholderValue` (_string_) Default value of the parameter. **Filter Group:** Small **Available Version:** 61.0 ### QuerySqlRowRepresentation Query SQL Row Output Represents data fetched by the Query SQL request. * `row` (_array of object_) List of column values. **Filter Group:** Small **Available Version:** 63.0 ### QuerySqlMetadataItemRepresentation Query SQL Metadata Item Output Represents metadata associated with the Query SQL request. * `innerElement` (_string_) Description of array fields. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 63.0 * `nullable` (_boolean_) If `true`, the field is nullable. **Filter Group:** Small **Available Version:** 63.0 * `precision` (_integer_) Precision for numeric fields. **Filter Group:** Small **Available Version:** 63.0 * `scale` (_integer_) Scale for numeric fields. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of the field. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `ArrayOfX`, `BigInt`, `Bool`, `Char`, `Date`, `Double`, `Float`, `Integer`, `Numeric`, `Oid`, `SmallInt`, `Time`, `Timestamp`, `TimestampTZ`, `Unspecified`, `Varchar`. ### FieldLevelConfigurationInputRepresentation Field Level Configuration Input Represents the input for field-level configurations. * `config` (_object_) Field-level configuration. **Available Version:** 60.0 Includes all fields of `ConfigInputRepresentation`. * `decorators` (_array of DecoratorInputRepresentation_) Chunking decorators. **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_) Source DMO developer name. **Available Version:** 60.0 * `sourceDmoFieldDeveloperName` (_string_) Source DMO field developer name. **Available Version:** 60.0 * `sourceDmoFieldName` (_string_) Source DMO field name. **Available Version:** 61.0 * `sourceDmoName` (_string_) Source DMO name. **Available Version:** 61.0 * `version` (_string_) Version of the chunking configuration. **Available Version:** 60.0 ### ContextFieldConfigurationInputRepresentation Context Field Configuration Input Represents the input for context field configurations. Includes all fields of `IndexFieldConfigurationInputRepresentation`. ### RecordFieldConfigurationInputRepresentation Record Field Configuration Input Represents the input for record field configurations. Includes all fields of `IndexFieldConfigurationInputRepresentation`. * `tokenizations` (_array of TokenizationInputRepresentation_) List of tokenizations. **Available Version:** 58.0 ### SourceTargetRelationshipInputRepresentation Source Target Relationship Input Represents the input for the relationship to a source search index data model object (DMO). Includes all fields of `CdpAssetBaseInputRepresentation`. * `sourceDmoDeveloperName` (_string_, required) Source DMO developer name. **Available Version:** 60.0 * `sourceDmoFieldDeveloperName` (_string_, required) Source DMO field developer name. **Available Version:** 60.0 * `sourceDmoLabel` (_string_) Source DMO label. **Available Version:** 61.0 * `sourceFieldLabel` (_string_) Source DMO field label. **Available Version:** 61.0 * `targetDmoDeveloperName` (_string_, required) Target DMO developer name. **Available Version:** 60.0 * `targetDmoFieldDeveloperName` (_string_, required) Target DMO field developer name. **Available Version:** 60.0 * `targetDmoLabel` (_string_) Target DMO label. **Available Version:** 61.0 * `targetFieldLabel` (_string_) Target DMO field label. **Available Version:** 61.0 ### TransformFileLevelConfigurationInputRepresentation Transform File Level Configuration Input Represents the input for a file transform configuration. * `config` (_object_) Transform configuration. **Available Version:** 61.0 Includes all fields of `ConfigInputRepresentation`. * `fileExtensions` (_array of string_) File extensions list, for example, ``. **Available Version:** 61.0 ### VectorEmbeddingRelatedFieldsInputRepresentation Vector Embedding Related Fields Input Represents the input for vector-embedding extra fields. Includes all fields of `CdpAssetBaseInputRepresentation`. * `relatedDmoDeveloperName` (_string_) Related data model object (DMO) developer name. **Available Version:** 60.0 * `relatedDmoFieldDeveloperName` (_string_) Related DMO field developer name. **Available Version:** 60.0 * `relatedDmoFieldName` (_string_) Related DMO field name. **Available Version:** 61.0 * `relatedDmoName` (_string_) Related DMO name. **Available Version:** 61.0 * `relationshipCardinality` (_string_) Relationship cardinality between the source DMO field and target DMO field. For example, `OneToOne`, `ManyToOne`, or `OneToMany`. **Available Version:** 64.0 * `relationships` (_array of SourceTargetRelationshipInputRepresentation_) Field relationship paths. **Available Version:** 60.0 ### ConfigInputRepresentation Config Input Represents the input for the general configuration shared across chunking and vector configurations. * `id` (_string_) ID of the configuration. **Available Version:** 60.0 * `userValues` (_array of UserValueInputRepresentation_) User input values. **Available Version:** 60.0 ### FieldLevelChunkingConfigurationRepresentation Field Level Chunking Configuration Output Represents the field level chunking configuration details. * `config` (_object_) Configuration for the field level chunking. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FieldLevelConfigurationRepresentation`. * `decorators` (_array of DecoratorRepresentation_) The decorators. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_) Source DMO developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoFieldDeveloperName` (_string_) Source DMO field developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoFieldName` (_string_) Source DMO field name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoName` (_string_) Source DMO name. **Filter Group:** Small **Available Version:** 60.0 ### PerFileExtensionRepresentation Per File Extension Output Represents the per-file extension details. * `config` (_object_) Configuration of the file details. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ConfigRepresentation`. * `fileExtension` (_string_) File extension, for example `html`. **Filter Group:** Small **Available Version:** 60.0 ### ContextFieldConfigurationRepresentation Context Field Configuration Output Represents context field configurations. Includes all fields of `IndexFieldConfigurationRepresentation`. ### RecordFieldConfigurationRepresentation Record Field Configuration Output Represents record field configurations. Includes all fields of `IndexFieldConfigurationRepresentation`. * `tokenizations` (_array of TokenizationRepresentation_) List of tokenizations. **Filter Group:** Small **Available Version:** 64.0 ### FieldRelationshipsPathRepresentation Field Relationships Path Output Field relationships path representation * `apiName` (_string_) API name. **Filter Group:** Small **Available Version:** 60.0 * `parentRelationshipId` (_string_) Parent relationship ID. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoDeveloperName` (_string_) Source DMO developer name. **Filter Group:** Small **Available Version:** 60.0 * `sourceDmoLabel` (_string_) Source DMO Label. **Filter Group:** Small **Available Version:** 60.0 * `sourceFieldId` (_string_) Source field's ID. **Filter Group:** Small **Available Version:** 60.0 * `sourceFieldLabel` (_string_) The source field's label. **Filter Group:** Small **Available Version:** 60.0 * `sourceFieldName` (_string_) Source field's name. **Filter Group:** Small **Available Version:** 60.0 * `targetDmoDeveloperName` (_string_) Target DMO's developer name. **Filter Group:** Small **Available Version:** 60.0 * `targetDmoLabel` (_string_) Target DMO's label. **Filter Group:** Small **Available Version:** 60.0 * `targetFieldId` (_string_) Target field's ID. **Filter Group:** Small **Available Version:** 60.0 * `targetFieldLabel` (_string_) Target field's label. **Filter Group:** Small **Available Version:** 60.0 * `targetFieldName` (_string_) Target field's name. **Filter Group:** Small **Available Version:** 60.0 ### TransformFileLevelConfiguration Transform File Level Configuration Output Represents the file-level configuration for a transform. * `config` (_object_) The configuration. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ConfigRepresentation`. * `fileExtensions` (_array of string_) The list of file extensions, for example, ``. **Filter Group:** Small **Available Version:** 60.0 ### VectorEmbeddingRelatedFieldsDetailsRepresentation Vector Embedding Related Fields Details Output Represents vector-embedding related fields details. * `fieldRelationshipPathId` (_string_) Relationships path ID. **Filter Group:** Small **Available Version:** 60.0 * `id` (_string_) Record ID. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoDeveloperName` (_string_) Related data model object's (DMO's) developer name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldDeveloperName` (_string_) Related DMO's field developer name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldId` (_string_) Related DMO's field ID. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoFieldName` (_string_) Related DMO's field name. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoId` (_string_) Related DMO's ID. **Filter Group:** Small **Available Version:** 60.0 * `relatedDmoName` (_string_) Related DMO's name. **Filter Group:** Small **Available Version:** 60.0 * `relationships` (_array of FieldRelationshipsPathRepresentation_) List of relationships. **Filter Group:** Small **Available Version:** 60.0 ### VectorConfigElementRepresentation Vector Config Element Output Represents details of part of a vector embedding config representation. * `id` (_string_) ID, for example `HNSW`. * `userValues` (_array of UserValuesRepresentation_) User values, for example `{ hnswEfConstruction : 8 }` **Filter Group:** Small **Available Version:** 60.0 ### CdpSegmentDbtModelInputRepresentation Segment Dbt Model Input Represents the input for a single DBT model. * `name` (_string_) Name of the DBT model. **Available Version:** 55.0 * `sql` (_string_) SQL for the DBT model. **Available Version:** 55.0 ### ScheduleInputRepresentation Schedule Input Base schedule input representation. Discriminator: `frequency` selects the concrete type. Mapping: `Daily` → `DailyScheduleInputRepresentation`, `Hourly` → `CdpHourlyScheduleInputRepresentation`, `Minutely` → `CdpMinutelyScheduleInputRepresentation`, `Monthly` → `MonthlySpecificScheduleInputRepresentation`, `MonthlyRelative` → `CdpMonthlyRelativeScheduleInputRepresentation`, `None` → `CdpNoneScheduleInputRepresentation`, `Weekly` → `WeeklyScheduleInputRepresentation`. * `definitionName` (_string_) Name of the schedule definition. **Available Version:** 63.0 * `frequency` (_string_, required) Frequency on which the schedule is run. `None` removes the schedule and is the default. **Available Version:** 58.0 Allowed values: `Daily`, `Hourly`, `Minutely`, `Monthly`, `MonthlyRelative`, `Weekly`, `None`, `Transform`. * `timeInfo` (_object_) When to run the schedule. **Available Version:** 58.0 Includes all fields of `CdpTimeInputRepresentation`. ### CdpSegmentDbtModelOutputRepresentation Segment DBT Model Output Represents segment DBT model output. * `name` (_string_) DBT Model Name * `sql` (_string_) DBT Model SQL ### ScheduleOutputRepresentation Schedule Info Output Represents additional information about the segment publish schedule. Discriminator: `frequency` selects the concrete type. Mapping: `Daily` → `DailyScheduleRepresentation`, `Hourly` → `CdpHourlyScheduleRepresentation`, `Minutely` → `CdpMinutelyScheduleRepresentation`, `Monthly` → `MonthlySpecificScheduleRepresentation`, `MonthlyRelative` → `CdpMonthlyRelativeScheduleRepresentation`, `None` → `CdpNoneScheduleRepresentation`, `Weekly` → `WeeklyScheduleRepresentation`. * `frequency` (_string_) Publish schedule frequency. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Daily`, `Hourly`, `Minutely`, `Monthly`, `MonthlyRelative`, `Weekly`, `None`, `Transform`. * `nextScheduledDate` (_string_) Next scheduled date to publish the segment. **Filter Group:** Small **Available Version:** 63.0 * `timeInfo` (_TimeOutputRepresentation_) Additional information about the publish schedule time. **Filter Group:** Small **Available Version:** 63.0 ### TimeOutputRepresentation Time Output Represents the time in a publish schedule. * `hour` (_integer_) Hour amount. **Filter Group:** Small **Available Version:** 63.0 * `minute` (_integer_) Minute amount. **Filter Group:** Small **Available Version:** 63.0 * `timezone` (_object_) Timezone of the publish schedule. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `SegmentTimeZoneRepresentation`. ### ActivationPlatformCustomEventInputRepresentation Activation Platform Custom Event Input Represents the input for custom event details. * `attributeMappingInfo` (_array of ActivationPlatformEventAttributeMappingInputRepresentation_) Attribute mapping rules for custom events. **Available Version:** 67.0 * `attributesOverride` (_object_) Attribute override categorization for custom events. **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventAttributeOverrideInputRepresentation`. ### ActivationPlatformStandardEventInputRepresentation Activation Platform Standard Event Input Represents the input for standard event details. * `attributeMappingInfo` (_array of ActivationPlatformEventAttributeMappingInputRepresentation_) Attribute mapping rules per event/action-source combination. **Available Version:** 67.0 * `eventParameterHierarchy` (_array of ActivationEventParameterHierarchyInputRepresentation_) Hierarchy combinations defining valid parameter value pairings. **Available Version:** 67.0 * `eventParameters` (_array of ActivationEventParameterValuesInputRepresentation_) Event parameter definitions with hierarchy and allowed values. **Available Version:** 67.0 ### ActivationPlatformCustomEventRepresentation Activation Platform Custom Event Output Represents custom event details with attribute overrides. * `attributeMappingInfo` (_array of ActivationPlatformEventAttributeMappingRepresentation_) Attribute mapping rules for custom events. **Filter Group:** Small **Available Version:** 67.0 * `attributesOverride` (_object_) Attribute override categorization for custom events. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventAttributeOverrideRepresentation`. ### ActivationPlatformStandardEventRepresentation Activation Platform Standard Event Output Represents standard event details, including event parameters, hierarchy, and attribute mapping info. * `attributeMappingInfo` (_array of ActivationPlatformEventAttributeMappingRepresentation_) Attribute mapping rules per event/action-source combination. **Filter Group:** Small **Available Version:** 67.0 * `eventParameterHierarchy` (_array of ActivationEventParameterHierarchyRepresentation_) Hierarchy combinations defining valid parameter value pairings. **Filter Group:** Small **Available Version:** 67.0 * `eventParameters` (_array of ActivationEventParameterValuesRepresentation_) Event parameter definitions with hierarchy and allowed values. **Filter Group:** Small **Available Version:** 67.0 ### QueryPathConfigInputRepresentation Query Path Config Input Represents the query path configuration input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `queryPaths` (_array of QueryPathInputRepresentationConfig_) List of query path configurations. **Available Version:** 60.0 ### AttributeFilterExpressionInputRepresentation Attribute Filter Expression Input Represents the attribute filter expression input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `conjunction` (_string_) Filter conjunction. **Available Version:** 60.0 Allowed values: `FilterConjunctionAnd`, `FilterConjunctionOr`. * `filters` (_array of AttributeFilterInputRepresentation_) Attribute filters. **Available Version:** 60.0 ### ContactPointAttributesConfigInputRepresentation Contact Point Attributes Config Input Represents the configuration input for the attributes of an activation contact point. * `attributes` (_array of ContactPointAttributeInputRepresentation_, required) List of attributes for the activations. **Available Version:** 63.0 ### ContactPointFilterExpressionInputRepresentation Contact Point Filter Expression Input Represents the input for an activation contact point filter expression. * `contactPointDmoFilters` (_array of DMOFilterInputRepresentation_, required) List of contact point DMO filters. **Available Version:** 63.0 ### ContactPointSourcesConfigInputRepresentation Contact Point Sources Config Input Represents the configuration input for contact point sources. * `contactPointSources` (_array of ContactPointSourceInputRepresentation_, required) List of contact point sources. **Available Version:** 63.0 ### AttributeFilterExpressionRepresentation Attribute Filter Expression Output Represents the activation attribute filter expression output. Includes all fields of `CdpAssetBaseRepresentation`. * `conjunction` (_string_) Conjunction for the activation attribute filter expression. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `FilterConjunctionAnd`, `FilterConjunctionOr`. * `filters` (_array of AttributeFilterRepresentation_) Filters for the activation attribute filter expression. **Filter Group:** Small **Available Version:** 60.0 ### ActivationContactPointsFieldConfigRepresentation Activation Contact Points Field Config Output Represents the activation contact point field configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `contactPointFields` (_array of ActivationContactPointFieldConfigRepresentation_) Fields for the contact point. ### ContactPointFilterExpressionRepresentation Contact Point Filter Expression Output Represents the activation contact point filter expression output. Includes all fields of `CdpAssetBaseRepresentation`. * `contactPointDmoFilters` (_array of DmoFilterRepresentation_) DMO filter expression for the contact point, used to apply filters to contact point attributes such as `Contact Point Email` and `Contact Point Phone`. It can be used to filter entries where the email ends with `@salesforce.com`. It is located within the `contactPoints` object. **Filter Group:** Small **Available Version:** 60.0 ### ActivationContactPointsSourceConfigRepresentation Activation Contact Points Source Config Output Represents the activation contact points source configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `contactPointSources` (_array of ActivationContactPointSourceConfigRepresentation_) Contact point sources for the activation. ### BaseComparisonRepresentation Base Comparison Output Represents the base comparison output. Abstract parent of: * [Entity Scoped Group Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AEntity%2BScoped%2BGroup%2BOutput) * [LogicalComparison Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3ALogical%2BComparison%2BOutput) * [Primitive Comparison Output](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3APrimitive%2BComparison%2BOutput) Includes all fields of `CdpAssetBaseRepresentation`. * `filters` (_array of TypeAndFilterRepresentation_) List of logical comparison filters. **Filter Group:** Small **Available Version:** 60.0 * `operator` (_string_) Operator. **Filter Group:** Small **Available Version:** 60.0 ### DmoFilterLimitRepresentation DMO Filter Limit Output Represents the DMO filter limit. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeName` (_string_) Name of the attribute in the DMO filter limit. **Filter Group:** Small **Available Version:** 63.0 * `maxNumberOfValues` (_integer_) Max number of values in the DMO filter limit. **Filter Group:** Small **Available Version:** 63.0 * `order` (_string_) Sort order for the DMO filter limit. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `FilterSortOrderAsc`, `FilterSortOrderDesc`. ### QueryPathRepresentation Query Path Output Represents a query path output. Includes all fields of `CdpAssetBaseRepresentation`. * `fieldLabel` (_string_) Field label for the query path. **Filter Group:** Small **Available Version:** 60.0 * `fieldName` (_string_) Field name for the query path. **Filter Group:** Small **Available Version:** 60.0 * `objectLabel` (_string_) Object label for the query path. **Filter Group:** Small **Available Version:** 60.0 * `objectName` (_string_) Object name for the query path. **Filter Group:** Small **Available Version:** 60.0 ### PartnerValidationErrorCountRepresentation Partner Validation Error Count Output Represents the count of publish errors of a single validation-error type. * `errorsCount` (_integer_) Number of errors of the type encountered during publish. **Filter Group:** Small **Available Version:** 67.0 * `validationErrorCodeId` (_integer_) Partner-specific error code identifier. **Filter Group:** Small **Available Version:** 67.0 * `validationErrorType` (_string_) Type of validation error reported by the partner platform. **Filter Group:** Small **Available Version:** 67.0 ### DataGraphInputRepresentation Data Graph Input Represents the input for a data graph. * `name` (_string_) Name of the data graph. **Available Version:** 66.0 ### DataGraphRepresentation Data Graph Output Represents a data graph. * `name` (_string_) Name of the data graph. **Filter Group:** Small **Available Version:** 66.0 ### UseCaseTemplateMemberConfigRepresentation Use Case Template Member Config Output Represents the member configuration details for a clean room template. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeConfigs` (_array of UseCaseTemplateAttributeConfigRepresentation_) Attribute configuration for use case template members. **Filter Group:** Small **Available Version:** 63.0 * `memberType` (_string_) Type of use case template member. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Consumer`, `Provider`. ### DataCleanRoomMetadataMemberConfigRepresentation Data Clean Room Metadata Member Config Output Represents the metadata member configuration for a clean room. * `canReceiveResult` (_boolean_) Indicates whether the member can receive results (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `canTriggerQuery` (_boolean_) Indicates whether the member can trigger queries (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `contributesData` (_boolean_) Indicates whether the member contributes data (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `outputConfig` (_object_) Output configuration for query results. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMetadataOutputConfigRepresentation`. * `paysForQueries` (_boolean_) Indicates whether the member pays for queries (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `type` (_string_) Type of member. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Consumer`, `Provider`. ### DataCleanRoomMatchBoostUsecaseConfigRepresentation Data Clean Room Match Boost Usecase Config Output Represents the configuration for a match boost use case template. Includes all fields of `DataCleanRoomUsecaseConfigRepresentation`. * `outputObjects` (_object_) List of output objects for the use case template. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMatchBoostOutputObjectRepresentation`. * `supportedContactPoints` (_array of string_) List of contact points supported by the provider. **Filter Group:** Small **Available Version:** 66.0 Items: Allowed values: `Email`, `PhoneNumber`. ### DataCleanRoomConnectionAttributesRepresentation Data Clean Room Connection Attributes Input Base class for clean room connection attributes. Abstract parent of: * DataCleanRoomAwsS3ConnectionAttributesRepresentation * DataCleanRoomSnowflakeConnectionAttributesRepresentation * `connectorType` (_string_) Type of metadata connector. **Available Version:** 66.0 Allowed values: `CleanroomAwsS3`, `CleanroomSnowflake`. ### DataCleanRoomOutputDestinationConfigRepresentation Data Clean Room Output Destination Config Output Base class representing the clean room output destination configuration. Abstract parent of: * DataCleanRoomAwsS3OutputDestinationConfigRepresentation * DataCleanRoomSnowflakeOutputDestinationConfigRepresentation * `connectorType` (_string_) Connector type of the output destination. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `CleanroomAwsS3`, `CleanroomSnowflake`. ### CustomUseCaseTemplateQueryConfig Custom Use Case Template Query Config Output Represents the query configuration for a custom use case template for a clean room. * `analysisConfigs` (_object_) Additional configurations for the template query, such as output location. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `CustomUseCaseTemplateAnalysisConfigRepresentation`. * `description` (_string_) Description of the template query. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the template query. **Filter Group:** Small **Available Version:** 63.0 * `queryParameters` (_array of CustomUseCaseTemplateQueryParamRepresentation_) List of query parameters. **Filter Group:** Small **Available Version:** 63.0 * `referencedTables` (_array of string_) List of tables referenced by the template query. **Filter Group:** Small **Available Version:** 63.0 * `source` (_string_) Name of the template query that is to be executed. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of template query, such as `SQL` or `SparkSQL`. **Filter Group:** Small **Available Version:** 63.0 * `useCase` (_string_) Name of the use case associated with the template query. **Filter Group:** Small **Available Version:** 63.0 ### CustomUseCaseTemplateTableConfig Custom Use Case Template Table Config Output Represents the configuration of a clean room custom use case template table. * `columns` (_array of CustomUseCaseTemplateColumnRepresentation_) List of columns in the template table. **Filter Group:** Small **Available Version:** 63.0 * `description` (_string_) Description of the template table. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the template table. **Filter Group:** Small **Available Version:** 63.0 * `role` (_string_) Role of the custom template, `Provider` or `Consumer`. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomUsecaseConfigInputRepresentation Data Clean Room Usecase Config Input Base class for a use case configuration. Abstract parent of: * MatchBoostUsecaseConfigInputRepresentation * `useCaseType` (_string_) Type of use case template. **Available Version:** 66.0 Allowed values: `Activation`, `Custom`, `MatchBoost`, `Overlap`. ### MatchBoostOutputObjectInputRepresentation Match Boost Output Object Input Represents the input for match boost use case template output objects. * `outputObjectConfigs` (_array of MatchBoostOutputObjectConfigRepresentation_) Configuration of the output objects. **Available Version:** 66.0 ### UseCaseTemplateMappingAttributeFilterOptionRepresentation Use Case Template Mapping Attribute Filter Option Output Represents the filter options for the mapping attributes for a clean room use case template. * `operator` (_string_) Logical operator to apply on the attribute values. **Filter Group:** Small **Available Version:** 63.0 * `values` (_array of string_) List of values qualified for filter application **Filter Group:** Small **Available Version:** 63.0 ### UseCaseTemplateMappingPathAttributeRepresentation Use Case Template Mapping Path Attribute Output Represents the mapping path of attributes for a clean room use case template. * `sourceAttribute` (_object_) Details of the source attribute in the path component. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateMappingSubjectAttributeRepresentation`. * `targetAttribute` (_object_) Details of the target attribute in the path component. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateMappingSubjectAttributeRepresentation`. ### UseCaseTemplateMappingSubjectAttributeRepresentation Use Case Template Mapping Subject Attribute Output Represents a mapping subject attribute for a clean room use case template. * `fieldLabel` (_string_) Label of the mapped entity field. **Filter Group:** Small **Available Version:** 63.0 * `fieldName` (_string_) Name of the mapped entity field. **Filter Group:** Small **Available Version:** 63.0 * `objectLabel` (_string_) Label of the mapped entity. **Filter Group:** Small **Available Version:** 63.0 * `objectName` (_string_) Name of the mapped entity. **Filter Group:** Small **Available Version:** 63.0 ### ConditionLeafRepresentation Condition Leaf Output Represents a leaf condition within an AccessPolicy clause tree. * `clause` (_string_) Clause of the rule that the condition belongs to (WHEN or UNLESS). **Filter Group:** Small **Available Version:** 67.0 * `contextPath` (_string_) Context-side path that the condition tests, such as SESSION\_DATASPACE. Mutually exclusive with `principalPath` and `resourcePath`. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character record ID of the condition. **Filter Group:** Small **Available Version:** 67.0 * `operator` (_string_) Comparison operator (e.g., EQUALS, IS, CONTAINS\_ANY, CONTAINS\_NONE). **Filter Group:** Small **Available Version:** 67.0 * `principalPath` (_string_) Principal-side path that the condition tests, such as IS\_AUTHENTICATED or ASSIGNED\_PERMISSIONS\_PATH. Mutually exclusive with `resourcePath` and `contextPath`. **Filter Group:** Small **Available Version:** 67.0 * `resourceExpression` (_object_) Projection or join expression evaluated for row-level security (RLS) conditions. Mutually exclusive with `values` and `valuePrincipalPath`. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ResourceExpressionRepresentation`. * `resourcePath` (_string_) Resource-side path that the condition tests, such as ENTITYTYPE, TAG, CLASSIFICATION, or RECORDFIELD. Mutually exclusive with `principalPath` and `contextPath`. **Filter Group:** Small **Available Version:** 67.0 * `valueDomain` (_string_) Value-domain qualifier that scopes the comparison, such as Case:IsSensitive\_\_c. **Filter Group:** Small **Available Version:** 67.0 * `valuePrincipalPath` (_string_) Right-side dynamic value pulled from the current principal, such as USER\_ID. Mutually exclusive with `values` and `resourceExpression`. Used for "owner equals current user" RLS patterns. **Filter Group:** Small **Available Version:** 67.0 * `values` (_array of PolicyValueRepresentation_) Typed values that the operator compares against. The CONTAINS\_ANY and CONTAINS\_NONE operators carry multiple values; most operators carry one. Mutually exclusive with `valuePrincipalPath` and `resourceExpression`. **Filter Group:** Small **Available Version:** 67.0 ### ConditionLeafInputRepresentation Condition Leaf Input Leaf condition within an AccessPolicy clause tree. * `clause` (_string_) Which clause of the rule this condition belongs to. **Available Version:** 67.0 Allowed values: `WHEN`, `UNLESS`. * `contextPath` (_string_) Context-side path the condition tests. Mutually exclusive with principalPath / resourcePath. **Available Version:** 67.0 Allowed values: `SESSION_DATASPACE`, `SESSION_CONSUMER_ID`, `CONTEXT_AGENT_ID`, `CONTEXT_AGENT_VERSION_ID`. * `id` (_string_) 18-character record ID of the underlying PolicyRuleDefinitionCond. Optional on create; required on update. **Available Version:** 67.0 * `operator` (_string_) Comparison operator applied to the selected condition path. Valid operators depend on the selected path and value type. Required. **Available Version:** 67.0 Allowed values: `EQUALS`, `NOT_EQUALS`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUALS`, `IN`, `LIKE`, `CONTAINS_ANY`, `CONTAINS_NONE`, `CONTAINS_ALL`, `IS`, `EXISTS`, `HIERARCHICALLY_ABOVE`, `HIERARCHICALLY_BELOW`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`. * `principalPath` (_string_) Principal-side path the condition tests. Mutually exclusive with resourcePath / contextPath. **Available Version:** 67.0 Allowed values: `IS_AUTHENTICATED`, `ASSIGNED_PERMISSIONS_PATH`, `USER_ID`, `ORGANIZATION_ID`, `USER_ROLE_ID`, `RBAC_TAGS`, `SCALAR_ATTRIBUTE`, `PLURAL_ATTRIBUTE`, `PLACEHOLDER`, `IS_INTERNAL`, `CONTACT_ID`. * `resourceExpression` (_object_) Projection or join expression that relates the resource-side row to another object. Mutually exclusive with values and valuePrincipalPath. **Available Version:** 67.0 Includes all fields of `ResourceExpressionInputRepresentation`. * `resourcePath` (_string_) Resource-side path the condition tests. Mutually exclusive with principalPath / contextPath. **Available Version:** 67.0 Allowed values: `NAMESPACE`, `ENTITY`, `RESOURCE`, `FIELD`, `ENTITYTYPE`, `ENTITYKIND`, `FIELDKIND`, `DATASPACE`, `TAG`, `SYSTEMTAG`, `OBJECT_TAG`, `CLASSIFICATION`, `IMPLICITTAG`, `OBJECT_SYSTEMTAG`, `RECORDFIELD`, `OBJECT_CLASSIFICATION`, `EXPRESSION`, `OBJECT_DATASPACE`, `RECORDFIELDTYPE`, `METADATAKIND`, `OBJECT`. * `valueDomain` (_string_) Optional value-domain qualifier scoping the comparison. **Available Version:** 67.0 * `valuePrincipalPath` (_string_) Right-side dynamic value pulled from the current principal. Mutually exclusive with values and resourceExpression. **Available Version:** 67.0 Allowed values: `IS_AUTHENTICATED`, `ASSIGNED_PERMISSIONS_PATH`, `USER_ID`, `ORGANIZATION_ID`, `USER_ROLE_ID`, `RBAC_TAGS`, `SCALAR_ATTRIBUTE`, `PLURAL_ATTRIBUTE`, `PLACEHOLDER`, `IS_INTERNAL`, `CONTACT_ID`. * `values` (_array of PolicyValueInputRepresentation_) Typed values the operator compares against. Mutually exclusive with valuePrincipalPath and resourceExpression. **Available Version:** 67.0 ### DataGraphFieldRepresentation Data Graph Field Output Represents a field of a data graph. * `ciFieldType` (_string_) Type of the calculated insight field. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Dimension`, `Measure`, `ObjectTypeUnspecified`. * `dataGraphFieldDevName` (_string_) Developer name of the field. **Filter Group:** Small **Available Version:** 61.0 * `dataType` (_string_) Data type of the field. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Boolean`, `Date`, `DateOnly`, `DateTime`, `Text`. * `developerName` (_string_) Developer name of the data graph. **Filter Group:** Small **Available Version:** 59.0 * `isProjected` (_string_) Indicates whether the field needs to be projected in output JSON (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 * `keyCol` (_string_) Indicates whether the field is a primary key (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 * `keyQualifierName` (_string_) Qualifier name of the key for the field. **Filter Group:** Small **Available Version:** 59.0 * `length` (_string_) Length of the field. **Filter Group:** Small **Available Version:** 59.0 * `lookupCol` (_string_) Lookup column of the field. **Filter Group:** Small **Available Version:** 59.0 * `usageTag` (_string_) Indicates whether the field represents a key qualifier field (`KEY_QUALIFIER`) or not (`NONE`). **Filter Group:** Small **Available Version:** 59.0 ### DataGraphRelationshipRepresentation Data Graph Relationship Output Represents a data graph relationship. * `cardinality` (_string_) Cardinality of the data graph relationship. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `CardinalityUnspecified`, `ManyToOne`, `OneToMany`, `OneToOne`, `Unrecognized`. * `fieldName` (_string_) Field name of the data graph relationship. **Filter Group:** Small **Available Version:** 59.0 * `parentFieldName` (_string_) Parent field name of the data graph relationship. **Filter Group:** Small **Available Version:** 59.0 ### RecencyCriteriaRepresentation Recency Criteria Output Represents recency criteria data. * `fieldName` (_string_) Field name of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `value` (_string_) Value of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 * `valueType` (_string_) Value type of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Record`, `Time`. * `valueUnit` (_string_) Value unit of the recency criteria. **Filter Group:** Small **Available Version:** 59.0 Allowed values: `Day`, `Hour`. ### DataGraphIdsDmoFieldRepresentation Data Graph IDs DMO Field Output Represents the fields of the data model object (DMO) that contains the ID table for the data graph. * `capabilities` (_array of integer_) List of capabilities for the DMO field. **Filter Group:** Small **Available Version:** 61.0 * `dataType` (_string_) Data type of the DMO field. **Filter Group:** Small **Available Version:** 61.0 * `developerName` (_string_) Developer name of the DMO field. **Filter Group:** Small **Available Version:** 61.0 ### DataGraphValuesDmoFieldRepresentation Data Graph Values DMO Field Representation Represents the fields of the data model object (DMO) that contains the JSON records for the data graph. * `capabilities` (_array of integer_) List of capabilities for the DMO field. **Filter Group:** Small **Available Version:** 61.0 * `dataType` (_string_) Data type of the DMO field. **Filter Group:** Small **Available Version:** 61.0 * `developerName` (_string_) Developer name of the DMO field. **Filter Group:** Small **Available Version:** 61.0 ### DataKitComponentInfoInputRepresentation Data Kit Component Info Input Represents the abstract base class for data kit component information. * `name` (_string_) Name of the data kit component. **Available Version:** 63.0 ### CdpDataKitStream Data Kit Stream Output Represents a single stream in a data kit data stream bundle. * `devName` (_string_, required) Developer name of the stream. **Filter Group:** Small **Available Version:** 57.0 * `label` (_string_, required) Label of the stream. **Filter Group:** Small **Available Version:** 57.0 ### DataKitComponentInfoRepresentation Data Kit Component Info Output Represents information about a data kit component. * `name` (_string_) Name of the data kit component. **Filter Group:** Small **Available Version:** 63.0 ### DataKitStreamRepresentation Data Kit Stream Output Represents a single stream in a data kit's data stream bundle. * `devName` (_string_) Developer name of the data kit stream. **Filter Group:** Small **Available Version:** 63.0 * `externalRecordIdentifier` (_string_) External record ID. **Filter Group:** Small **Available Version:** 63.0 * `fieldApiNames` (_array of string_) List of field API names. **Filter Group:** Small **Available Version:** 63.0 * `label` (_string_) Label of the data kit stream. **Filter Group:** Small **Available Version:** 63.0 ### CdpDataKitDeployComponentConfig Data Kit Deploy Component Config Input * Data Kit Deploy Component Config For Bundle Input * Data Kit Deploy Component Config For DLO Input * Data Kit Deploy Component Config Calculated Insight Input * Data Kit Deploy Component Config For Data Action Input * Data Kit Deploy Component Config For Data Action Target Input * Data Kit Deploy Component Config For Data Semantic Search Input * Data Kit Deploy Component Config For Data Share Input * Data Kit Deploy Component Config For Idp Configuration Input * Data Kit Deploy Component Config For Prediction Job Input * Data Kit Deploy Component Config For Tua Framework Input * Data Kit Deploy Component Config Ml Configured Model Input * Data Kit Deploy Component Config Ml Retriever Input * Data Kit Deploy Data Custom Code Input * Data Kit Deploy Activation Target Input * Data Kit Deploy Component Config Copy Field Input * Data Kit Deploy Component Config For IR Related List Input * Data Kit Deploy Component Config Identity Resolution Input * Data Kit Deploy Component Config Semantic Model Input * Data Kit Deploy Data Clean Room Provider Input * Data Kit Deploy Data Connection Input * Data Kit Deploy Data Graph Input * Data Kit Deploy Data Transform Input * Data Kit Deploy Market Activation Input * Data Kit Deploy Market Segment Input * Data Kit Deploy Personalization Input ### CdpDataKitDeployBundleConfigForAccountEngagement Data Kit Deploy Bundle Config For Account Engagement Input Represents the bundle configuration for an account engagement connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filer criteria. **Available Version:** 63.0 * `dataStreamType` (_string_) Type of data stream. **Available Version:** 63.0 Allowed values: `EmailActivity`, `FormActivity`, `WebPageActivity`. * `pardotTenantId` (_string_) Pardot tenant ID of the connector. **Available Version:** 63.0 ### CdpDataKitDeployBundleConfigForCommerce Data Kit Deploy Bundle Config For Commerce Input Represents the bundle configuration for a Commerce Cloud connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `instanceId` (_string_) Instance ID of the B2C Commerce Instance **Available Version:** 63.0 ### CdpDataKitDeployBundleConfigForConnectorsFramework Data Kit Deploy Bundle Config For Connectors Framework Input Represents the bundle configuration for a connector framework connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `connectionName` (_string_) APi name of the connection. **Available Version:** 60.0 * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filter criteria. **Available Version:** 61.0 ### CdpDataKitDeployBundleConfigForCrm Data Kit Deploy Bundle Config For CRM Input Represents a bundle configuration for a CRM connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filter criteria. **Available Version:** 61.0 * `orgId` (_string_) Org ID for the source CRM. **Available Version:** 57.0 ### CdpDataKitDeployBundleConfigForExternal Data Kit Deploy Bundle Config For External Input Represents the bundle configuration for an external connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `connectionName` (_string_) API name of the connection. **Available Version:** 63.0 * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filter criteria. **Available Version:** 63.0 ### CdpDataKitDeployBundleConfigForIngestApi Data Kit Deploy Bundle Config For Ingest API Input Represents the bundle configuration for an ingest API connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `connectorName` (_string_) Connector API name For the ingest API connector. **Available Version:** 60.0 * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filter criteria. **Available Version:** 61.0 ### CdpDataKitDeployBundleConfigForStreamingApp Data Kit Deploy Bundle Config For Streaming App Input Represents the bundle configuration for a streaming app connector type. Includes all fields of `CdpDataKitDeployBundleConfig`. * `connectorName` (_string_) API name of the streaming app connector. **Available Version:** 60.0 * `dataSpaceFilterCriteriaApiConfig` (_array of DataSpaceFilterConditionApiConfig_) API configuration for the data space filter criteria. **Available Version:** 61.0 * `streamingAppDataConnectorType` (_string_) Type of streaming app connector. **Available Version:** 60.0 Allowed values: `MobileApp`, `WebApp`. ### DataKitKQConfigRepresentation Data Kit KQ Config Input Represents the input for key qualifier (KQ) configurations. * `dataSourceField` (_string_) Name of the data source object field on which the KQ field is defined. **Available Version:** 63.0 * `dataSourceObject` (_string_) Name of the data source object on which the KQ field is defined. **Filter Group:** Small **Available Version:** 63.0 * `value` (_string_) Value of the KQ field. **Available Version:** 63.0 ### DataSpaceFilterConditionApiConfig Data Space Filter Condition API Config Input Represents the component configuration for a data lake object (DLO). * `fieldName` (_string_, required) Field name for the filter condition . **Available Version: 61.0** * `filterValue` (_string_, required) Filter value for the filter condition. **Available Version: 61.0** * `operator` (_string_, required) Operator for the filter condition. **Available Version: 61.0** * `targetObjectName` (_string_, required) Target object name for the filter condition. **Available Version: 61.0** ### DataTransformDataObjectOverride Data Transform Data Object Override Input Represents the input for data transform object overrides. * `nameOfObjInPublishingOrg` (_string_) Name of the data transform object in the publishing org. **Available Version:** 63.0 * `nameOfObjInSubscriberOrg` (_string_) Name of the data transform object in the subscriber org. **Available Version:** 63.0 ### DataTransformDefinitionOverride Data Transform Definition Override Input Represents the input for data transform definition overrides. * `devName` (_string_) Updated or replaced definition developer name. **Available Version:** 63.0 * `label` (_string_) Updated or replaced definition label. **Available Version:** 63.0 * `templateDevName` (_string_) Definition developer name in the data kit template. **Available Version:** 63.0 ### DataSpaceFilterConditionInputRepresentation Data Space Filter Condition Input Represents the input for a data space filter condition. * `fieldName` (_string_, required) Name of the field. **Available Version:** 62.0 * `filterValue` (_string_, required) Value of the filter. **Available Version:** 62.0 * `operator` (_string_, required) Operator of the filter condition. These are compatible with the following data types: * `ContainsAny`: text * `Equals`: text, number, date, dateTime, boolean * `GreaterThan`: number, date, dateTime * `In`: text, number * `LastNumberOfDays`: date, dateTime * `LessThan`: number, date, dateTime * `NotEquals`: text, number, date, dateTime, boolean * `NotIn`: text, number **Available Version:** 62.0 Allowed values: `ContainsAny`, `Equals`, `GreaterThan`, `In`, `LastNumberOfDays`, `LessThan`, `NotEquals`, `NotIn`. * `tableName` (_string_, required) Name of the table to apply the filter. **Available Version:** 62.0 ### ConnectorDetailsConfig Connector Details Config Output Abstract representation for details about a connector's configuration. ### ConnectorDetailsRepresentation Connector Details Output Details for a Data 360 connector. * `category` (_string_) Category of the Data 360 connector. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `name` (_string_) Name of the Data 360 connector. **Filter Group:** Small **Available Version:** 60.0 ### SchemaParametersInputRepresentation Schema Parameters Input Represents a schema node in Batch Data Transforms. * `fields` (_array of SchemaFieldParametersInputRepresentation_, required) Schema fields. **Available Version:** 60.0 * `slice` (_object_, required) Schema slice definition. **Available Version:** 60.0 Includes all fields of `SchemaSliceInputRepresentation`. ### DcSqlDataTransformMacroArgumentRepresentation Dc Sql Data Transform Macro Argument Output Represents a manifest macro argument. * `name` (_string_) Name of the macro argument. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of macro argument. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `BYOC_SCRIPT`. ### DcSqlDataTransformNodeConfigurationRepresentation Dc Sql Data Transform Node Configuration Output Represents a manifest node configuration. * `materialized` (_string_) Materialization type of node. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `ephemeral`, `table`. * `writeMode` (_string_) Write mode for the node. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Append`, `DeleteOnly`, `Merge`, `MergeUpsertDelete`, `Overwrite`. ### DcSqlDataTransformDependsOnRepresentation Dc Sql Data Transform Depends On Output Represents manifest node dependencies. * `nodes` (_array of string_) List of dependencies. **Filter Group:** Small **Available Version:** 63.0 ### SchemaParametersRepresentation Schema Parameters Output Represents a schema node. * `fields` (_array of SchemaFieldRepresentation_) Fields to edit. **Filter Group:** Small **Available Version:** 60.0 * `slice` (_object_) Which fields to keep or drop. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaSliceRepresentation`. ### CdpTimeRepresentation Time Output Represents a time source. * `hour` (_integer_) Hour at which this schedule is run (from `0` through `23`). **Filter Group:** Small **Available Version:** 60.0 * `minute` (_integer_) Minute at which this schedule is run (from `0` through `59`). **Filter Group:** Small **Available Version:** 60.0 * `timezone` (_object_) Information about the time zone. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `CdpTimeZoneRepresentation`. ### CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput Identity Resolution Match Criterion Party Identification Info Output Information about when party identification is used in a match rule criterion for an identity resolution ruleset. * `partyName` (_string_) Party identification name. **Filter Group:** Small **Available Version:** 57.0 * `partyType` (_string_) Party identification type. **Filter Group:** Small **Available Version:** 57.0 ### CdpMlFieldRepresentation ML Field Output Represents an ML field. * `label` (_string_) Field's label. **Filter Group:** Small **Available Version:** 61.0 * `name` (_string_) Field's name. **Filter Group:** Small **Available Version:** 61.0 ### CdpMlPredictionContributionBaseRepresentation ML Prediction Contribution Base Output Base representation for a prediction contribution. * `fields` (_array of CdpMlPredictionContributionFieldRepresentation_) List of fields and values that have the same contribution value. **Filter Group:** Small **Available Version:** 61.0 * `value` (_number (double)_) Contribution value. **Filter Group:** Small **Available Version:** 61.0 ### MlPredictionJobDefMappedFieldRepresentation Ml Prediction Job Def Mapped Field Output Represents a prediction job mapped data field. Includes all fields of `CdpAssetBaseRepresentation`. * `dataObject` (_object_) Data model object (DMO) details for the given field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `relationshipPath` (_array of MlPredictionJobDefFieldRelationshipRepresentation_) Relationship path for cases where the field comes from a related DMO. **Filter Group:** Small **Available Version:** 59.0 ### CdpMlFilterValueRepresentation Ml Filter Value Output Represents a filter value. * `type` (_string_) Type of value. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Constant`, `Placeholder`. * `value` (_string_) Value. When `type` is `Constant`, this property contains the constant value. When `type` is `Placeholder`, this property contains the placeholder name in the format "{!$parameter}". For retrievers, this only applies for `NoCode`. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation Ml Retriever Query Template Citation Definition Base Output Represents a citation definition. Discriminator: `citationType` selects the concrete type. * `citationType` (_string_) Type of citation. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Custom`, `Default`. * `customLabelColumnName` (_string_) Name or alias of the SELECT column used as citation label. **Filter Group:** Small **Available Version:** 61.0 ### MlRetrieverQueryTemplateMetadataSelectColumnRepresentation Ml Retriever Query Template Metadata Select Column Output Represents a SELECT column in the query template. * `fieldAlias` (_string_) Alias of the SELECT column. **Filter Group:** Small **Available Version:** 61.0 * `fieldName` (_string_) Name of the column. **Filter Group:** Small **Available Version:** 61.0 * `tableAlias` (_string_) Alias of the table. **Filter Group:** Small **Available Version:** 61.0 * `tableName` (_string_) Name of the table. **Filter Group:** Small **Available Version:** 61.0 ### DecoratorInputRepresentation Decorator Input Represents the input for the field-level chunking decorator. * `decoratorId` (_string_) Decorator ID. **Available Version:** 61.0 * `dmoDeveloperName` (_string_) DMO developer name. **Available Version:** 61.0 * `dmoFieldDeveloperName` (_string_) DMO field developer name. **Available Version:** 61.0 ### IndexFieldConfigurationInputRepresentation Index Field Configuration Input Represents the input for index field configurations. * `aliasName` (_string_) Alias of the index field. **Available Version:** 64.0 * `dmoDeveloperName` (_string_) Developer name of the DMO. **Available Version:** 64.0 * `dmoFieldDeveloperName` (_string_) Developer name of the DMO field. **Available Version:** 64.0 * `relationships` (_array of SourceTargetRelationshipInputRepresentation_) Field relationship paths between the source DMO fields and target DMO fields. **Available Version:** 64.0 ### TokenizationInputRepresentation Tokenization Input Represents the input for record field configuration tokenizations. * `name` (_string_) Name of the tokenization, such as `TYPEAHEAD` or `STANDARD`. **Available Version:** 64.0 ### UserValueInputRepresentation User Value Input Represents the input for a user value. * `id` (_string_) ID, such as `strip_html` or `max_tokens`. **Available Version:** 60.0 * `value` (_string_) Value, such as `false`, `100`, or `COSINE`. **Available Version:** 60.0 ### FieldLevelConfigurationRepresentation Field Level Configuration Output Represents the field level configuration. * `id` (_string_) The ID. **Filter Group:** Small **Available Version:** 60.0 * `userValues` (_array of ChunkingConfigUserValuesRepresentation_) User values. **Filter Group:** Small **Available Version:** 60.0 ### DecoratorRepresentation Decorator Output Represents the field-level chunking decorator. * `decoratorId` (_string_) Decorator ID. **Filter Group:** Small **Available Version:** 60.0 * `dmoDeveloperName` (_string_) DMO developer name. **Filter Group:** Small **Available Version:** 60.0 * `dmoFieldDeveloperName` (_string_) DMO field developer name. **Filter Group:** Small **Available Version:** 60.0 * `dmoFieldName` (_string_) DMO field label. **Filter Group:** Small **Available Version:** 60.0 * `dmoName` (_string_) DMO label. **Filter Group:** Small **Available Version:** 60.0 ### ConfigRepresentation Config Output Configuration Representation * `id` (_string_) ID, for example `passage_extraction`. **Filter Group:** Small **Available Version:** 60.0 * `userValues` (_array of UserValuesRepresentation_) List of user values. **Filter Group:** Small **Available Version:** 60.0 ### IndexFieldConfigurationRepresentation Index Field Configuration Output Represents index field configurations. * `aliasName` (_string_) Alias of the index field. **Filter Group:** Small **Available Version:** 64.0 * `dmoDeveloperName` (_string_) Developer name of the DMO. **Filter Group:** Small **Available Version:** 64.0 * `dmoFieldDeveloperName` (_string_) Developer name of the DMO field. **Filter Group:** Small **Available Version:** 58.0 * `relationships` (_array of FieldRelationshipsPathRepresentation_) Field relationship paths between the source DMO fields and target DMO fields. **Filter Group:** Small **Available Version:** 58.0 ### TokenizationRepresentation Tokenization Output Represents record field configuration tokenizations. * `name` (_string_) Name of the tokenization, such as `TYPEAHEAD` or `STANDARD`. **Filter Group:** Small **Available Version:** 64.0 ### UserValuesRepresentation User Values Output Represents user values. * `id` (_string_) ID, for example `strip_html`. **Filter Group:** Small **Available Version:** 60.0 * `value` (_object_) Value, for example `false`. **Filter Group:** Small **Available Version:** 60.0 ### SegmentTimeZoneRepresentation Segment Time Zone Output Represents the time zone of a segment publish schedule. * `gmtOffset` (_number (double)_) Time zone offset to GMT. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Time zone name. **Filter Group:** Small **Available Version:** 63.0 * `zoneId` (_string_) Time zone identifier. **Filter Group:** Small **Available Version:** 63.0 ### ActivationPlatformEventAttributeMappingInputRepresentation Activation Platform Event Attribute Mapping Input Represents the input for an attribute mapping rule. * `attributesOverride` (_object_) Attribute override categorization for the mapping. **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventAttributeOverrideInputRepresentation`. * `eventParameter` (_object_) Event parameter reference for the mapping. **Available Version:** 67.0 Includes all fields of `ActivationEventParameterInputRepresentation`. * `key` (_string_, required) Mapping key, such as `Purchase__Website` or `Global`. **Available Version:** 67.0 * `referenceAttributes` (_array of string_) Keys of parent mappings whose attributes are inherited. **Available Version:** 67.0 ### ActivationPlatformEventAttributeOverrideInputRepresentation Activation Platform Event Attribute Override Input Represents the input for attribute override categorization. * `exclude` (_array of ActivationPlatformEventAttributeInputRepresentation_) Excluded attributes for this context. **Available Version:** 67.0 * `identifiers` (_array of ActivationPlatformEventAttributeInputRepresentation_) Identifier attributes for this context. **Available Version:** 67.0 * `optional` (_array of ActivationPlatformEventAttributeInputRepresentation_) Optional attributes for this context. **Available Version:** 67.0 * `required` (_array of ActivationPlatformEventAttributeInputRepresentation_) Required attributes for this context. **Available Version:** 67.0 * `systemMappingAttributes` (_array of ActivationPlatformAttributeSystemMapCriteriaInputRepresentation_) System-mapped attributes with auto-population criteria. **Available Version:** 67.0 ### ActivationEventParameterHierarchyInputRepresentation Activation Event Parameter Hierarchy Input Represents the input for a hierarchy combination. * `hierarchyCombination` (_string_, required) Combination key, such as `Event__ActionSource`. **Available Version:** 67.0 * `hierarchyCombinationData` (_array of ActivationEventParameterHierarchyCombinationInputRepresentation_) Valid value pairings for the combination. **Available Version:** 67.0 ### ActivationEventParameterValuesInputRepresentation Activation Event Parameter Values Input Represents the input for an event parameter definition. * `hierarchy` (_integer_) Hierarchy level, starting at 1. **Available Version:** 67.0 * `name` (_string_, required) Parameter name, such as `Event` or `Action Source`. **Available Version:** 67.0 * `type` (_string_, required) Type of event parameter. **Available Version:** 67.0 Allowed values: `ActionSource`, `Event`. * `values` (_array of string_) Allowed values for the parameter. **Available Version:** 67.0 ### ActivationPlatformEventAttributeMappingRepresentation Activation Platform Event Attribute Mapping Output Represents an attribute mapping rule for a specific event and action-source combination. * `attributesOverride` (_object_) Attribute override categorization for the mapping. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationPlatformEventAttributeOverrideRepresentation`. * `eventParameter` (_object_) Event parameter reference for the mapping. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationEventParameterRepresentation`. * `key` (_string_) Mapping key, such as `Purchase__Website` or `Global`. **Filter Group:** Small **Available Version:** 67.0 * `referenceAttributes` (_array of string_) Keys of parent mappings whose attributes are inherited. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformEventAttributeOverrideRepresentation Activation Platform Event Attribute Override Output Represents an attribute override categorization, such as required, optional, identifiers, excluded, and system-mapped. * `exclude` (_array of ActivationPlatformEventAttributeRepresentation_) Excluded attributes for this context. **Filter Group:** Small **Available Version:** 67.0 * `identifiers` (_array of ActivationPlatformEventAttributeRepresentation_) Identifier attributes for this context. **Filter Group:** Small **Available Version:** 67.0 * `optional` (_array of ActivationPlatformEventAttributeRepresentation_) Optional attributes for this context. **Filter Group:** Small **Available Version:** 67.0 * `required` (_array of ActivationPlatformEventAttributeRepresentation_) Required attributes for this context. **Filter Group:** Small **Available Version:** 67.0 * `systemMappingAttributes` (_array of ActivationPlatformAttributeSystemMapCriteriaRepresentation_) System-mapped attributes with auto-population criteria. **Filter Group:** Small **Available Version:** 67.0 ### ActivationEventParameterHierarchyRepresentation Activation Event Parameter Hierarchy Output Represents a hierarchy combination that defines valid parameter value pairings. * `hierarchyCombination` (_string_) Combination key, such as `Event__ActionSource`. **Filter Group:** Small **Available Version:** 67.0 * `hierarchyCombinationData` (_array of ActivationEventParameterHierarchyCombinationRepresentation_) Valid value pairings for the combination. **Filter Group:** Small **Available Version:** 67.0 ### QueryPathInputRepresentationConfig Query Path Input Config Represents the input for a list of query paths. * `queryPath` (_array of QueryPathInputRepresentation_, required) List of query paths. **Available Version:** 60.0 ### AttributeFilterInputRepresentation Attribute Filter Input Represents the attribute filter input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `attributeId` (_string_) ID of the attribute. **Available Version:** 60.0 * `attributeName` (_string_) Name of the attribute. **Available Version:** 60.0 * `dateUnits` (_string_) Date unit filter. **Available Version:** 60.0 Allowed values: `Days`, `Months`, `Years`. * `operator` (_string_) Operator of the attribute. **Available Version:** 60.0 * `type` (_string_) Filter operator type. **Available Version:** 60.0 Allowed values: `FilterOperatorDataTypeBoolean`, `FilterOperatorDataTypeDate`, `FilterOperatorDataTypeDateOnly`, `FilterOperatorDataTypeExactlyRelativeDate`, `FilterOperatorDataTypeNumber`, `FilterOperatorDataTypeRelateToNowDate`, `FilterOperatorDataTypeText`. * `value` (_array of FilterValuesInputRepresentation_) Filter values. **Available Version:** 60.0 ### ContactPointAttributeInputRepresentation Contact Point Attribute Input Represents the attribute of an activation contact point. * `label` (_string_, required) Label of the attribute. **Available Version:** 63.0 * `name` (_string_, required) Name of the attribute. **Available Version:** 63.0 * `preferredName` (_string_, required) Preferred name of the attribute. **Available Version:** 63.0 ### DMOFilterInputRepresentation DMO Filter Input Represents the DMO filter input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `entityFilter` (_array of BaseComparisonInputRepresentation_) Entity filter. **Available Version:** 60.0 * `entityFilterType` (_string_) Type of the entity filter. **Available Version:** 60.0 * `entityName` (_string_) Name of the entity. **Available Version:** 60.0 * `filterLimit` (_object_) Filter limit. **Available Version:** 60.0 Includes all fields of `DmoFilterLimitInputRepresentation`. * `inheritedFilter` (_array of BaseComparisonInputRepresentation_) Inherited filter. **Available Version:** 60.0 * `inheritedFilterType` (_string_) Type of the inherited filter. **Available Version:** 60.0 * `queryPathConfigForActivateOnToContainer` (_array of QueryPathConfigListInputRepresentation_) Path from the activation to the container. _Type:_\* Query Config List Input **Available Version:** 60.0 * `queryPathConfigFromContainerToEntity` (_array of QueryPathConfigListInputRepresentation_) Path from the container to the entity. **Available Version:** 60.0 ### ContactPointSourceInputRepresentation Contact Point Source Input Represents the contact point source input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `dataSourceId` (_string_) Record ID for the data source. **Available Version:** 60.0 * `dataSourcePreference` (_string_) Preference for the data source. **Available Version:** 60.0 Allowed values: `ContactPointPrefAny`, `ContactPointPrefBusiness`, `ContactPointPrefPersonal`, `ContactPointPrefPrimary`. * `dataSourcePriority` (_integer_) Priority for the data source. **Available Version:** 60.0 * `id` (_string_) ID for the data source. **Available Version:** 63.0 * `name` (_string_) Name of the data source. **Available Version:** 60.0 ### AttributeFilterRepresentation Attribute Filter Output Represents the attribute filter output. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeId` (_string_) ID of the attribute. **Filter Group:** Small **Available Version:** 60.0 * `attributeName` (_string_) Name of the attribute. **Filter Group:** Small **Available Version:** 60.0 * `dateUnits` (_string_) Date units for the attribute. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Days`, `Months`, `Years`. * `operator` (_string_) Operator for the attribute. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type of the attribute. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `FilterOperatorDataTypeBoolean`, `FilterOperatorDataTypeDate`, `FilterOperatorDataTypeDateOnly`, `FilterOperatorDataTypeExactlyRelativeDate`, `FilterOperatorDataTypeNumber`, `FilterOperatorDataTypeRelateToNowDate`, `FilterOperatorDataTypeText`. * `value` (_object_) Values for the attribute. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FilterValuesRepresentation`. ### ActivationContactPointFieldConfigRepresentation Activation Contact Point Field Config Output Represents the activation contact point field configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `attributeId` (_string_) Attribute ID for the contact point. **Filter Group:** Small **Available Version:** 60.0 * `preferredName` (_string_) Preferred name for the contact point. **Filter Group:** Small **Available Version:** 60.0 * `referenceAttributeName` (_string_) Developer name for the reference attribute. **Filter Group:** Small **Available Version:** 63.0 ### ActivationContactPointSourceConfigRepresentation Activation Contact Point Source Config Output Represents the activation contact point source configuration output. Includes all fields of `CdpAssetBaseRepresentation`. * `dataSourceId` (_string_) ID of the data source. **Filter Group:** Small **Available Version:** 60.0 * `dataSourceName` (_string_) Name of the data source. **Filter Group:** Small **Available Version:** 60.0 * `dataSourcePreference` (_string_) Preference of the data source. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `ContactPointPrefAny`, `ContactPointPrefBusiness`, `ContactPointPrefPersonal`, `ContactPointPrefPrimary`. * `dataSourcePriority` (_integer_) Priority of the data source. **Filter Group:** Small **Available Version:** 60.0 ### TypeAndFilterRepresentation Type and Filter Output Represents the type and filter output. Includes all fields of `CdpAssetBaseRepresentation`. * `filter` (_object_) Filter. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BaseComparisonRepresentation`. * `type` (_string_) Type. **Filter Group:** Small **Available Version:** 60.0 ### UseCaseTemplateAttributeConfigRepresentation Use Case Template Attribute Config Output Represents the attribute configuration details for a clean room template. Includes all fields of `CdpAssetBaseRepresentation`. * `alias` (_string_) Alias of the use case template attribute. **Filter Group:** Small **Available Version:** 63.0 * `defaultValue` (_string_) Default value of the use case template attribute. **Filter Group:** Small **Available Version:** 63.0 * `description` (_string_) Description of the use case template attribute. **Filter Group:** Small **Available Version:** 63.0 * `queryOptions` (_object_) Configuration of query options for the use case template attribute. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateAttributeQueryOptionConfigRepresentation`. * `required` (_boolean_) Indicates whether the use case template attribute is required (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `tableName` (_string_) Table name of the use case template attribute. **Filter Group:** Small **Available Version:** 63.0 * `tooltip` (_string_) Helper text shown in the UI. **Filter Group:** Small **Available Version:** 66.0 ### DataCleanRoomMetadataOutputConfigRepresentation Data Clean Room Metadata Output Config Represents the metadata member output configuration for a clean room. * `connectorType` (_string_) Type of connector. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `CleanroomAwsS3`, `CleanroomSnowflake`. * `destinationType` (_string_) Type of output destination. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `ExternalConnector`, `Lakehouse`. ### DataCleanRoomUsecaseConfigRepresentation Data Clean Room Usecase Config Output Base class for the use case metadata configuration for a clean room. Abstract parent of: * DataCleanRoomMatchBoostUsecaseConfigRepresentation * `useCaseType` (_string_) Type of use case template. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Activation`, `Custom`, `MatchBoost`, `Overlap`. ### DataCleanRoomMatchBoostOutputObjectRepresentation Data Clean Room Match Boost Output Object Output Represents the configuration for match boost use case template objects. * `outputObjectConfigs` (_array of DataCleanRoomMatchBoostOutputObjectConfigRepresentation_) Configuration of the output objects. **Filter Group:** Small **Available Version:** 66.0 ### CustomUseCaseTemplateAnalysisConfigRepresentation Custom Use Case Template Analysis Config Output Represents the analysis configuration for a custom use case template for a clean room. * `outputPath` (_string_) Output path for saving the query result. **Filter Group:** Small **Available Version:** 63.0 ### CustomUseCaseTemplateQueryParamRepresentation Custom Use Case Template Query Param Output Represents the query parameters defined for a custom use case template for a clean room. * `queryParamConfigs` (_array of CustomUseCaseTemplateQueryParamConfig_) List of queries defined in the template. **Filter Group:** Small **Available Version:** 63.0 ### CustomUseCaseTemplateColumnRepresentation Custom Use Case Template Column Output Represents a column in a clean room custom use case template table. * `defaultValue` (_string_) Default value of the column in the template table. **Filter Group:** Small **Available Version:** 63.0 * `description` (_string_) Description of the column in the template table. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the column in the template table. **Filter Group:** Small **Available Version:** 63.0 * `tooltip` (_string_) Helper text to show in the UI with an info icon. **Filter Group:** Small **Available Version:** 66.0 * `type` (_string_) Type of column value in the template table, such as `STRING`, `INTEGER`, or `BOOLEAN`. **Filter Group:** Small **Available Version:** 63.0 ### MatchBoostOutputObjectConfigRepresentation Match Boost Output Object Config Input Represents the configuration input for match boost use case template output objects. * `bridgeTable` (_object_) Details about the bridge table. **Available Version:** 66.0 Includes all fields of `MatchBoostOutputBridgeTableInputRepresentation`. * `objectName` (_string_) Name of the object. **Available Version:** 66.0 * `relatedTable` (_array of MatchBoostOutputBridgeTableInputRepresentation_) Details about the related table. **Available Version:** 66.0 ### ResourceExpressionRepresentation Resource Expression Output Represents a projection or join expression for a row-level security (RLS) condition that uses joins. * `projection` (_object_) Join that defines the projection for the expression. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ResourceExpressionJoinRepresentation`. * `type` (_string_) Type of expression. Always PROJECTION for join-based RLS. **Filter Group:** Small **Available Version:** 67.0 * `version` (_integer_) Schema version of the expression body. **Filter Group:** Small **Available Version:** 67.0 ### PolicyValueRepresentation Policy Value Output Represents a single typed value within an AccessPolicy condition's value set. * `booleanValue` (_boolean_) Boolean-typed value. Mutually exclusive with the other typed value fields. **Filter Group:** Small **Available Version:** 67.0 * `dateTimeValue` (_string (date-time)_) DateTime-typed value as a UTC instant. Mutually exclusive with the other typed value fields. **Filter Group:** Small **Available Version:** 67.0 * `dateValue` (_string (date-time)_) Date-typed value as a UTC calendar day. Mutually exclusive with the other typed value fields. **Filter Group:** Small **Available Version:** 67.0 * `id` (_string_) 18-character record ID of the value. **Filter Group:** Small **Available Version:** 67.0 * `numberValue` (_string_) Number-typed value. Mutually exclusive with the other typed value fields. Encoded as a string to preserve BigDecimal precision through JSON. **Filter Group:** Small **Available Version:** 67.0 * `percentValue` (_string_) Percent-typed value. Mutually exclusive with the other typed value fields. Encoded as a string to preserve BigDecimal precision through JSON. **Filter Group:** Small **Available Version:** 67.0 * `reference` (_string_) Reference value, such as a tag, classification, or custom permission API name. Paired with `referenceType` to disambiguate the resolution path. Orthogonal to the other typed value fields. **Filter Group:** Small **Available Version:** 67.0 * `referenceType` (_string_) Type discriminator for the reference field, such as STANDARD\_TAG, CUSTOM\_TAG, STANDARD\_CLASSIFICATION, or CUSTOM\_PERMISSION. **Filter Group:** Small **Available Version:** 67.0 * `textValue` (_string_) Plain-text value. Mutually exclusive with the other typed value fields. Carries arbitrary strings, including JSON-shaped text, without ambiguity. **Filter Group:** Small **Available Version:** 67.0 ### ResourceExpressionInputRepresentation Resource Expression Input Projection/join expression for an RLS-with-joins condition (EXISTS operator). * `projection` (_object_) Join definition of the projection, specifying the joined object, its alias, and the join predicate. **Available Version:** 67.0 Includes all fields of `ResourceExpressionJoinInputRepresentation`. * `type` (_string_) Expression type — always PROJECTION for join-based RLS. Required. **Available Version:** 67.0 * `version` (_integer_) Schema version of the expression body. **Available Version:** 67.0 ### PolicyValueInputRepresentation Policy Value Input A single typed value within an AccessPolicy condition's value set. Exactly one of the typed value fields (or the reference pair) must be provided. * `booleanValue` (_boolean_) Boolean-typed value (mutually exclusive with the other typed value fields). **Available Version:** 67.0 * `dateTimeValue` (_string (date-time)_) DateTime-typed value (UTC instant, mutually exclusive with the other typed value fields). **Available Version:** 67.0 * `dateValue` (_string (date-time)_) Date-typed value (UTC calendar day, mutually exclusive with the other typed value fields). **Available Version:** 67.0 * `numberValue` (_string_) Number-typed value, string-encoded to preserve BigDecimal precision. Mutually exclusive with the other typed value fields. **Available Version:** 67.0 * `percentValue` (_string_) Percent-typed value, string-encoded to preserve BigDecimal precision. Mutually exclusive with the other typed value fields. **Available Version:** 67.0 * `reference` (_string_) Reference value (for example, a tag, classification, or custom permission API name). Paired with referenceType. Orthogonal to the typed value fields. **Available Version:** 67.0 * `referenceType` (_string_) Type discriminator for the reference field (for example, STANDARD\_TAG, CUSTOM\_TAG, STANDARD\_CLASSIFICATION, CUSTOM\_PERMISSION). **Available Version:** 67.0 * `textValue` (_string_) Plain-text value. Mutually exclusive with the other typed value fields. **Available Version:** 67.0 ### CdpDataKitDeployBundleConfig Data Kit Deploy Bundle Config Input Base class for a bundle configuration. Abstract parent of: * Data Kit Deploy Bundle Config For Account Engagement Input * Data Kit Deploy Bundle Config For Commerce Input * Data Kit Deploy Bundle Config For CRM Input * Data Kit Deploy Bundle Config For Connectors Framework Input * Data Kit Deploy Bundle Config For External Input * Data Kit Deploy Bundle Config For Ingest API Input * Data Kit Deploy Bundle Config For Streaming App Input ### SchemaFieldParametersInputRepresentation Schema Field Parameters Input Represents a schema node field. * `errorValue` (_string_, required) Value to output on error. **Available Version:** 60.0 * `name` (_string_, required) Schema field name. **Available Version:** 60.0 * `newProperties` (_object_, required) Field properties. **Available Version:** 60.0 Includes all fields of `SchemaFieldPropertiesInputRepresentation`. ### SchemaSliceInputRepresentation Schema Slice Input Represents slice definition. * `fields` (_array of string_, required) List of fields for `Select` or `Drop`. **Available Version:** 60.0 * `ignoreMissingFields` (_boolean_, required) Indicates whether to ignore missing fields (`true`) or not (`false`). **Available Version:** 60.0 * `mode` (_string_, required) Slice mode. **Available Version:** 60.0 Allowed values: `Drop`, `Select`. ### SchemaFieldRepresentation Schema Field Output Represents a schema node field. * `errorValue` (_string_) Value to output on error. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Field name. **Filter Group:** Small **Available Version:** 60.0 * `newProperties` (_object_) New property values. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaFieldNewPropertiesRepresentation`. ### SchemaSliceRepresentation Schema Slice Output Represents a schema node slice. * `fields` (_array of string_) Fields to select or drop. **Filter Group:** Small **Available Version:** 60.0 * `ignoreMissingFields` (_boolean_) Indicates whether to ignore missing fields (`true`) or not (`false`) **Filter Group:** Small **Available Version:** 60.0 * `mode` (_string_) Select or drop fields. **Filter Group:** Small **Available Version:** 60.0 ### CdpTimeZoneRepresentation Time Zone Output Represents a time zone. * `gmtOffset` (_number (double)_) Signed offset in hours from GMT. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Display name of the time zone. **Filter Group:** Small **Available Version:** 60.0 * `zoneId` (_string_) Zone ID of the time zone. **Filter Group:** Small **Available Version:** 60.0 ### CdpMlPredictionContributionFieldRepresentation ML Prediction Contribution Field Output Representation for an ML prediction contribution field. Includes all fields of `CdpMlFieldRepresentation`. * `customText` (_object_) If the field has custom text, contains the custom text definition. **Filter Group:** Small **Available Version:** 61.0 Includes all fields of `CdpMlPredictionFieldCustomTextRepresentation`. * `inputValue` (_string_) Input value used for this field. **Filter Group:** Small **Available Version:** 61.0 * `prescribedValue` (_string_) Model's output value for the field, which is the value that is recommended to improve the prediction. **Filter Group:** Small **Available Version:** 61.0 ### MlPredictionJobDefFieldRelationshipRepresentation Ml Prediction Job Def Field Relationship Output Represents a prediction job field relationship. * `sourceField` (_object_) Name of the data model object (DMO) source field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefDataFieldRepresentation`. * `targetField` (_object_) Name of the DMO target field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefDataFieldRepresentation`. ### ChunkingConfigUserValuesRepresentation Chunking Config User Values Output Represents the user values for a chunking configuration. * `id` (_string_) ID of the chunking configuration. **Filter Group:** Small **Available Version:** 60.0 * `value` (_string_) User value for the chunking configuration. **Filter Group:** Small **Available Version:** 60.0 ### ActivationEventParameterInputRepresentation Activation Event Parameter Input Represents the input for an event parameter reference. * `name` (_string_, required) Parameter value name, such as `Purchase` or `Website`. **Available Version:** 67.0 * `subEventParameter` (_object_) Nested event parameter reference for the next level in the hierarchy. **Available Version:** 67.0 Includes all fields of `ActivationEventParameterInputRepresentation`. * `type` (_string_, required) Type of event parameter. **Available Version:** 67.0 Allowed values: `ActionSource`, `Event`. ### ActivationPlatformEventAttributeInputRepresentation Activation Platform Event Attribute Input Represents the input for a destination attribute with an optional constant value. * `destinationName` (_string_, required) Destination attribute name. **Available Version:** 67.0 * `value` (_string_) Constant value. Null if mapped dynamically. **Available Version:** 67.0 ### ActivationPlatformAttributeSystemMapCriteriaInputRepresentation Activation Platform Attribute System Map Criteria Input Represents the input for system-mapped attribute criteria. * `dataType` (_string_, required) Data type of the mapped field. **Available Version:** 67.0 * `destinationName` (_string_, required) Destination attribute name. **Available Version:** 67.0 * `sourceMappingField` (_string_, required) Source field to auto-map from, such as `commit_timestamp`. **Available Version:** 67.0 * `supportedDMOTypes` (_array of string_) Data model object (DMO) types that support the system mapping, such as `Profile`. **Available Version:** 67.0 ### ActivationEventParameterHierarchyCombinationInputRepresentation Activation Event Parameter Hierarchy Combination Input Represents the input for a key-values pair within a hierarchy combination. * `key` (_string_, required) Parameter value key, such as `Purchase`. **Available Version:** 67.0 * `values` (_array of string_) Valid child parameter values for the key. **Available Version:** 67.0 ### ActivationEventParameterRepresentation Activation Event Parameter Output Represents an event parameter reference. Supports recursive sub-parameters. * `name` (_string_) Parameter value name, such as `Purchase` or `Website`. **Filter Group:** Small **Available Version:** 67.0 * `subEventParameter` (_object_) Nested event parameter reference for the next level in the hierarchy. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ActivationEventParameterRepresentation`. * `type` (_string_) Type of event parameter. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `ActionSource`, `Event`. ### ActivationPlatformEventAttributeRepresentation Activation Platform Event Attribute Output Represents a destination attribute with an optional constant value. * `destinationName` (_string_) Destination attribute name. **Filter Group:** Small **Available Version:** 67.0 * `value` (_string_) Constant value. Null if mapped dynamically. **Filter Group:** Small **Available Version:** 67.0 ### ActivationPlatformAttributeSystemMapCriteriaRepresentation Activation Platform Attribute System Map Criteria Output Represents the criteria for system-mapped attributes, which are auto-populated from the source data model object (DMO). * `dataType` (_string_) Data type of the mapped field. **Filter Group:** Small **Available Version:** 67.0 * `destinationName` (_string_) Destination attribute name. **Filter Group:** Small **Available Version:** 67.0 * `sourceMappingField` (_string_) Source field to auto-map from, such as `commit_timestamp`. **Filter Group:** Small **Available Version:** 67.0 * `supportedDMOTypes` (_array of string_) Data model object (DMO) types that support the system mapping, such as `Profile`. **Filter Group:** Small **Available Version:** 67.0 ### ActivationEventParameterHierarchyCombinationRepresentation Activation Event Parameter Hierarchy Combination Output Represents a key-values pair within a hierarchy combination. * `key` (_string_) Parameter value key, such as `Purchase`. **Filter Group:** Small **Available Version:** 67.0 * `values` (_array of string_) Valid child parameter values for the key. **Filter Group:** Small **Available Version:** 67.0 ### QueryPathInputRepresentation Query Path Input Represents the query path input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `fieldLabel` (_string_) Field label. **Available Version:** 60.0 * `fieldName` (_string_) Field name. **Available Version:** 60.0 * `objectLabel` (_string_) Object label. **Available Version:** 60.0 * `objectName` (_string_) Object name. **Available Version:** 60.0 ### FilterValuesInputRepresentation Filter Values Input Represents the input for filter values. * `values` (_array of string_, required) List of values. **Available Version:** 60.0 ### BaseComparisonInputRepresentation Base Comparison Input Represents the base comparison input. Abstract parent of: * [Entity Scoped Group Input](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3AEntity%2BScoped%2BGroup%2BInput) * [Logical Comparison Input](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3ALogical%2BComparison%2BInput) * [Primitive Comparison Input](https://developer.salesforce.com/docs/data/connectapi/references/spec?meta=type%3APrimitive%2BComparison%2BInput) * `filtersConfig` (_array of TypeAndFilterInputRepresentationConfig_, required) Logical comparison input list wrapper. **Available Version:** 60.0 * `operator` (_string_, required) Operator of the comparison. **Available Version:** 60.0 ### DmoFilterLimitInputRepresentation DMO Filter Limit Input Represents the DMO filter limit input. Includes all fields of `CdpAssetReferenceInputRepresentation`. * `attributeName` (_string_) Name of the attribute. **Available Version:** 60.0 * `maxNumberOfValues` (_integer_) Max number of values. **Available Version:** 60.0 * `order` (_string_) Filter sort order. **Available Version:** 60.0 Allowed values: `Asc`, `Desc`. ### FilterValuesRepresentation Filter Values Output Represents the filter values for an attribute. * `values` (_array of string_) List of filter values. **Filter Group:** Small **Available Version:** 63.0 ### UseCaseTemplateAttributeQueryOptionConfigRepresentation Use Case Template Attribute Query Option Config Output Represents the attribute query configuration details for a clean room template. Includes all fields of `CdpAssetBaseRepresentation`. * `aggregationOption` (_object_) Option for the attribute to be used with aggregation functions. **Filter Group:** Small **Available Version:** 63.0 Includes all fields of `UseCaseTemplateAttributeAggregateConfigRepresentation`. * `selectable` (_boolean_) Indicates whether the attribute can be used in a `SELECT` clause (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `supportGroupBy` (_boolean_) Indicates whether the attribute can be used in a `GROUP BY` clause (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `supportJoin` (_boolean_) Indicates whether the attribute can be used in a `JOIN` clause (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomMatchBoostOutputObjectConfigRepresentation Data Clean Room Match Boost Output Object Config Output Represents the configuration for a match boost use case template object. * `bridgeTable` (_object_) Details about the object bridge table. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMatchBoostOutputBridgeTableRepresentation`. * `objectName` (_string_) Name of the object. **Filter Group:** Small **Available Version:** 66.0 * `relatedTable` (_object_) Details about the related table. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMatchBoostOutputRelatedTableRepresentation`. ### CustomUseCaseTemplateQueryParamConfig Custom Use Case Template Query Param Config Output Represents the query parameter configuration for a custom use case template for a clean room. * `description` (_string_) Description of the query parameter table column. **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the query parameter table column. **Filter Group:** Small **Available Version:** 63.0 * `type` (_string_) Type of query parameter table value, such as `STRING`, `INTEGER`, or `BOOLEAN`. **Filter Group:** Small **Available Version:** 63.0 ### MatchBoostOutputBridgeTableInputRepresentation Match Boost Output Bridge Table Input Represents the bridge table input for a match boost use case template object. * `sourceIdFieldName` (_string_) Column name corresponding to the equivalent column in the shared data. **Available Version:** 66.0 ### ResourceExpressionJoinRepresentation Resource Expression Join Output Represents a single join within an AccessPolicy resource-expression projection. * `alias` (_string_) Alias for the joined relation in the predicate. **Filter Group:** Small **Available Version:** 67.0 * `predicate` (_object_) Predicate that relates the joined relation to the resource-side row. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ResourceExpressionPredicateRepresentation`. * `schema` (_string_) Name of the joined data model object (DMO). **Filter Group:** Small **Available Version:** 67.0 ### ResourceExpressionJoinInputRepresentation Resource Expression Join Input A single join within an AccessPolicy resource-expression projection. * `alias` (_string_) Alias used to qualify the joined relation in the predicate, for example `individual`. Required. **Available Version:** 67.0 * `predicate` (_object_) Join predicate that specifies how a row in the joined object relates to the resource-side row. **Available Version:** 67.0 Includes all fields of `ResourceExpressionPredicateInputRepresentation`. * `schema` (_string_) Joined Data Model Object or object API name, for example `Individual__dlm`. This is a name, not a record ID. Required. **Available Version:** 67.0 ### SchemaFieldPropertiesInputRepresentation Schema Field Properties Input Represents common field properties. * `label` (_string_, required) Field label. **Available Version:** 60.0 * `name` (_string_, required) Field name. **Available Version:** 60.0 * `typeProperties` (_object_, required) Field type properties. **Available Version:** 60.0 Includes all fields of `SchemaTypePropertiesCastInputRepresentation`. ### SchemaFieldNewPropertiesRepresentation Schema Field New Properties Output Represents new field properties for a schema node. * `label` (_string_) Field label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Field name. **Filter Group:** Small **Available Version:** 60.0 * `typeProperties` (_object_) New property values. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaFieldTypePropertiesRepresentation`. ### CdpMlPredictionFieldCustomTextRepresentation ML Prediction Field Custom Text Output Represents ML prediction field custom text. * `isHidden` (_boolean_) Whether to show the default text. **Filter Group:** Small **Available Version:** 61.0 * `mergeFieldValues` (_object_) Placeholder for the resolved value defined in the template text. Null if there are no placeholders. **Filter Group:** Small **Available Version:** 61.0 * `type` (_string_, required) * `templateText` (_string_) If a custom override is defined for the column, contains the template text. **Filter Group:** Small **Available Version:** 61.0 ### MlPredictionJobDefDataFieldRepresentation Ml Prediction Job Def Data Field Output Represents a prediction job data field. Includes all fields of `CdpAssetBaseRepresentation`. * `dataObject` (_object_) Detals about the data model object (DMO) for the field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. ### TypeAndFilterInputRepresentationConfig Type And Filter Input Config Represents logical comparison input for a filter configuration. * `filters` (_array of TypeAndFilterInputRepresentation_, required) List of filters. **Available Version:** 60.0 ### UseCaseTemplateAttributeAggregateConfigRepresentation Use Case Template Attribute Aggregate Config Output Represents the attribute aggregation configuration details for a clean room template. Includes all fields of `CdpAssetBaseRepresentation`. * `operators` (_array of string_) Type of aggregation operators. **Filter Group:** Small **Available Version:** 63.0 Items: Allowed values: `Count`, `Distinct`, `Sum`. * `threshold` (_integer_) Minimum number of rows in the result. This value is non-nullable. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomMatchBoostOutputBridgeTableRepresentation Data Clean Room Match Boost Output Bridge Table Output Represents the bridge table for a match boost use case template object. * `sourceIdFieldName` (_string_) Column name corresponding to the equivalent column in the shared data. **Filter Group:** Small **Available Version:** 66.0 ### DataCleanRoomMatchBoostOutputRelatedTableRepresentation Data Clean Room Match Boost Output Related Table Output Represents the related table for a match boost use case template object. * `pathFromBridgeTable` (_array of DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation_) Path details that identify the relationship between the bridge table and the object. **Filter Group:** Small **Available Version:** 66.0 * `sourceObjectName` (_string_) Name of the source object. **Filter Group:** Small **Available Version:** 66.0 ### ResourceExpressionPredicateRepresentation Resource Expression Predicate Output Represents the predicate of an AccessPolicy resource-expression join. * `attribute` (_string_) Field on the joined schema. **Filter Group:** Small **Available Version:** 67.0 * `comparator` (_string_) Comparator that relates the attribute to the resource-side field. Values are EQUALS and NOT\_EQUALS. **Filter Group:** Small **Available Version:** 67.0 * `on` (_object_) Resource-side reference that the predicate compares against. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `ResourceExpressionOnRepresentation`. ### ResourceExpressionPredicateInputRepresentation Resource Expression Predicate Input Represents the join predicate of an AccessPolicy resource-expression projection. * `predicate` (_string_, required) Join predicate definition, as a JSON expression that relates a row in the joined object to the resource-side row. **Available Version:** 67.0 ### SchemaTypePropertiesCastInputRepresentation Schema Type Properties Cast Input Represents casting for types. * `format` (_string_, required) DateTime format. **Available Version:** 60.0 * `length` (_integer_, required) Total length of text. **Available Version:** 60.0 * `precision` (_integer_, required) Length of arbitrary precision value. **Available Version:** 60.0 * `scale` (_integer_, required) Number of digits to right of decimal point. **Available Version:** 60.0 * `symbols` (_object_, required) Number format. **Available Version:** 60.0 Includes all fields of `SchemaFormatSymbolsInputRepresentation`. * `type` (_string_, required) DataType to Convert to Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### SchemaFieldTypePropertiesRepresentation Schema Field Type Properties Output Represents a schema node field type. * `format` (_string_) Field format. **Filter Group:** Small **Available Version:** 60.0 * `length` (_integer_) Field length. **Filter Group:** Small **Available Version:** 60.0 * `precision` (_integer_) Field precision. **Filter Group:** Small **Available Version:** 60.0 * `scale` (_integer_) Field scale. **Filter Group:** Small **Available Version:** 60.0 * `symbols` (_object_) Field symbols. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaFieldFormatSymbolsRepresentation`. * `type` (_string_) Field type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### TypeAndFilterInputRepresentation Type and Filter Input Represents a wrapper for logical comparison filters. * `filter` (_array of BaseComparisonInputRepresentation_, required) Filter for the entity. **Available Version:** 60.0 * `type` (_string_, required) Name of the entity. **Available Version:** 60.0 ### DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation Data Clean Room Match Boost Output Bridge Table Path Output Represents the bridge table path for a match boost use case template object. * `sourceAttribute` (_object_) Source attribute of the path. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation`. * `targetAttribute` (_object_) Target attribute of the path. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation`. ### ResourceExpressionOnRepresentation Resource Expression On Output Represents the resource-side reference of an AccessPolicy resource-expression join. * `field` (_string_) Resource-side field. **Filter Group:** Small **Available Version:** 67.0 * `resourceAlias` (_string_) Alias for the resource side; conventionally "resource" **Filter Group:** Small **Available Version:** 67.0 * `schema` (_string_) Name of the resource-side data model object (DMO). **Filter Group:** Small **Available Version:** 67.0 ### SchemaFormatSymbolsInputRepresentation Schema Format Symbols Input Represents the format for symbols. * `currencySymbol` (_string_, required) Currency symbol format. **Available Version:** 60.0 * `decimalSymbol` (_string_, required) Decimal symbol format. **Available Version:** 60.0 * `groupingSymbol` (_string_, required) Grouping symbol format. **Available Version:** 60.0 ### SchemaFieldFormatSymbolsRepresentation Schema Field Format Symbols Output Represents format symbols for a schema node field. * `currencySymbol` (_string_) Field currency symbol. **Filter Group:** Small **Available Version:** 60.0 * `decimalSymbol` (_string_) Field decimal symbol. **Filter Group:** Small **Available Version:** 60.0 * `groupingSymbol` (_string_) Field grouping symbol. **Filter Group:** Small **Available Version:** 60.0 ### DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation Data Clean Room Match Boost Output Bridge Table Path Attribute Output Represents the bridge table path attribute for a match boost use case template object. * `fieldName` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 66.0 * `objectName` (_string_) Name of the object. **Filter Group:** Small **Available Version:** 66.0 ### AbstractBucketAlgorithmRepresentation Abstract Bucket Algorithm Output Represents a bucket algorithm. * `type` (_string_) Algorithm type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `TypographicClustering`. ### AccountEngagementConnectionRepresentation Account Engagement Connection Output Represents an Account Engagement connector. Includes all fields of `ConnectionRepresentation`. * `modules` (_array of ConnectionModuleConfigRepresentation_) List of Steaming app modules. **Filter Group:** Small **Available Version:** 64.0 * `sourceId` (_string_) Source ID of an Account Engagement connector. **Filter Group:** Small **Available Version:** 60.0 * `tenantSpecificEndpoint` (_string_) Tenant-specific endpoint of an Account Engagement connector. **Filter Group:** Small **Available Version:** 63.0 ### ActivationPlatformSupportedEventTypeRepresentation Activation Platform Supported Event Type Output Represents a supported event type for a streaming activation platform. * `eventType` (_string_) Type of supported event. **Filter Group:** Small **Available Version:** 67.0 Allowed values: `Standard`, `Custom`. ### AgentSetupCollectionRepresentation Agent Setup Collection Output Represents a collection of agent setups. Includes all fields of `CdpPaginatedResponseBaseRepresentation`. * `limit` (_integer_) Number of records in the response. **Filter Group:** Small **Available Version:** 66.0 * `offset` (_integer_) Number of records to skip for the next request. **Filter Group:** Small **Available Version:** 66.0 * `setupConfigs` (_array of AgentSetupConfigRepresentation_) List of agent setup configurations. **Filter Group:** Small **Available Version:** 66.0 ### AgentSetupConfigRepresentation Agent Setup Config Output Represents an agent setup configuration. Includes all fields of `CdpAssetBaseRepresentation`. * `dataspaceName` (_string_) Name of the data space that the agent setup belongs to. **Filter Group:** Small **Available Version:** 66.0 * `enabled` (_boolean_) Indicates whether the agent setup is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 * `status` (_string_) Status of the agent setup. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Active`, `Error`, `Processing`. ### AgentSetupInputRepresentation Agent Setup Input Represents the input for an agent setup. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataSpaceName` (_string_) Name of the data space that the agent setup belongs to. **Available Version:** 66.0 * `enabled` (_boolean_) Indicates whether the agent setup is enabled (`true`) or not (`false`). **Available Version:** 66.0 ### AgentSetupUpdateInputRepresentation Agent Setup Update Input Represents the input for updating an agent setup. Includes all fields of `CdpObjectBaseInputRepresentation`. * `dataSpaceName` (_string_) Name of the data space that the agent setup belongs to. **Available Version:** 66.0 * `enabled` (_boolean_) Indicates whether the agent setup is enabled (`true`) or not (`false`). **Available Version:** 66.0 ### AggregateInputRepresentation Aggregate Input Represents the input for an aggregation. * `action` (_string_, required) Action to execute on the aggregation. **Available Version:** 60.0 Allowed values: `Avg`, `Count`, `Maximum`, `Median`, `Minimum`, `StdDev`, `StdDevP`, `Sum`, `Unique`, `Var`, `VarP`. * `label` (_string_, required) Label of field that is created after the aggregation. **Available Version:** 60.0 * `name` (_string_, required) Name of the field that is created after the aggregation. **Available Version:** 60.0 * `source` (_string_, required) Name of the field that is the source of the aggregation. **Available Version:** 60.0 ### AggregateNodeInputRepresentation Aggregate Node Input Represents an aggregate data node input in batch data transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `AggregateParametersInputRepresentation`. ### AggregateNodeRepresentation Aggregate Node Output Represents an aggregate data node in batch data transforms. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `AggregateParametersRepresentation`. ### AggregateParametersInputRepresentation Aggregate Parameters Input Represents the aggregate node parameters input. * `aggregations` (_array of AggregateInputRepresentation_, required) Aggregations. **Available Version:** 60.0 * `groupings` (_array of string_, required) Groupings. **Available Version:** 60.0 * `nodeType` (_string_, required) Determines which fields are required. Hierarchical requires: `parentField` and `selfField`. `percentageField` is optional. Standard requires `aggregations`. **Available Version:** 60.0 Allowed values: `Hierarchical`, `Standard`. * `parentField` (_string_, required) Defines the parent field in the hierarchical aggregate mode. **Available Version:** 60.0 * `percentageField` (_string_, required) Percentage field. **Available Version:** 60.0 * `pivot_v2` (_object_, required) Pivot v2. **Available Version:** 60.0 Includes all fields of `PivotV2InputRepresentation`. * `selfField` (_string_, required) Defines the self field in the hierarchical aggregate mode. **Available Version:** 60.0 ### AggregateParametersRepresentation Aggregate Parameters Output Represents aggregate node parameters. * `aggregations` (_array of AggregateRepresentation_) Aggregations. **Filter Group:** Small **Available Version:** 60.0 * `groupings` (_array of string_) Groupings. **Filter Group:** Small **Available Version:** 60.0 * `nodeType` (_string_) Aggregate type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Hierarchical`, `Standard`. * `parentField` (_string_) Parent field. **Filter Group:** Small **Available Version:** 60.0 * `percentageField` (_string_) Percentage field. **Filter Group:** Small **Available Version:** 60.0 * `pivot_v2` (_object_) Pivot V2. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `PivotV2Representation`. * `selfField` (_string_) Self field. **Filter Group:** Small **Available Version:** 60.0 ### AggregateRepresentation Aggregate Output Represents an aggregate. * `action` (_string_) Aggregate action. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Avg`, `Count`, `Maximum`, `Median`, `Minimum`, `StdDev`, `StdDevP`, `Sum`, `Unique`, `Var`, `VarP`. * `label` (_string_) Aggregate label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Aggregate name. **Filter Group:** Small **Available Version:** 60.0 * `source` (_string_) Aggregate source. **Filter Group:** Small **Available Version:** 60.0 ### AppendMappingInputRepresentation Append Mapping Input Represents the field mapping input for append. * `bottom` (_string_, required) Bottom dataset field. **Available Version:** 60.0 * `top` (_string_, required) Top dataset field. **Available Version:** 60.0 ### AppendMappingRepresentation Append Mapping Output Represents field mapping for append. * `bottom` (_string_) Bottom dataset field. **Filter Group:** Small **Available Version:** 60.0 * `top` (_string_) Top dataset field. **Filter Group:** Small **Available Version:** 60.0 ### AppendParametersInputRepresentation Append Parameters Input Represents the input for append parameters. * `allowImplicitDisjointSchema` (_boolean_, required) Indicates whether to allow disjoint schema merge when automatically mapping fields (`true`) or not (`false`). **Available Version:** 60.0 * `columnMappings` (_object_, required) Map of batch data transform definition nodes. **Available Version:** 60.0 Additional properties: `string`. * `fieldMappings` (_array of AppendMappingInputRepresentation_, required) Field mappings. **Available Version:** 60.0 ### AppendParametersRepresentation Append Parameters Output Represents append parameters. * `allowImplicitDisjointSchema` (_boolean_) Allows disjoint schema merge when automatically mapping fields (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `columnMappings` (_object_) Column mappings. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `string`. * `fieldMappings` (_array of AppendMappingRepresentation_) Field mappings. **Filter Group:** Small **Available Version:** 60.0 ### AppendV2NodeInputRepresentation Append V2 Node Input Represents an append data node in batch data transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `AppendParametersInputRepresentation`. ### AppendV2NodeRepresentation Append V2 Node Output Represents an append data node in batch data transforms. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `AppendParametersRepresentation`. ### AwsDataShareTargetInputRepresentation Aws Data Share Target Input Represents the input for creating an AWS data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `accountId` (_string_) AWS account ID for the data share target. **Available Version:** 63.0 * `awsRoleArn` (_string_) AWS role ARN for the data share target. **Available Version:** 63.0 * `subType` (_string_) Subtype of AWS data share target. **Available Version:** 63.0 Allowed values: `Aws`, `CleanRoom`. ### AwsDataShareTargetRepresentation Aws Data Share Target Output Represents an AWS data share target. Includes all fields of `DataShareTargetRepresentation`. * `accountId` (_string_) AWS account ID for the data share target. **Filter Group:** Small **Available Version:** 63.0 * `awsRoleArn` (_string_) AWS role ARN for the data share target. **Filter Group:** Small **Available Version:** 63.0 * `subType` (_string_) Subtype of AWS data share target. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Aws`, `CleanRoom`. ### BigQueryDataShareTargetInputRepresentation Big Query Data Share Target Input Represents the input for creating a BigQuery data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `targetEmailId` (_string_) Email address of the Google principal that the data is shared with. **Available Version:** 63.0 * `targetEmailType` (_string_) Type of Google principal. **Available Version:** 63.0 Allowed values: `Group`, `ServiceAccount`, `User`. ### BigQueryDataShareTargetRepresentation Big Query Data Share Target Output Represents a BigQuery data share target. Includes all fields of `DataShareTargetRepresentation`. * `targetEmailId` (_string_) Email address of the Google principal that the data is shared with. **Filter Group:** Small **Available Version:** 63.0 * `targetEmailType` (_string_) Type of Google principal. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `Group`, `ServiceAccount`, `User`. ### BucketFieldInputRepresentation Bucket Field Input Represents bucket node field. * `label` (_string_, required) Label. **Available Version:** 60.0 * `name` (_string_, required) Name. **Available Version:** 60.0 * `type` (_string_, required) Field type. **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### BucketFieldRepresentation Bucket Field Output Bucket node field representation. * `bucketsSetup` (_object_) Buckets setup. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BucketSetupRepresentation`. * `label` (_string_) Label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Field type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### BucketNodeInputRepresentation Bucket Node Input Represents a bucket node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `BucketParametersInputRepresentation`. ### BucketNodeRepresentation Bucket Node Output Bucket node in batch data transforms. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BucketParametersRepresentation`. ### BucketParametersInputRepresentation Bucket Parameters Input Represents a bucket node. * `fields` (_array of BucketFieldInputRepresentation_, required) List of fields. **Available Version:** 60.0 ### BucketParametersRepresentation Bucket Parameters Output Bucket node representation. * `fields` (_array of BucketFieldRepresentation_) Fields **Filter Group:** Small **Available Version:** 60.0 ### BucketRepresentation Bucket Output Abstract bucket representation. * `value` (_string_) Value. **Filter Group:** Small **Available Version:** 60.0 ### BucketSetupRepresentation Bucket Setup Output Bucket setup representation. * `algorithm` (_object_) Bucketing algorithm. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `AbstractBucketAlgorithmRepresentation`. * `buckets` (_array of BucketRepresentation_) Buckets. **Filter Group:** Small **Available Version:** 60.0 * `defaultBucketValue` (_string_) Default bucket value. **Filter Group:** Small **Available Version:** 60.0 * `isPassthroughEnabled` (_boolean_) Indicates whether passthrough is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `nullBucketValue` (_string_) Null bucket value. **Filter Group:** Small **Available Version:** 60.0 * `sourceField` (_object_) Source fields. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `BucketSourceFieldRepresentation`. ### BucketSourceFieldRepresentation Bucket Source Field Output Measure bucket field representation. * `name` (_string_) Name. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### CdpMlFilterInputRepresentation Ml Filter Input Represents the input for a filter expression. * `conjunctiveOperator` (_string_, required) Operator used to join filter criteria. **Available Version:** 67.0 Allowed values: `And`, `Custom`, `Or`. * `criteria` (_array of CdpMlFilterCriterionInputRepresentation_, required) List of filter criteria. **Available Version:** 67.0 * `customBooleanExpression` (_string_) Custom boolean expression in the format "{!$0} AND {!$1} AND ({!$2} OR {!$3}) AND (NOT {!$4})". Each number is the index of a criterion in the criteria list. Used when `conjunctiveOperator` is `Custom`. **Available Version:** 67.0 ### CdpMlFilterCriterionInputRepresentation Ml Filter Criterion Input Represents the input for a filter criterion. * `field` (_object_, required) Filter field. For `NoCode` retriever configuration, this is the reference ID, alias name, or related data model object (DMO) field developer name in `vectorEmbeddingRelatedFields` of the search index. **Available Version:** 67.0 Includes all fields of `MlFilterFieldAssetInputRepresentation`. * `operator` (_string_, required) Operator applied to the filter criterion. **Available Version:** 67.0 Allowed values: `EqualTo`, `GreaterThan`, `GreaterThanOrEqualTo`, `In`, `LessThan`, `LessThanOrEqualTo`, `Like`, `NotEqualTo`, `NotIn`. * `values` (_array of CdpMlFilterValueInputRepresentation_, required) List of values to apply in the filter. **Available Version:** 67.0 ### CdpMlFilterValueInputRepresentation Ml Filter Value Input Represents the input for a filter value. * `type` (_string_, required) Type of value. **Available Version:** 67.0 Allowed values: `Constant`, `Placeholder`. * `value` (_string_, required) Value content. When `type` is `Constant`, this property contains the constant value. When `type` is `Placeholder`, this property contains the placeholder name in the format "{!$parameter}". **Available Version:** 67.0 ### CdpPredictNodeInputRepresentation Predict Node Input Represents the input for a predict node. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `CdpPredictParametersInputRepresentation`. ### CdpPredictNodeRepresentation Predict Node Output Represents a prediction data node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `CdpPredictParametersRepresentation`. ### CdpPredictParametersInputRepresentation Predict Parameters Input Represents the input for prediction parameters. * `columnMapping` (_object_) Map of column values. **Available Version:** 60.0 Additional properties: `string`. * `minPrescriptionImpact` (_number (double)_) Minimum prescription impact double. **Available Version:** 60.0 * `multiClassFields` (_array of PredictionContributorInputRepresentation_) Multi-class fields. **Available Version:** 60.0 * `predictSource` (_object_) Prediction source. **Available Version:** 60.0 Includes all fields of `PredictSourceInputRepresentation`. * `predictionFactorFields` (_array of PredictionContributorInputRepresentation_) List of prediction factor fields. **Available Version:** 60.0 * `predictionFields` (_array of PredictionFieldInputRepresentation_) List of prediction fields. **Available Version:** 60.0 * `prescriptionFields` (_array of PredictionContributorInputRepresentation_) List of prescription fields. **Available Version:** 60.0 ### CdpPredictParametersRepresentation Predict Parameters Output Represents prediction node parameters. * `columnMapping` (_object_) Map of columns. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `string`. * `minPrescriptionImpact` (_number (double)_) Minimum prescription impact. **Filter Group:** Small **Available Version:** 60.0 * `multiClassFields` (_array of PredictionContributorRepresentation_) Multi-class fields. **Filter Group:** Small **Available Version:** 60.0 * `predictSource` (_object_) List of prediction sources. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `PredictSourceRepresentation`. * `predictionFactorFields` (_array of PredictionContributorRepresentation_) List of prediction factor fields. **Filter Group:** Small **Available Version:** 60.0 * `predictionFields` (_array of PredictionFieldRepresentation_) List of prediction fields. **Filter Group:** Small **Available Version:** 60.0 * `prescriptionFields` (_array of PredictionContributorRepresentation_) List of prescription fields. **Filter Group:** Small **Available Version:** 60.0 ### CommunicationCappingBulkRulesetCollectionRepresentation Communication Capping Bulk Ruleset Collection Output Represents a collection of bulk ruleset update results. * `results` (_array of CommunicationCappingBulkRulesetRepresentation_) List of bulk ruleset update results. **Filter Group:** Small **Available Version:** 67.0 ### CommunicationCappingBulkRulesetRepresentation Communication Capping Bulk Ruleset Output Represents a bulk ruleset update result. * `dataCommCapRuleId` (_string_) ID of the communication capping rule. **Filter Group:** Small **Available Version:** 67.0 * `dataCommunicationCapName` (_string_) Name of the communication capping configuration. **Filter Group:** Small **Available Version:** 67.0 * `endDate` (_string (date-time)_) End date of the rule. **Filter Group:** Small **Available Version:** 67.0 * `limits` (_integer_) Capping limit value. **Filter Group:** Small **Available Version:** 67.0 * `startDate` (_string (date-time)_) Start date of the rule. **Filter Group:** Small **Available Version:** 67.0 ### ComputeRelativeNodeInputRepresentation Compute Relative Node Input Representation to compare a row to another row. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `ComputeRelativeParametersInputRepresentation`. ### ComputeRelativeNodeRepresentation Compute Relative Node Output Compute relative node in batch data transforms. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ComputeRelativeParametersRepresentation`. ### ComputeRelativeParametersInputRepresentation Compute Relative Parameters Input Compute relative node parameters. * `expressionType` (_string_) Type of formula expression. **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. * `fields` (_array of SqlFormulaFieldInputRepresentation_, required) List of fields. **Available Version:** 60.0 * `orderBy` (_array of ComputeRelativeSortParametersInputRepresentation_, required) Sort fields. **Available Version:** 60.0 * `partitionBy` (_array of string_, required) Partition by. **Available Version:** 60.0 ### ComputeRelativeParametersRepresentation Compute Relative Parameters Output Compute relative node parameters. * `expressionType` (_string_) Type of formula expression. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. * `fields` (_array of SqlFormulaFieldRepresentation_) Lis of fields. **Filter Group:** Small **Available Version:** 60.0 * `orderBy` (_array of ComputeRelativeSortParametersRepresentation_) Sort fields. **Filter Group:** Small **Available Version:** 60.0 * `partitionBy` (_array of string_) Partition by. **Filter Group:** Small **Available Version:** 60.0 ### ComputeRelativeSortParametersInputRepresentation Compute Relative Sort Parameters Input Compute relative sort direction parameter. * `direction` (_string_, required) Sort direction. **Available Version:** 60.0 Allowed values: `Ascending`, `Descending`. * `fieldName` (_string_, required) Field name. **Available Version:** 60.0 ### ComputeRelativeSortParametersRepresentation Compute Relative Sort Parameters Output Compute relative sort direction parameter. * `direction` (_string_) Sort direction. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Ascending`, `Descending`. * `fieldName` (_string_) Field name. **Filter Group:** Small **Available Version:** 60.0 ### ConditionRepresentation Condition Output Condition Representation for Priority Rules * `fieldName` (_string_) The field name to evaluate in the condition (for example, ContentType\_\_c, FilePath\_\_c) **Filter Group:** Small **Available Version:** 67.0 * `operator` (_string_) The operator to apply between the field and value (for example, equals, contains, startsWith) **Filter Group:** Small **Available Version:** 67.0 * `value` (_string_) The value to compare against **Filter Group:** Small **Available Version:** 67.0 ### ConnectionModuleConfigInputRepresentation Connection Module Config Input Input representation for Streaming App module configuration for a patch request. * `configuration` (_string_) Stringified JSON object for the custom configuration of the Streaming App module. The default is `null`. **Available Version:** 63.0 * `isEnabled` (_boolean_) Indicates whether the Streaming App module is enabled (`true`) or not (`false`). The default value is `false`. **Available Version:** 63.0 * `name` (_string_, required) Name of the Streaming App module. **Available Version:** 63.0 * `path` (_string_) URL for the Amazon S3 location where the Streaming App module's minified JavaScript file is hosted. The default is `null`. **Available Version:** 63.0 ### ConnectionModuleConfigRepresentation Connection Module Config Output Represents the configuration of a Streaming App module. * `configuration` (_string_) Stringified JSON object for the custom configuration of the Streaming App module. **Filter Group:** Small **Available Version:** 63.0 * `isEnabled` (_boolean_) Indicates whether the Streaming App module is enabled (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 63.0 * `name` (_string_) Name of the Streaming App module. **Filter Group:** Small **Available Version:** 63.0 * `path` (_string_) URL of the Amazon S3 location where the Streaming App module's minified JavaScript file is hosted. **Filter Group:** Small **Available Version:** 63.0 ### ConnectionSchemaFieldInputRepresentation Connection Schema Field Input Represents the input superclass for all schema fields. * `label` (_string_) Label of the schema field. **Available Version:** 60.0 * `name` (_string_) Developer name of the schema field. **Available Version:** 60.0 ### ConnectionSchemaFieldRepresentation Connection Schema Field Output Represents the output superclass for all schema fields. * `label` (_string_) Label of the schema field. **Filter Group:** Small **Available Version:** 65.0 * `name` (_string_) Developer name of the schema field. **Filter Group:** Small **Available Version:** 65.0 ### ConnectorsFrameworkConnectionSchemaFieldInputRepresentation Connectors Framework Connection Schema Field Input Represents the input for connectors framework field types. Includes all fields of `ConnectionSchemaFieldInputRepresentation`. * `currencyIsoCode` (_boolean_) Indicates whether the field is a currency ISO code (`true`) or not (`false`). **Available Version:** 64.0 * `dataType` (_string_) Data type of the field. **Available Version:** 64.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### ConnectorsFrameworkConnectionSchemaFieldRepresentation Connectors Framework Connection Schema Field Output Represents a connectors framework connection schema field. Includes all fields of `ConnectionSchemaFieldRepresentation`. * `currencyIsoCode` (_boolean_) Indicates whether the field is a currency ISO code (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 64.0 * `dataType` (_string_) Data type of the schema field. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### ConnectorsFrameworkConnectionSchemaInputRepresentation Connectors Framework Connection Schema Input Represents the input for a connectors framework schema. Includes all fields of `ConnectionSchemaInputRepresentation`. * `fields` (_array of ConnectorsFrameworkConnectionSchemaFieldInputRepresentation_) List of schema fields. **Available Version:** 64.0 ### ConnectorsFrameworkConnectionSchemaRepresentation Connectors Framework Connection Schema Output Represents a connectors framework connection schema. Includes all fields of `ConnectionSchemaRepresentation`. * `availabilityStatus` (_string_) Availability status of the event. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `Available`, `InUse`. * `fields` (_array of ConnectorsFrameworkConnectionSchemaFieldRepresentation_) List of schema fields. **Filter Group:** Small **Available Version:** 64.0 ### CrmConnectionInputRepresentation CRM Connection Input Input representation for a Customer Relationship Management (CRM) connector. Includes all fields of `ConnectionInputRepresentation`. * `organizationId` (_string_, required) Organization ID of the CRM connecter. **Available Version:** 61.0 ### CrmConnectionRepresentation CRM Connection Output Represents a CRM connection. Includes all fields of `ConnectionRepresentation`. * `alias` (_string_) Alias of the CRM Connection **Filter Group:** Small **Available Version:** 62.0 * `connectionStatus` (_string_) Status of the CRM Connection. **Filter Group:** Small **Available Version:** 62.0 Allowed values: `Active`, `Deleting`, `Error`, `InActive`, `Processing`, `SchemaRequired`. * `dataSource` (_string_) Data source of the CRM connection. **Filter Group:** Small **Available Version:** 64.0 * `organizationId` (_string_) Organization ID of the CRM connection. **Filter Group:** Small **Available Version:** 61.0 ### CustomCodeExecutionLogRepresentation Custom Code Execution Log Output Represents the log for a custom code execution. * `downloadUrl` (_string_) URL to download the execution log. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomAWSSourceConfigInputRepresentation Data Clean Room AWS Source Config Input Represents the source type configuration input for a clean room AWS provider. Includes all fields of `DataCleanRoomProviderSourceConfigInputRepresentation`. * `accountId` (_string_) Account ID of the AWS provider. **Available Version:** 63.0 * `supportedRegions` (_array of string_) Supported AWS regions for the clean room. **Available Version:** 63.0 ### DataCleanRoomAWSSourceConfigRepresentation Data Clean Room AWS Source Config Output Represents the source type configuration for a clean room AWS provider. Includes all fields of `DataCleanRoomProviderSourceConfigRepresentation`. * `accountId` (_string_) Account ID of the AWS provider. **Filter Group:** Small **Available Version:** 63.0 * `supportedRegions` (_array of string_) Supported AWS regions for the clean room. **Filter Group:** Small **Available Version:** 63.0 ### DataCleanRoomDCSourceConfigInputRepresentation Data Clean Room DC Source Config Input Represents the source type configuration input for a clean room DATA\_CLOUD (DC) provider. Includes all fields of `DataCleanRoomProviderSourceConfigInputRepresentation`. * `dataCloudOrgId` (_string_) Core org ID where Data 360 clean room is enabled. **Available Version:** 63.0 * `domainUrl` (_string_) Domain URL of the provider. **Available Version:** 63.0 * `offCoreTenantId` (_string_) Off-core tenant ID of the provider. **Available Version:** 63.0 ### DataCleanRoomDCSourceConfigRepresentation Data Clean Room DC Source Config Output Represents the source type configuration for a clean room DATA\_CLOUD (DC) provider. Includes all fields of `DataCleanRoomProviderSourceConfigRepresentation`. * `dataCloudOrgId` (_string_) Core org ID where Data 360 clean room is enabled. **Filter Group:** Small **Available Version:** 63.0 * `domainUrl` (_string_) Domain URL of the provider. **Filter Group:** Small **Available Version:** 63.0 * `offCoreTenantId` (_string_) Off-core tenant ID of the provider. **Filter Group:** Small **Available Version:** 63.0 ### DataCloudDataShareTargetInputRepresentation Data Cloud Data Share Target Input Represents the input for creating a Data Cloud data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `subType` (_string_) Subtype of Data Cloud data share target. **Available Version:** 63.0 Allowed values: `CleanRoom`, `DatacloudToDatacloud`. * `targetOrgId` (_string (Id)_) Data Cloud org ID for the target. **Available Version:** 63.0 * `targetUrl` (_string_) Data Cloud URL for the target. **Available Version:** 63.0 ### DataCloudDataShareTargetRepresentation Data Cloud Data Share Target Output Represents a Data Cloud data share target. Includes all fields of `DataShareTargetRepresentation`. * `subType` (_string_) Subtype of Data Cloud data share target. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `CleanRoom`, `DatacloudToDatacloud`. * `targetOrgId` (_string (Id)_) Data Cloud org ID for the target. **Filter Group:** Small **Available Version:** 63.0 ### DataConnectionInputRepresentation Data Connection Input Input representation for a data connector. Includes all fields of `ConnectionInputRepresentation`. * `credentials` (_array of DataConnectionParameterInputRepresentation_, required) List of key-value pairs that provide credentials for the data connection. Credentials values are masked. **Available Version:** 61.0 * `method` (_string_, required) Type of the data connection. **Available Version:** 61.0 Allowed values: `Egress`, `Ingress`. * `parameters` (_array of DataConnectionParameterInputRepresentation_, required) List of key-value pairs that provide parameters for the data connection. **Available Version:** 61.0 ### DataConnectionParameterRepresentation Data Connection Parameter Output Represents a key-value pair for credentials and parameters of a data connection. * `paramName` (_string_) Name of the parameter. Each attribute of the connector metadata is a possible parameter name that the user provided. **Filter Group:** Small **Available Version:** 61.0 * `value` (_string_) Value of the parameter. **Filter Group:** Small **Available Version:** 61.0 ### DataConnectionRepresentation Data Connection Output Represents a data connector. Includes all fields of `ConnectionRepresentation`. * `connectorLabel` (_string_) Label of the connector. **Filter Group:** Small **Available Version:** 61.0 * `credentials` (_array of DataConnectionParameterRepresentation_) List of key-value pairs that provide credentials for the data connector. Credentials values are masked. **Filter Group:** Big **Available Version:** 61.0 * `deletable` (_boolean_) Indicates whether the data connector is deletable (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `editable` (_boolean_) Indicates whether the data connector is editable (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `iconUrl` (_string_) URL for the data connector icon. **Filter Group:** Small **Available Version:** 61.0 * `lastDataChangeErrorCode` (_string_) Error code for the last change to the data connector. **Filter Group:** Medium **Available Version:** 61.0 * `lastSyncDate` (_string_) Date of the last sync of the data connector. **Filter Group:** Medium **Available Version:** 61.0 * `method` (_string_) Type of connection method for the data connector. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Egress`, `Ingress`. * `params` (_array of DataConnectionParameterRepresentation_) List of key-value pairs that provide parameters for the data connector. **Filter Group:** Small **Available Version:** 61.0 * `status` (_string_) Status of the data connector. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Connected`, `Disconnected`, `Failed`, `NeedsReAuth`. * `syncStatus` (_string_) Sync status of the data connector. **Filter Group:** Medium **Available Version:** 61.0 Allowed values: `Failure`, `InProgress`, `InvalidCredentials`, `None`, `Pending`, `Success`. ### DatabricksDataShareTargetInputRepresentation Databricks Data Share Target Input Represents the input for creating a Databricks data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `accountUrl` (_string_) Service account URL for the connection created in Databricks. **Available Version:** 63.0 * `serviceAccountId` (_string_) Service account ID for the connection created in Databricks. **Available Version:** 63.0 ### DatabricksDataShareTargetRepresentation Databricks Data Share Target Output Represents a Databricks data share target. Includes all fields of `DataShareTargetRepresentation`. * `accountUrl` (_string_) Service account URL for the connection created in Databricks. **Filter Group:** Small **Available Version:** 63.0 * `serviceAccountId` (_string_) Service account ID for the connection created in Databricks. **Filter Group:** Small **Available Version:** 63.0 ### ExtensionFunctionNodeInputRepresentation Extension Function Node Input Represents the input for an extension function node. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node specific parameters **Available Version:** 65.0 Includes all fields of `ExtensionFunctionParametersInputRepresentation`. ### ExtensionFunctionNodeRepresentation Extension Function Node Output Represents an extension function node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ExtensionFunctionParametersRepresentation`. ### ExtensionFunctionParametersInputRepresentation Extension Function Parameters Input Represents the input for extension function parameters. * `functionName` (_string_) Name of the extension function. **Available Version:** 65.0 * `outputFields` (_object_) Map of output fields, including label and name. **Available Version:** 65.0 Additional properties: `object`. * `ownerParameters` (_object_) Map of owner parameters. **Available Version:** 65.0 Additional properties: `object`. * `sourceInputFields` (_array of string_) List of source fields to the extension function from the dataset. **Available Version:** 65.0 * `userParameters` (_object_) Map of user parameters. **Available Version:** 66.0 Additional properties: `object`. * `version` (_string_) Version of the extension function. **Available Version:** 65.0 ### ExtensionFunctionParametersRepresentation Extension Function Parameters Output Represents extension function parameters. * `functionName` (_string_) Name of the function. **Filter Group:** Small **Available Version:** 60.0 * `outputFields` (_object_) Output fields produced by the function. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `object`. Output field of the function. **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Label of the field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 60.0 * `ownerParameters` (_object_) Map of owner parameters. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `object`. * `sourceInputFields` (_array of string_) List of input fields from the source dataset. **Filter Group:** Small **Available Version:** 60.0 * `userParameters` (_object_) Map of user parameters. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `object`. * `version` (_string_) Version of the function. **Filter Group:** Small **Available Version:** 60.0 ### ExtensionNodeInputRepresentation Extension Node Input Represents the input for an extension node. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 66.0 Includes all fields of `ExtensionParametersInputRepresentation`. ### ExtensionNodeRepresentation Extension Node Output Representation of Extension Node Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ExtensionParametersRepresentation`. ### ExtensionParametersInputRepresentation Extension Parameters Input Represents the input for extension parameters. * `args` (_object_) Map of extension arguments. **Available Version:** 60.0 Additional properties: `object`. * `name` (_string_) Name of the extension. **Available Version:** 60.0 * `namespace` (_string_) Namespace of the extension. **Available Version:** 60.0 * `version` (_number (double)_) Version of the extension. **Available Version:** 60.0 ### ExtensionParametersRepresentation Extension Parameters Output Represens extension node parameters. * `args` (_object_) Map of extension arguments, which are keys defined by the extension definition. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `object`. * `name` (_string_) Name of the extension. **Filter Group:** Small **Available Version:** 60.0 * `namespace` (_string_) Namespace of the extension. **Filter Group:** Small **Available Version:** 60.0 * `version` (_number (double)_) Version of the extension. **Filter Group:** Small **Available Version:** 60.0 ### ExtractFieldRepresentation Extract Field Output Represents an extract grain field. * `grainType` (_string_) Type of extract grain. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Day`, `DayEpoch`, `FiscalMonth`, `FiscalQuarter`, `FiscalWeek`, `FiscalYear`, `Hour`, `Minute`, `Month`, `Quarter`, `Second`, `SecondEpoch`, `Week`, `Year`. * `label` (_string_) Label of the extract field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the extract field. **Filter Group:** Small **Available Version:** 60.0 ### ExtractGrainFieldInputRepresentation Extract Grain Field Input Representation to extract part of a date, such as year, month, etc. * `grainType` (_string_, required) Extract grain type. **Available Version:** 60.0 Allowed values: `Day`, `DayEpoch`, `FiscalMonth`, `FiscalQuarter`, `FiscalWeek`, `FiscalYear`, `Hour`, `Minute`, `Month`, `Quarter`, `Second`, `SecondEpoch`, `Week`, `Year`. * `label` (_string_, required) Extract field label. **Available Version:** 60.0 * `name` (_string_, required) Extract field name. **Available Version:** 60.0 ### ExtractGrainNodeInputRepresentation Extract Grain Node Input Represents extract date grain node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `ExtractGrainParametersInputRepresentation`. ### ExtractGrainParameterInputRepresentation Extract Grain Parameter Input Represents extract grain parameter. * `source` (_string_, required) Source field. **Available Version:** 60.0 * `targets` (_array of ExtractGrainFieldInputRepresentation_, required) Grain fields. ### ExtractGrainParametersInputRepresentation Extract Grain Parameters Input Extract node. * `dateConfigurationName` (_string_, required) Date configuration name. **Available Version:** 60.0 * `grainExtractions` (_array of ExtractGrainParameterInputRepresentation_, required) Date fields to extract grains. **Available Version:** 60.0 ### ExtractNodeRepresentation Extract Node Output Represents an extract node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ExtractParametersRepresentation`. ### ExtractParameterRepresentation Extract Parameter Output Represents an extract node parameter. * `source` (_string_) Name of the source field. **Filter Group:** Small **Available Version:** 60.0 * `targets` (_array of ExtractFieldRepresentation_) List of grain fields. **Filter Group:** Small **Available Version:** 60.0 ### ExtractParametersRepresentation Extract Parameters Output Represents extract node parameters. * `dateConfigurationName` (_string_) Name of the date configuration. **Filter Group:** Small **Available Version:** 60.0 * `grainExtractions` (_array of ExtractParameterRepresentation_) List of date fields to extract grains. **Filter Group:** Small **Available Version:** 66.0 ### ExtractTableNodeInputRepresentation Extract Table Node Input Represents the input for an extract table node. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `ExtractTableParametersInputRepresentation`. ### ExtractTableNodeRepresentation Extract Table Node Output Represents an extract table node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `ExtractTableParametersRepresentation`. ### ExtractTableParametersInputRepresentation Extract Table Parameters Input Represents the input for extract table parameters. * `source` (_string_) Name of the source. **Available Version:** 60.0 ### ExtractTableParametersRepresentation Extract Table Parameters Output Represetns extract table parameters. * `source` (_string_) Table identifier to be extracted from the flatten node. **Filter Group:** Small **Available Version:** 60.0 ### FieldRepresentation Field Output Represents a field in a JSON schema. * `attributePath` (_string_) Attribute path. **Filter Group:** Small **Available Version:** 60.0 * `index` (_integer_) Index. **Filter Group:** Small **Available Version:** 60.0 * `isUniqueIdentifierField` (_boolean_) Indicates whether this field will be used to do de-duplication (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Label of the field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 60.0 ### FilterDatSpaceInputRepresentation Filter Data Space Input Represents the input for a data space filter. * `fieldName` (_string_) Name of the field. **Available Version:** 60.0 * `filterType` (_string_) Type of filter. **Available Version:** 60.0 Allowed values: `Condition`. * `filterValue` (_string_) Value of the filter. **Available Version:** 60.0 * `operator` (_string_) Operator of the filter. **Available Version:** 60.0 Allowed values: `Equals`, `In_Operator`. * `relationshipName` (_string_) Name of the relationship. **Available Version:** 60.0 * `tableName` (_string_) Name of the table. **Available Version:** 60.0 ### FilterExpressionDatSpaceInputRepresentation Filter Expression Data Space Input Represents the input for a data space filter expression. * `filterOperator` (_string_) Operator for the filter. **Available Version:** 63.0 Allowed values: `And_Operator`, `Or_Operator`. * `filterType` (_string_) Type of filter. **Available Version:** 63.0 Allowed values: `Condition`. * `filters` (_array of FilterDatSpaceInputRepresentation_) Filters in the filter expression. **Available Version:** 63.0 ### FilterExpressionInputRepresentation Filter Expression Input Represents filter expression for filters. * `field` (_string_, required) Field to filter on. **Available Version:** 60.0 * `operands` (_array of object_, required) List of filter expression operands. **Available Version:** 60.0 * `operator` (_string_, required) Operator use in filter. **Available Version:** 60.0 * `type` (_string_, required) Data type of field to filter. **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### FilterExpressionRepresentation Filter Expression Output Represents a filter expression. * `field` (_string_) The field to filter on. **Filter Group:** Small **Available Version:** 60.0 * `operands` (_array of object_) Filter expression operands. **Filter Group:** Small **Available Version:** 60.0 * `operator` (_string_) Operator used in the filter. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Data type of the filtered field. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### FilterNodeInputRepresentation Filter Node Input Represents filter node in batch data transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. Includes all fields of `FilterParametersInputRepresentation`. ### FilterNodeRepresentation Filter Node Output Represents a filter node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FilterParametersRepresentation`. ### FilterParametersInputRepresentation Filter Parameters Input Represents filter expression. * `filterBooleanLogic` (_string_, required) Filter boolean logic. **Available Version:** 60.0 * `filterExpressions` (_array of FilterExpressionInputRepresentation_, required) Filter expressions. **Available Version:** 60.0 ### FilterParametersRepresentation Filter Parameters Output Represents a filter node. * `filterBooleanLogic` (_string_) Filter boolean logic. **Filter Group:** Small **Available Version:** 60.0 * `filterExpressions` (_array of FilterExpressionRepresentation_) Filter expressions. **Filter Group:** Small **Available Version:** 60.0 ### FlattenFieldInputRepresentation Flatten Field Input Flatten node field representation. * `label` (_string_, required) Label. **Available Version:** 60.0 * `name` (_string_, required) Name. **Available Version:** 60.0 ### FlattenFieldRepresentation Flatten Field Output Represents a flatten node field. * `isSystemField` (_boolean_) Indicates whether the field is a system field (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Label of the field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 60.0 ### FlattenJsonNodeInputRepresentation Flatten Json Node Input Represents the input for a flatten JSON node. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Parameters for the flatten node type, which contains schema and table information. **Available Version:** 60.0 Includes all fields of `FlattenJsonParametersInputRepresentation`. ### FlattenJsonNodeRepresentation Flatten Json Node Output Represents a flatten JSON node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FlattenJsonParametersRepresentation`. ### FlattenJsonParametersInputRepresentation Flatten Json Parameters Input Represents the input for flatten JSON node parameters. * `jsonSchemaDetails` (_object_) JSON schema of the data to be flatten in this node. **Available Version:** 60.0 Includes all fields of `JsonSchemaDetailsInputRepresentation`. * `sourceField` (_string_) Field name that contains the JSON string to be flattened. **Available Version:** 60.0 * `tables` (_object_) Map of table names and configurations to be produced by this node. **Available Version:** 60.0 Additional properties: `object`. ### FlattenJsonParametersRepresentation Flatten Json Parameters Output Represents flatten JSON parameters. * `jsonSchemaDetails` (_object_) JSON schema details. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `JsonSchemaDetailsRepresentation`. * `sourceField` (_string_) Field name that contains the JSON string to be flattened. **Filter Group:** Small **Available Version:** 60.0 * `tables` (_object_) Mapping between the parameter and fields within the parameter. **Filter Group:** Small **Available Version:** 60.0 Additional properties: `object`. List of JSON schema fields for flattening. **Filter Group:** Small **Available Version:** 60.0 * `fields` (_array of FieldRepresentation_) JSON schema fields. **Filter Group:** Small **Available Version:** 60.0 ### FlattenNodeInputRepresentation Flatten Node Input Represents flatten node input. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `FlattenParametersInputRepresentation`. ### FlattenNodeRepresentation Flatten Node Output Represents a flatten node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FlattenParametersRepresentation`. ### FlattenParametersInputRepresentation Flatten Parameters Input Flatten node. * `delimiter` (_string_, required) Delimiter. **Available Version:** 60.0 * `includeSelfId` (_boolean_, required) Indicates whether to include self ID (`true`) or not (`false`). **Available Version:** 60.0 * `parentField` (_string_, required) Parent field. **Available Version:** 60.0 * `pathField` (_object_, required) Path field. **Available Version:** 60.0 Includes all fields of `FlattenFieldInputRepresentation`. * `selfField` (_string_, required) Self field. **Available Version:** 60.0 ### FlattenParametersRepresentation Flatten Parameters Output Represents flatten node parameters. * `delimiter` (_string_) Delimiter field. **Filter Group:** Small **Available Version:** 60.0 * `includeSelfId` (_boolean_) Indicates whether to include the self ID (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `parentField` (_string_) Parent field. **Filter Group:** Small **Available Version:** 60.0 * `pathField` (_object_) Path to the field. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FlattenFieldRepresentation`. * `selfField` (_string_) Self field. **Filter Group:** Small **Available Version:** 60.0 ### FormatDateNodeInputRepresentation Format Date Node Input Represents the date format conversion node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `FormatDateParametersInputRepresentation`. ### FormatDateNodeRepresentation Format Date Node Output Represents a date format conversion node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FormatDateParametersRepresentation`. ### FormatDateParametersInputRepresentation Format Date Parameters Input Format date node representation. * `sourceField` (_string_, required) Source field to format. **Available Version:** 60.0 * `sourceFormats` (_array of FormatDatePatternInputRepresentation_, required) Source date formats. **Available Version:** 60.0 * `targetField` (_object_, required) Target field. **Available Version:** 60.0 Includes all fields of `NameLabelInputRepresentation`. * `targetFormat` (_object_, required) Target date format. **Available Version:** 60.0 Includes all fields of `FormatDatePatternInputRepresentation`. ### FormatDateParametersRepresentation Format Date Parameters Output Represents format date node parameters. * `sourceField` (_string_) Name of the source field. **Filter Group:** Small **Available Version:** 60.0 * `sourceFormats` (_array of FormatDatePatternRepresentation_) List of source formats. **Filter Group:** Small **Available Version:** 60.0 * `targetField` (_object_) Source target fields. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `NameLabelRepresentation`. * `targetFormat` (_object_) Target format. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FormatDatePatternRepresentation`. ### FormatDatePatternInputRepresentation Format Date Pattern Input Format date pattern representation. * `construction` (_array of string_, required) Construction. **Available Version:** 60.0 * `groups` (_array of string_, required) Groups. **Available Version:** 60.0 * `regex` (_string_, required) Regular expression. **Available Version:** 60.0 ### FormatDatePatternRepresentation Format Date Pattern Output Reperesents a format date pattern. * `construction` (_array of string_) Construction of the date pattern. **Filter Group:** Small **Available Version:** 60.0 * `groups` (_array of string_) List of groups in the date pattern. **Filter Group:** Small **Available Version:** 60.0 * `regex` (_string_) Regular expression. **Filter Group:** Small **Available Version:** 60.0 ### FormulaNodeInputRepresentation Formula Node Input Represents formula node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `FormulaParametersInputRepresentation`. ### FormulaNodeRepresentation Formula Node Output Represents a formula node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FormulaParametersRepresentation`. ### FormulaParametersInputRepresentation Formula Parameters Input Represents a formula. * `expressionType` (_string_) Type of formula expression. **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. ### FormulaParametersRepresentation Formula Parameters Output Represents formula parameters. Discriminator: `expressionType` selects the concrete type. * `expressionType` (_string_) Type of SQL formula expression. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. ### IBMDataShareTargetInputRepresentation IBM Data Share Target Input Represents the input for creating an IBM data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `accountUrl` (_string_) IBM account URL. **Available Version:** 63.0 * `serviceAccountId` (_string_) IBM service account ID created as part of connection creation in IBM. **Available Version:** 63.0 ### IBMDataShareTargetRepresentation IBM Data Share Target Output Represents an IBM data share target. Includes all fields of `DataShareTargetRepresentation`. * `accountUrl` (_string_) IBM account URL. **Filter Group:** Small **Available Version:** 63.0 * `serviceAccountId` (_string_) IBM service account ID. **Filter Group:** Small **Available Version:** 63.0 ### IngestApiConnectionInputRepresentation Ingest API Connection Input Input representation for an Ingest API connector. Includes all fields of `ConnectionInputRepresentation`. ### IngestApiConnectionRepresentation Ingest API Connection Output Represents an Ingest API connector. Includes all fields of `ConnectionRepresentation`. * `status` (_string_) Status of the Ingest API connector. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Connected`, `Disconnected`, `Failed`, `NeedsReAuth`. * `tenantSpecificEndpoint` (_string_) Tenant-specific endpoint of the Ingest API connector. **Filter Group:** Small **Available Version:** 61.0 ### IngestApiConnectionSchemaFieldInputRepresentation Ingest API Connection Schema Field Input Represents the input for Ingestion API field types. Includes all fields of `ConnectionSchemaFieldInputRepresentation`. * `currencyIsoCode` (_boolean_) Indicates whether the field is a currency ISO code (`true`) or not (`false`). **Available Version:** 61.0 * `dataType` (_string_) Data type of the field. **Available Version:** 61.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### IngestApiConnectionSchemaFieldRepresentation Ingest API Connection Schema Field Output Represents an Ingestion API connection schema field. Includes all fields of `ConnectionSchemaFieldRepresentation`. * `currencyIsoCode` (_boolean_) Indicates whether the field is a currency ISO code (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 61.0 * `dataType` (_string_) Data type of the schema field. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. ### IngestApiConnectionSchemaInputRepresentation Ingest API Connection Schema Input Represents the input for an ingestion API schema. Includes all fields of `ConnectionSchemaInputRepresentation`. * `fields` (_array of IngestApiConnectionSchemaFieldInputRepresentation_) List of schema fields. **Available Version:** 61.0 ### IngestApiConnectionSchemaRepresentation Ingest API Connection Schema Output Represents a streaming app connection schema. Includes all fields of `ConnectionSchemaRepresentation`. * `availabilityStatus` (_string_) Availability status of the event. **Filter Group:** Small **Available Version:** 61.0 Allowed values: `Available`, `InUse`. * `fields` (_array of IngestApiConnectionSchemaFieldRepresentation_) List of schema fields. **Filter Group:** Small **Available Version:** 61.0 ### JoinNodeInputRepresentation Join Node Input Represents join data node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `JoinParametersInputRepresentation`. ### JoinNodeRepresentation Join Node Output Represents a join data node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `JoinParametersRepresentation`. ### JoinParametersInputRepresentation Join Parameters Input Represents join node. * `joinType` (_string_, required) Join type. **Available Version:** 60.0 Allowed values: `Cross`, `Inner`, `LeftOuter`, `Lookup`, `MultiValueLookup`, `Outer`, `RightOuter`. * `leftKeys` (_array of string_, required) Left keys. **Available Version:** 60.0 * `leftQualifier` (_string_, required) Left qualifier. **Available Version:** 60.0 * `rightKeys` (_array of string_, required) Right keys. **Available Version:** 60.0 * `rightQualifier` (_string_, required) Right qualifier. **Available Version:** 60.0 ### JoinParametersRepresentation Join Parameters Output Represents join node parameters.. * `joinType` (_string_) Type of join. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Cross`, `Inner`, `LeftOuter`, `Lookup`, `MultiValueLookup`, `Outer`, `RightOuter`. * `leftKeys` (_array of string_) List of join left keys. **Filter Group:** Small **Available Version:** 60.0 * `leftQualifier` (_string_) Name of the join left qualifier. **Filter Group:** Small **Available Version:** 60.0 * `rightKeys` (_array of string_) List of join right keys. **Filter Group:** Small **Available Version:** 60.0 * `rightQualifier` (_string_) Name of the join right qualifier. **Filter Group:** Small **Available Version:** 60.0 ### JsonArrayInputRepresentation Json Array Input Represents the input for an array JSON field. Includes all fields of `JsonSchemaInputRepresentation`. * `items` (_object_) List of items in the array. **Available Version:** 60.0 Includes all fields of `JsonSchemaInputRepresentation`. ### JsonBooleanInputRepresentation Json Boolean Input Represents the input for a boolean JSON field. Includes all fields of `JsonSchemaInputRepresentation`. ### JsonIntegerInputRepresentation Json Integer Input Represents the input for an integer JSON field. Includes all fields of `JsonSchemaInputRepresentation`. ### JsonNullInputRepresentation Json Null Input Represents the input for a null JSON field. Includes all fields of `JsonSchemaInputRepresentation`. ### JsonNumberInputRepresentation Json Number Input Represents the input for a number JSON field. Includes all fields of `JsonSchemaInputRepresentation`. ### JsonObjectInputRepresentation Json Object Input Represents the input for an object JSON field. Includes all fields of `JsonSchemaInputRepresentation`. * `properties` (_object_) Mapping of property names and corresponding JSON schemas. **Available Version:** 60.0 Additional properties: `object`. * `required` (_array of string_) List of attributes that are marked as required in the JSON schema. **Available Version:** 60.0 ### JsonSchemaDetailsInputRepresentation Json Schema Details Input Represents the input for JSON schema details. * `dateAdded` (_integer (int64)_) Date for when the file was uploaded in the UI. **Available Version:** 60.0 * `name` (_string_) Name of the file uploaded in the UI that contains the JSON schema. **Available Version:** 60.0 * `schema` (_JsonArrayInputRepresentation | JsonBooleanInputRepresentation | JsonIntegerInputRepresentation | JsonNullInputRepresentation | JsonNumberInputRepresentation | JsonObjectInputRepresentation | JsonStringInputRepresentation_) JSON schema of the data to be flatten in this node. Use the input object that corresponds to the data type. For example, use the Json Array Input for the `Array` type. **Available Version:** 60.0 One of: `JsonArrayInputRepresentation`, `JsonBooleanInputRepresentation`, `JsonIntegerInputRepresentation`, `JsonNullInputRepresentation`, `JsonNumberInputRepresentation`, `JsonObjectInputRepresentation`, `JsonStringInputRepresentation`. * `size` (_number (double)_) Size of the file (in MB) that contains the JSON schema. **Available Version:** 60.0 ### JsonSchemaDetailsRepresentation Json Schema Details Output Represents JSON schema details. * `dateAdded` (_integer (int64)_) Date for when the file was uploaded in the UI. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the file uploaded in the UI that contains the JSON schema. **Filter Group:** Small **Available Version:** 60.0 * `schema` (_object_) JSON schema. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `JsonSchemaRepresentation`. * `size` (_number (double)_) Size of the file (in MB) that contains the JSON schema. **Filter Group:** Small **Available Version:** 60.0 ### JsonSchemaInputRepresentation Json Schema Input Represents the input for a JSON schema. * `type` (_string_) Data type of the JSON field. **Available Version:** 60.0 Allowed values: `Array`, `Boolean`, `Integer`, `Null`, `Number`, `Object`, `String`. ### JsonSchemaRepresentation Json Schema Output Represents a JSON schema. * `type` (_string_) Type of schema field. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Array`, `Boolean`, `Integer`, `Null`, `Number`, `Object`, `String`. ### JsonStringInputRepresentation Json String Input Represents the input for a string JSON field. Includes all fields of `JsonSchemaInputRepresentation`. ### KnowledgeSelectInputRepresentation Knowledge Select Input The input representation for knowledge select input. Includes all fields of `CdpAssetBaseInputRepresentation`. * `knowledgeIds` (_array of string_) List of knowledge IDs. **Available Version:** 65.0 * `searchIndexes` (_array of string_) List of search indexes. **Available Version:** 65.0 ### KnowledgeSourceFileInputRepresentation Knowledge Source File Input Represents the input for a knowledge source file. Includes all fields of `CdpAssetBaseInputRepresentation`. * `fileIndexStatus` (_string_) Index status of the file. **Available Version:** 65.0 * `fileName` (_string_) Name of the file. **Available Version:** 65.0 * `filePath` (_string_) Path of the file. **Available Version:** 65.0 * `fileType` (_string_) File type. **Available Version:** 65.0 ### KnowledgeSpaceDeepResearchOutputRepresentation Knowledge Space Deep Research Output Represents the status and details of a deep research job. * `config` (_object_) Deep research configuration. **Filter Group:** Small **Available Version:** 67.0 * `error` (_object_) Error details if the job failed. **Filter Group:** Small **Available Version:** 67.0 * `plan` (_object_) Execution plan with steps. **Filter Group:** Small **Available Version:** 67.0 Includes all fields of `KnowledgeSpaceDeepResearchPlanOutputRepresentation`. * `query` (_string_) Query text. **Filter Group:** Small **Available Version:** 67.0 * `report` (_object_) Report content. **Filter Group:** Small **Available Version:** 67.0 * `researchId` (_string_) Deep research job identifier. **Filter Group:** Small **Available Version:** 67.0 * `runDetails` (_object_) Execution details. **Filter Group:** Small **Available Version:** 67.0 * `status` (_string_) Job status. Valid values are PENDING, RUNNING, COMPLETED, FAILED, and CANCELLED. **Filter Group:** Small **Available Version:** 67.0 ### KnowledgeSpaceRunResearchInputRepresentation Knowledge Space Run Research Input Represents the input for running a deep research job. Includes all fields of `CdpAssetBaseInputRepresentation`. * `researchId` (_string_) Deep research job identifier. **Available Version:** 67.0 ### LoadDatasetInputRepresentation Load Data Input Represents the data to load. * `label` (_string_, required) Label for the data. **Available Version:** 60.0 * `type` (_string_, required) Data object type. **Available Version:** 60.0 Allowed values: `DataLakeObject`, `DataModelObject`. ### LoadDatasetRepresentation Load Dataset Output Represents the dataset of a load node. Discriminator: `type` selects the concrete type. * `label` (_string_) Label for the dataset. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type of dataset. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `CalculatedInsightObject`, `DataLakeObject`, `DataModelObject`. ### LoadNodeInputRepresentation Load Node Input Represents load data node in a batch data transform. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `LoadParametersInputRepresentation`. ### LoadNodeRepresentation Load Node Output Represents a load node output. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `LoadParametersRepresentation`. ### LoadParametersInputRepresentation Load Parameters Input Represents load node. * `dataset` (_object_, required) Data to load. **Available Version:** 60.0 Includes all fields of `LoadDatasetInputRepresentation`. * `fields` (_array of string_, required) Fields to load. **Available Version:** 60.0 * `sampleDetails` (_object_, required) Sample parameters. **Available Version:** 60.0 Includes all fields of `SampleParametersInputRepresentation`. * `sampleSize` (_integer_, required) Number of rows to load. **Available Version:** 60.0 ### LoadParametersRepresentation Load Parameters Output Represents load node output. * `dataset` (_object_) Input dataset. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `LoadDatasetRepresentation`. * `fields` (_array of string_) Fields to select. **Filter Group:** Small **Available Version:** 60.0 * `sampleDetails` (_object_) Sample parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SampleParametersRepresentation`. * `sampleSize` (_integer_) Sample size. **Filter Group:** Small **Available Version:** 60.0 ### MarketingCloudConnectionBusinessUnitRepresentation Marketing Cloud Connection Business Unit Output Represents a business unit for the Marketing Cloud connector. * `id` (_string_) ID of the business unit. **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the business unit. **Filter Group:** Small **Available Version:** 62.0 * `mid` (_string_) Member ID (MID) of the business unit. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Developer name of the business unit. **Filter Group:** Small **Available Version:** 62.0 ### MarketingCloudConnectionInputRepresentation Marketing Cloud Connection Input Input representation for a Marketing Cloud connector. Includes all fields of `ConnectionInputRepresentation`. ### MarketingCloudConnectionPatchInputRepresentation Marketing Cloud Connection Patch Input Input representation for a Marketing Cloud connector for a patch request. Includes all fields of `ConnectionPatchInputRepresentation`. * `addActivationBusinessUnits` (_array of string_) List of Marketing Cloud business units to be added for activation. **Available Version:** 63.0 * `addBusinessUnitsToDataSpaces` (_array of McBuToDataSpaceInputRepresentation_) List of Marketing Cloud business-unit-to-data-space mappings to be added. **Available Version:** 63.0 * `addIngestionBusinessUnits` (_array of string_) List of Marketing Cloud business units to be added for data ingestion. **Available Version:** 63.0 * `createProfileMappings` (_boolean_) Indicates whether mapping data for profile business units is allowed (`true`) or not (`false`). **Available Version:** 63.0 * `removeActivationBusinessUnits` (_array of string_) List of Marketing Cloud business unit activations to be removed. **Available Version:** 63.0 * `removeBusinessUnitsToDataSpaces` (_array of McBuToDataSpaceInputRepresentation_) List of Marketing Cloud business-unit-to-data-space mappings to be removed. **Available Version:** 63.0 * `removeIngestionBusinessUnits` (_array of string_) List of Marketing Cloud business units from which data ingestion is to be removed. **Available Version:** 63.0 ### MarketingCloudConnectionRepresentation Marketing Cloud Connection Output Represents a Marketing Cloud connector. Includes all fields of `ConnectionRepresentation`. * `activationBusinessUnits` (_array of MarketingCloudConnectionBusinessUnitRepresentation_) List of member IDs (MIDs), Marketing Cloud business units, selected for activation. **Filter Group:** Small **Available Version:** 62.0 * `businessUnitsToDataSpaces` (_array of McBuToDataSpaceRepresentation_) List of Marketing Cloud business-unit-to-data-space mappings. **Filter Group:** Small **Available Version:** 62.0 * `createProfileBuMappings` (_boolean_) Indicates whether automatic mapping of Marketing Cloud subscriber data to the affiliated data model object (DMO) is enabled (`true`) or not (`false`). The information maps contacts to business units. **Filter Group:** Small **Available Version:** 62.0 * `eid` (_string_) Enterprise ID (EID) of a Marketing Cloud account. The EID is present only if the connection is authenticated with a Marketing Cloud account. Otherwise, the user must log into the Data 360 user interface to authenticate their org with a Marketing Cloud account. **Filter Group:** Small **Available Version:** 62.0 * `ingestionBusinessUnits` (_array of MarketingCloudConnectionBusinessUnitRepresentation_) List of member IDs (MIDs), Marketing Cloud business units, selected for ingestion. **Filter Group:** Small **Available Version:** 62.0 ### McBuToDataSpaceInputRepresentation Marketing Cloud Business Unit to Data Space Input Input representation for Marketing Cloud business-unit-to-data-space mappings for a patch request. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataspaceName` (_string_, required) Name of the data space. **Available Version:** 63.0 * `mid` (_string_, required) Member ID (MID) of the Marketing Cloud business unit. Specify a business unit already configured for ingestion or one passed for addition in the payload of the request. **Available Version:** 63.0 ### McBuToDataSpaceRepresentation Marketing Cloud Business Unit to Data Space Output Represents a mapping of a Marketing Cloud business unit to a data space. * `dataSpaceId` (_string_) ID of the data space object. **Filter Group:** Small **Available Version:** 62.0 * `dataSpaceName` (_string_) Name of the data space. **Filter Group:** Small **Available Version:** 62.0 * `internalOrgId` (_string_) ID of the internal org object. **Filter Group:** Small **Available Version:** 62.0 * `internalOrgName` (_string_) Name of the internal org, a Marketing Cloud business unit name. **Filter Group:** Small **Available Version:** 62.0 * `label` (_string_) Label of the data space internal org object. **Filter Group:** Small **Available Version:** 62.0 * `mid` (_string_) Member ID (MID) of the internal org's external record. **Filter Group:** Small **Available Version:** 62.0 * `name` (_string_) Name of the data space internal org object. **Filter Group:** Small **Available Version:** 62.0 ### MlBinaryClassificationJobDefInputRepresentation Ml Binary Classification Job Def Input Represents the input for creating a binary classification prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveInputRepresentation`. * `binaryClassificationSettings` (_object_) Binary classification settings. **Available Version:** 66.0 Includes all fields of `MlBinaryClassificationJobDefSettingsInputRepresentation`. ### MlBinaryClassificationJobDefRepresentation Ml Binary Classification Job Def Output Represents a binary classification prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveRepresentation`. * `binaryClassificationSettings` (_object_) Settings configuration for the binary classification prediction job definition. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlBinaryClassificationJobDefSettingsRepresentation`. ### MlBinaryClassificationJobDefSettingsInputRepresentation Ml Binary Classification Job Def Settings Input Represents the settings configuration for a binary classification prediction job definition. * `maxPrescriptions` (_integer_) Maximum number of prescriptions to generate. **Available Version:** 66.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to generate. **Available Version:** 66.0 * `prescriptionThreshold` (_integer_) Prescription threshold value. **Available Version:** 66.0 * `showClassProbabilities` (_boolean_) Indicates whether the outcome columns show class probabilities for both positive and negative classes (`true`) or not (`false`). If unspecified, the default value is `true`. **Available Version:** 66.0 ### MlBinaryClassificationJobDefSettingsRepresentation Ml Binary Classification Job Def Settings Output Represents the settings configuration for a binary classification prediction job definition. * `maxPrescriptions` (_integer_) Maximum number of prescriptions to include per prediction. **Filter Group:** Small **Available Version:** 66.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to include per prediction. **Filter Group:** Small **Available Version:** 66.0 * `prescriptionThreshold` (_integer_) Improvement threshold for prescriptions. **Filter Group:** Small **Available Version:** 66.0 * `showClassProbabilities` (_boolean_) Indicates whether the outcome columns show class probabilities for both positive and negative classes (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 ### MlClusteringJobDefInputRepresentation Ml Clustering Job Def Input Represents the input for creating a clustering prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveInputRepresentation`. * `clusteringSettings` (_object_) Clustering settings. **Available Version:** 68.0 Includes all fields of `MlClusteringJobDefSettingsInputRepresentation`. ### MlClusteringJobDefRepresentation Ml Clustering Job Def Output Represents a clustering prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveRepresentation`. * `clusteringSettings` (_object_) Settings configuration for the clustering prediction job definition. **Filter Group:** Small **Available Version:** 68.0 Includes all fields of `MlClusteringJobDefSettingsRepresentation`. ### MlClusteringJobDefSettingsInputRepresentation Ml Clustering Job Def Settings Input Represents the settings configuration for a clustering prediction job definition. * `clusterIdFieldLabel` (_string_) Label for the cluster ID output field. **Available Version:** 68.0 * `clusterLabelFieldLabel` (_string_) Label for the cluster label output field. **Available Version:** 68.0 * `maxTopContributors` (_integer_) Maximum number of top contributors for clustering. **Available Version:** 68.0 ### MlClusteringJobDefSettingsRepresentation Ml Clustering Job Def Settings Output Represents the settings configuration for a clustering prediction job definition. * `clusterIdFieldLabel` (_string_) Label for the cluster ID output field. **Filter Group:** Small **Available Version:** 68.0 * `clusterLabelFieldLabel` (_string_) Label for the cluster label output field. **Filter Group:** Small **Available Version:** 68.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to include per prediction. **Filter Group:** Small **Available Version:** 68.0 ### MlDmoFieldSourceTargetRelationshipInputRepresentation Ml Dmo Field Source Target Relationship Input Represents the input for a foreign-key relationship between two data model objects (DMOs). Contains developer names for source DMO, source field, target DMO, and target field. * `relationSourceDmoFieldName` (_string_, required) Developer name of the source DMO field. **Available Version:** 67.0 * `relationSourceDmoName` (_string_, required) Developer name of the source DMO. **Available Version:** 67.0 * `relationTargetDmoFieldName` (_string_, required) Developer name of the target DMO field. **Available Version:** 67.0 * `relationTargetDmoName` (_string_, required) Developer name of the target DMO. **Available Version:** 67.0 ### MlFilterFieldAssetInputRepresentation Ml Filter Field Asset Input Represents the input for a filter field asset. Includes all fields of `CdpAssetBaseInputRepresentation`. ### MlMulticlassClassificationJobDefInputRepresentation Ml Multiclass Classification Job Def Input Represents the input for creating a multiclass classification prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveInputRepresentation`. * `multiclassClassificationSettings` (_object_) Multiclass classification settings. **Available Version:** 66.0 Includes all fields of `MlMulticlassClassificationJobDefSettingsInputRepresentation`. ### MlMulticlassClassificationJobDefRepresentation Ml Multiclass Classification Job Def Output Represents a multiclass classification prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveRepresentation`. * `multiclassClassificationSettings` (_object_) Settings configuration for the multiclass classification prediction job definition. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlMulticlassClassificationJobDefSettingsRepresentation`. ### MlMulticlassClassificationJobDefSettingsInputRepresentation Ml Multiclass Classification Job Def Settings Input Represents the settings configuration for a multiclass classification prediction job definition. * `maxTopContributors` (_integer_) Maximum number of top contributors to generate. **Available Version:** 66.0 * `numberOfClasses` (_integer_) Number of classes to include in the output. If unspecified, the default value is all classes in the outcome. **Available Version:** 66.0 ### MlMulticlassClassificationJobDefSettingsRepresentation Ml Multiclass Classification Job Def Settings Output Represents the settings configuration for a multiclass classification prediction job definition. * `maxTopContributors` (_integer_) Maximum number of top contributors to include per prediction. **Filter Group:** Small **Available Version:** 66.0 * `numberOfClasses` (_integer_) Number of classes to include in the output. **Filter Group:** Small **Available Version:** 66.0 ### MlRetrieverSourceInputRepresentation Ml Retriever Source Input Represents the input for a search index reference. Includes all fields of `CdpAssetBaseInputRepresentation`. * `type` (_string_) Type of search index source. **Available Version:** 61.0 Allowed values: `SearchIndex`, `SearchIndexConfiguration`. ### MlPredictionJobDefDataFieldInputRepresentation Ml Prediction Job Def Data Field Input Represents a data model object (DMO) field with an optional relationship path. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataObject` (_object_) Data model object (DMO) that contains the field. **Available Version:** 67.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. ### MlPredictionJobDefFeaturesConfigInputRepresentation Ml Prediction Job Def Features Config Input Represents the input configuration for features, including the data model object (DMO) and field mappings. * `dataObject` (_object_) Input data model object (DMO). **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `fields` (_array of MlPredictionJobDefFeatureMappingInputRepresentation_) List of field mappings between model features and DMO fields. **Available Version:** 59.0 ### MlPredictionJobDefFeaturesConfigRepresentation Ml Prediction Job Def Features Config Output Represents the features configuration for a prediction job definition. * `dataObject` (_object_) Input data model object (DMO). **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `fields` (_array of MlPredictionJobDefFeatureMappingRepresentation_) List of mappings between model features and data model object (DMO) fields. **Filter Group:** Small **Available Version:** 59.0 ### MlPredictionJobDefFeatureMappingInputRepresentation Ml Prediction Job Def Feature Mapping Input Represents the mapping between a model feature and a data model object (DMO) field. * `mappedField` (_object_) Mapped data model object (DMO) field. **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefMappedFieldInputRepresentation`. * `modelField` (_object_) Model feature field. **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `updateScore` (_boolean_) Indicates whether an update to this field triggers a prediction update for streaming jobs (`true`) or not (`false`). **Available Version:** 59.0 ### MlPredictionJobDefFeatureMappingRepresentation Ml Prediction Job Def Feature Mapping Output Represents the mapping between a model feature and a data model object (DMO) field. * `mappedField` (_object_) Mapped data model object (DMO) field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefMappedFieldRepresentation`. * `modelField` (_object_) Model feature field. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `updateScore` (_boolean_) Indicates whether an update to this field triggers a prediction update for streaming jobs (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 59.0 ### MlPredictionJobDefFieldRelationshipInputRepresentation Ml Prediction Job Def Field Relationship Input Represents a join relationship between two data model object (DMO) fields. * `sourceField` (_object_) Source field on the left side of the join. **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefDataFieldInputRepresentation`. * `targetField` (_object_) Target field on the right side of the join. **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefDataFieldInputRepresentation`. ### MlPredictionJobDefInputFieldInputRepresentation Ml Prediction Job Def Input Field Input Represents an input field for a prediction job definition. * `mappedField` (_object_) Mapped data model object (DMO) field. **Available Version:** 66.0 Includes all fields of `MlPredictionJobDefMappedFieldInputRepresentation`. * `updateScore` (_boolean_) Indicates whether a prediction is rescored when this field updates (`true`) or not (`false`). **Available Version:** 66.0 ### MlPredictionJobDefInputFieldRepresentation Ml Prediction Job Def Input Field Output Represents an input field configuration for a prediction job definition. * `mappedField` (_object_) Mapped data model object (DMO) field. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlPredictionJobDefMappedFieldRepresentation`. * `updateScore` (_boolean_) Indicates whether an update to this field triggers a prediction update for streaming jobs (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 66.0 ### MlPredictionJobDefMappedFieldInputRepresentation Ml Prediction Job Def Mapped Field Input Represents a data model object (DMO) field with an optional relationship path. Includes all fields of `CdpAssetBaseInputRepresentation`. * `dataObject` (_object_) Data model object (DMO) that contains the field. **Available Version:** 59.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `relationshipPath` (_array of MlPredictionJobDefFieldRelationshipInputRepresentation_) List of join relationships for accessing the field from a related DMO. **Available Version:** 59.0 ### MlPredictionJobDefPredictiveInputRepresentation Ml Prediction Job Def Predictive Input Represents the input configuration for a prediction job definition. Includes all fields of `MlPredictionJobDefBaseInputRepresentation`. * `inputConfig` (_object_) Input configuration for the prediction job definition. **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefFeaturesConfigInputRepresentation`. ### MlPredictionJobDefPredictiveRepresentation Ml Prediction Job Def Predictive Output Represents the base configuration for predictive prediction job definitions. Includes all fields of `MlPredictionJobDefBaseRepresentation`. * `inputConfig` (_object_) Input configuration for features and field mappings. **Filter Group:** Small **Available Version:** 59.0 Includes all fields of `MlPredictionJobDefFeaturesConfigRepresentation`. ### MlPredictionJobDefSettingsRepresentation Ml Prediction Job Def Settings Output Represents the general settings configuration for a prediction job definition. * `maxPrescriptions` (_integer_) Maximum number of prescriptions to include per prediction. **Filter Group:** Small **Available Version:** 65.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to include per prediction. **Filter Group:** Small **Available Version:** 65.0 * `prescriptionThreshold` (_integer_) Improvement threshold for prescriptions. **Filter Group:** Small **Available Version:** 65.0 ### MlRegressionJobDefInputRepresentation Ml Regression Job Def Input Represents the input for creating a regression prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveInputRepresentation`. * `regressionSettings` (_object_) Regression settings. **Available Version:** 66.0 Includes all fields of `MlRegressionJobDefSettingsInputRepresentation`. ### MlRegressionJobDefRepresentation Ml Regression Job Def Output Represents a regression prediction job definition. Includes all fields of `MlPredictionJobDefPredictiveRepresentation`. * `predictionSettings` (_object_) General prediction settings configuration. **Filter Group:** Small **Available Version:** 65.0 Includes all fields of `MlPredictionJobDefSettingsRepresentation`. * `regressionSettings` (_object_) Regression-specific settings configuration. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlRegressionJobDefSettingsRepresentation`. ### MlRegressionJobDefSettingsInputRepresentation Ml Regression Job Def Settings Input Represents the settings configuration for a regression prediction job definition. * `maxPrescriptions` (_integer_) Maximum number of prescriptions to generate. **Available Version:** 66.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to generate. **Available Version:** 66.0 * `prescriptionThreshold` (_integer_) Improvement threshold for prescriptions. **Available Version:** 66.0 ### MlRegressionJobDefSettingsRepresentation Ml Regression Job Def Settings Output Represents the settings configuration for a regression prediction job definition. * `maxPrescriptions` (_integer_) Maximum number of prescriptions to include per prediction. **Filter Group:** Small **Available Version:** 66.0 * `maxTopContributors` (_integer_) Maximum number of top contributors to include per prediction. **Filter Group:** Small **Available Version:** 66.0 * `prescriptionThreshold` (_integer_) Improvement threshold for prescriptions. **Filter Group:** Small **Available Version:** 66.0 ### MlRetrieverCitationConfigurationInputRepresentation Ml Retriever Citation Configuration Input Represents the input for configuring citation fields. * `baseUrl` (_string_) Base URL that the `mappedUrlField` value is appended to. For example, if `baseUrl` is "[https://example.com](https://example.com)" and the data model object (DMO) field contains "/docs/article-123", the resulting URL is "[https://example.com/docs/article-123](https://example.com/docs/article-123)". **Available Version:** 61.0 * `mappedLabelField` (_object_) Name of the mapped DMO field containing the citation label. **Available Version:** 61.0 Includes all fields of `MlRetrieverCitationFieldInputRepresentation`. * `mappedUrlField` (_object_) Name of the mapped data model object (DMO) field containing the URL or URL path. When `baseUrl` is provided, this field's value is appended to it to construct the complete URL. **Available Version:** 61.0 Includes all fields of `MlRetrieverCitationFieldInputRepresentation`. * `type` (_string_, required) Type of citation. **Available Version:** 61.0 Allowed values: `Custom`, `Default`. ### MlRetrieverCitationFieldInputRepresentation Ml Retriever Citation Field Input Represents the input for a citation field reference. Includes all fields of `MlRetrieverFieldBaseInputRepresentation`. ### MlRetrieverConfigurationCustomSqlInputRepresentation Ml Retriever Configuration Custom Sql Input Represents the input for a CustomSql retriever configuration that retrieves data from an arbitrary Data 360 SQL query. Supports queries from data model object (DMO), data lake object (DLO), CalculatedInsight, or vector\_search/hybrid\_search SQL functions. Call POST /retrievers/actions/review before creation. Includes all fields of `MlRetrieverConfigurationBaseInputRepresentation`. * `isAdvancedModeSupported` (_boolean_) Indicates whether advanced retrieval mode is supported (`true`) or not (`false`). If unspecified, the default value is `false`. **Available Version:** 67.0 * `isCitationSupported` (_boolean_) Indicates whether citation is supported (`true`) or not (`false`). If unspecified, the default value is `false`. When `true`, `queryCitationDefinition` is required. **Available Version:** 67.0 * `isEnrichedIndexSupported` (_boolean_) Indicates whether enriched index chunk resolution is supported (`true`) or not (`false`). If unspecified, the default value is `false`. When `true`, `enrichedSearchIndexDefinition` is required. **Available Version:** 67.0 * `retrieverQueryTemplateDefinition` (_object_, required) SQL query template definition including query template, parameters, citation definition, and enriched index definition. **Available Version:** 67.0 Includes all fields of `MlRetrieverQueryTemplateDefinitionInputRepresentation`. ### MlRetrieverConfigurationEnsembleInputRepresentation Ml Retriever Configuration Ensemble Input Represents the input for an Ensemble retriever configuration that fans out to multiple sub-retrievers and combines the results after reranking. Includes all fields of `MlRetrieverConfigurationBaseInputRepresentation`. * `outputFields` (_array of string_) List of output field labels (display names) to project from the ensemble results. These must match field labels defined in the active configuration of the referenced sub-retrievers. If unspecified, the default value is the union of output field labels from the referenced retrievers' active configurations. **Available Version:** 67.0 * `referencedRetrievers` (_array of CdpAssetReferenceInputRepresentation_, required) List of sub-retrievers to fan out to. Each entry is a reference (ID or API name) pointing to an existing NoCode retriever. **Available Version:** 67.0 ### MlRetrieverConfigurationNoCodeInputRepresentation Ml Retriever Configuration No Code Input Represents the input for a NoCode retriever configuration that retrieves data from a search index. The SQL query template is internally generated. Includes all fields of `MlRetrieverConfigurationBaseInputRepresentation`. * `citationConfiguration` (_object_) Citation configuration. Applies only to `NoCode`. **Available Version:** 67.0 Includes all fields of `MlRetrieverCitationConfigurationInputRepresentation`. * `input` (_object_, required) ID or API name of the search index that the retriever is associated with. Applies only to `NoCode`. **Available Version:** 67.0 Includes all fields of `MlRetrieverSourceInputRepresentation`. * `outputFields` (_array of MlRetrieverOutputFieldInputRepresentation_, required) List of data model object (DMO) fields to include in retriever results. **Available Version:** 67.0 * `queryFilter` (_object_) Pre-filter applied to available prefilter fields on the search index. **Available Version:** 67.0 Includes all fields of `CdpMlFilterInputRepresentation`. ### MlRetrieverFieldBaseInputRepresentation Ml Retriever Field Base Input Represents the input for a field reference. * `relatedDmoFieldName` (_string_) Name of the related data model object (DMO) field. **Available Version:** 61.0 * `relatedDmoName` (_string_) Name of the related DMO. **Available Version:** 61.0 ### MlRetrieverOutputFieldInputRepresentation Ml Retriever Output Field Input Represents the input for an output field for NoCode retrievers. Extends the base data model object (DMO) field reference with a display label, data source type, and optional join relationships. Includes all fields of `MlRetrieverFieldBaseInputRepresentation`. * `dataSourceType` (_string_) Type of data source. **Available Version:** 67.0 Allowed values: `DataModelObject`, `SearchFunction`. * `label` (_string_, required) Display label for the output field. Must be unique within the retriever. **Available Version:** 67.0 * `relationships` (_array of MlDmoFieldSourceTargetRelationshipInputRepresentation_) List of relationships forming a path from the DMO of this output field to the source DMO of the search index. The cardinality must be 1-to-1 or 1-to-many from this DMO to the source DMO. Maximum path length is 2. Empty when the field is on the source DMO itself. Applies only to `NoCode`. **Available Version:** 67.0 ### MlRetrieverQueryEnrichedSearchIndexDefinitionInputRepresentation Ml Retriever Query Enriched Search Index Definition Input Represents the input for an enriched search index definition to resolve enriched chunks to plain chunks. Required when `isEnrichedIndexSupported` is `true`. CustomSql only. * `chunkColumnName` (_string_, required) Name or alias of the SELECT column containing the chunk content. **Available Version:** 67.0 * `chunkRecordIdColumnName` (_string_, required) Name or alias of the SELECT column containing the chunk record ID. **Available Version:** 67.0 * `searchIndexApiName` (_string_, required) API name of the enriched search index. **Available Version:** 67.0 ### MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation Ml Retriever Query Template Citation Definition Base Input Represents the input for a query template citation definition. Discriminated by `citationType` (Default or Custom). Required when `isCitationSupported` is `true`. CustomSql only. * `citationType` (_string_, required) Type of citation. **Available Version:** 67.0 Allowed values: `Custom`, `Default`. * `customLabelColumnName` (_string_) Name or alias of the SELECT column used as the citation label. Required when `citationType` is `Custom`. **Available Version:** 67.0 ### MlRetrieverQueryTemplateCitationDefinitionCustomInputRepresentation Ml Retriever Query Template Citation Definition Custom Input Represents the input for a custom citation definition where label and link are defined by user-specified SQL columns. CustomSql only. Includes all fields of `MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation`. * `customBaseUrl` (_string_) Base URL that the `customLinkColumnName` value is appended to. For example, if `customBaseUrl` is "[https://example.com](https://example.com)" and the column contains "/docs/article-123", the resulting URL is "[https://example.com/docs/article-123](https://example.com/docs/article-123)". **Available Version:** 67.0 * `customLinkColumnName` (_string_, required) Name or alias of the SELECT column used as the citation link. When `customBaseUrl` is provided, this field's value is appended to it to construct the complete URL. **Available Version:** 67.0 ### MlRetrieverQueryTemplateCitationDefinitionDefaultInputRepresentation Ml Retriever Query Template Citation Definition Default Input Represents the input for a Default citation definition where citation links are generated from source and chunk record IDs in SQL columns. CustomSql only. Includes all fields of `MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation`. * `chunkObjectApiName` (_string_) API name of the chunk data model object (DMO) from a search index whose source DMO matches `sourceObjectApiName`. Applies only when the search index is not real time; ignored otherwise. When set, enables harmonized viewer and multimodal citations. **Available Version:** 67.0 * `chunkRecordIdColumnName` (_string_) Name or alias of the SELECT column used as the chunk record ID. Required when the search index for `chunkObjectApiName` is not real-time; must NOT be set when that index is real-time (JIT). **Available Version:** 67.0 * `sourceObjectApiName` (_string_, required) API name of the source DMO whose records are cited. Must be a DMO (DLOs and calculated insights must use custom citation). **Available Version:** 67.0 * `sourceRecordIdColumnName` (_string_, required) Name or alias of the SELECT column used as the source record ID. **Available Version:** 67.0 ### MlRetrieverQueryTemplateDefinitionInputRepresentation Ml Retriever Query Template Definition Input Represents the input for a SQL query template definition. CustomSql only. * `enrichedSearchIndexDefinition` (_object_) Enriched search index definition to resolve enriched chunks to plain chunks. Required when `isEnrichedIndexSupported` is `true`. **Available Version:** 67.0 Includes all fields of `MlRetrieverQueryEnrichedSearchIndexDefinitionInputRepresentation`. * `mainUserQueryParameterName` (_string_) Name of the parameter carrying the user query text in the format `":\"parameter\""`. Must match a parameter in `queryTemplatePlaceholders`. Recommended to help monitor the quality of search results from `vector_search()` or `hybrid_search()` functions. Required when `isAdvancedModeSupported` or `isEnrichedIndexSupported` is `true`. **Available Version:** 67.0 * `queryCitationDefinition` (_MlRetrieverQueryTemplateCitationDefinitionCustomInputRepresentation | MlRetrieverQueryTemplateCitationDefinitionDefaultInputRepresentation_) Citation definition (Default or Custom). Required when `isCitationSupported` is `true`. Use the citation definition input object that corresponds to the type of citation. For example, use the Ml Retriever Query Template Citation Definition Custom Input for custom citation types. **Available Version:** 67.0 One of: `MlRetrieverQueryTemplateCitationDefinitionCustomInputRepresentation`, `MlRetrieverQueryTemplateCitationDefinitionDefaultInputRepresentation`. * `queryTemplatePlaceholders` (_array of MlRetrieverQueryTemplatePlaceholderInputRepresentation_) List of parameters used in the SQL query template. Each parameter specifies name, data type, placeholder type, optional default value, label, and description. **Available Version:** 67.0 * `retrieverQueryTemplate` (_string_, required) Data 360 SQL query template. Can contain parameters in the format `:"parameter"`. **Available Version:** 67.0 * `searchOverallScoreColumnName` (_string_) Name or alias of the SELECT column containing the overall search relevance score from `vector_search()` or `hybrid_search()` functions. Recommended to help monitor the quality of search results. **Available Version:** 67.0 ### MlRetrieverQueryTemplatePlaceholderInputRepresentation Ml Retriever Query Template Placeholder Input Represents the input for a query template parameter or placeholder in the format `":\"parameter\""`. CustomSql only. * `placeholderDataType` (_string_, required) Data type of the parameter value. **Available Version:** 67.0 Allowed values: `ArrayOfText`, `Boolean`, `Date`, `DateTime`, `Number`, `Text`. * `placeholderDescription` (_string_) Description of the parameter purpose. Required for `CustomSql`. Not applicable to `NoCode`. **Available Version:** 67.0 * `placeholderLabel` (_string_) Display label for the parameter. **Available Version:** 67.0 * `placeholderName` (_string_, required) Name of the parameter in the format `":\"parameter\""`. Must be unique in the SQL query template. Must be a valid developer name (begin with a letter, contain only alphanumeric characters and underscores, no spaces, and cannot end with or contain consecutive underscores). **Available Version:** 67.0 * `placeholderValue` (_string_) Default value for the parameter. **Available Version:** 67.0 ### MlSentimentDetectionJobDefInputRepresentation Ml Sentiment Detection Job Def Input Represents the input for creating a sentiment detection prediction job definition. Includes all fields of `MlPredictionJobDefBaseInputRepresentation`. * `inputConfig` (_object_) Input configuration for sentiment detection. **Available Version:** 66.0 Includes all fields of `MlSentimentDetectionInputConfigInputRepresentation`. ### MlSentimentDetectionInputConfigInputRepresentation Ml Sentiment Detection Input Config Input Represents the input configuration for a sentiment detection prediction job definition. * `dataObject` (_object_) Input data model object (DMO). **Available Version:** 66.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `textFields` (_array of MlPredictionJobDefInputFieldInputRepresentation_) List of text fields to perform sentiment detection on. **Available Version:** 66.0 ### MlSentimentDetectionInputConfigRepresentation Ml Sentiment Detection Input Config Output Represents the input configuration for a sentiment detection prediction job definition. * `dataObject` (_object_) Input data model object (DMO). **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `textFields` (_array of MlPredictionJobDefInputFieldRepresentation_) List of text fields to perform sentiment detection on. **Filter Group:** Small **Available Version:** 66.0 ### MlSentimentDetectionJobDefRepresentation Ml Sentiment Detection Job Def Output Represents a sentiment detection prediction job definition. Includes all fields of `MlPredictionJobDefBaseRepresentation`. * `inputConfig` (_object_) Input configuration for sentiment detection. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlSentimentDetectionInputConfigRepresentation`. ### MlTopicClassificationInputConfigInputRepresentation Ml Topic Classification Input Config Input Represents the input configuration for a topic classification prediction job definition. * `dataObject` (_object_) Input data model object (DMO). **Available Version:** 66.0 Includes all fields of `CdpAssetReferenceInputRepresentation`. * `textFields` (_array of MlPredictionJobDefInputFieldInputRepresentation_) List of text fields to perform topic classification on. **Available Version:** 66.0 * `topicLabels` (_object_) Topic labels for classifying the text fields. **Available Version:** 66.0 Includes all fields of `MlTopicClassificationJobStaticLabelsInputRepresentation`. ### MlTopicClassificationInputConfigRepresentation Ml Topic Classification Input Config Output Represents the input configuration for a topic classification prediction job definition. * `dataObject` (_object_) Input data model object (DMO). **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `CdpAssetReferenceRepresentation`. * `textFields` (_array of MlPredictionJobDefInputFieldRepresentation_) List of text fields to perform topic classification on. **Filter Group:** Small **Available Version:** 66.0 * `topicLabels` (_object_) Topic labels for classifying the text fields. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlTopicClassificationJobLabelsBaseRepresentation`. ### MlTopicClassificationJobDefInputRepresentation Ml Topic Classification Job Def Input Represents the input for creating a topic classification prediction job definition. Includes all fields of `MlPredictionJobDefBaseInputRepresentation`. * `inputConfig` (_object_) Input configuration for topic classification. **Available Version:** 66.0 Includes all fields of `MlTopicClassificationInputConfigInputRepresentation`. ### MlTopicClassificationJobDefRepresentation Ml Topic Classification Job Def Output Represents a topic classification prediction job definition. Includes all fields of `MlPredictionJobDefBaseRepresentation`. * `inputConfig` (_object_) Input configuration for topic classification. **Filter Group:** Small **Available Version:** 66.0 Includes all fields of `MlTopicClassificationInputConfigRepresentation`. ### MlTopicClassificationJobLabelsBaseInputRepresentation Ml Topic Classification Job Labels Base Input Represents the base input for topic classification labels. * `type` (_string_) Type of labels mapping. **Available Version:** 66.0 Allowed values: `Static`. ### MlTopicClassificationJobStaticLabelsInputRepresentation Ml Topic Classification Job Static Labels Input Represents the base class for topic classification labels. Includes all fields of `MlTopicClassificationJobLabelsBaseInputRepresentation`. * `values` (_array of string_) Static list of topic labels to be used for classification. **Available Version:** 66.0 ### MlTopicClassificationJobLabelsBaseRepresentation Ml Topic Classification Job Labels Base Output Represents the base configuration for topic classification labels. * `type` (_string_) Type of labels mapping. **Filter Group:** Small **Available Version:** 66.0 Allowed values: `Dynamic`, `Static`. ### NameLabelInputRepresentation Name Label Input Represents the input for specifying a name and label. * `label` (_string_, required) Label. **Available Version:** 60.0 * `name` (_string_, required) Name. **Available Version:** 60.0 ### NameLabelRepresentation Name Label Output Name label representation. * `label` (_string_) Label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name. **Filter Group:** Small **Available Version:** 60.0 ### OtherDataShareTargetInputRepresentation Other Data Share Target Input Represents the input for creating a data share target for external systems. Includes all fields of `DataShareTargetInputRepresentation`. * `isPublicKeyProvided` (_boolean_) Indicates whether the public key is provided directly (`true`) or not (`false`). If `true`, the `publicKey` field is used for authentication. If `false`, the issuer URL hosts the public key. **Available Version:** 63.0 * `issuer` (_string_) External system issuer URL. **Available Version:** 63.0 * `publicKey` (_string_) Public key value. Required when `isPublicKeyProvided` is `true`. **Available Version:** 63.0 * `serviceAccountId` (_string_) Service account ID created as part of connection creation in the external system. **Available Version:** 63.0 ### OtherDataShareTargetRepresentation Other Data Share Target Output Represents a data share target for external systems. Includes all fields of `DataShareTargetRepresentation`. * `isPublicKeyProvided` (_boolean_) Indicates whether the public key is provided directly (`true`) or not (`false`). If `true`, the `publicKey` field is used for authentication. If `false`, the issuer URL hosts the public key. **Filter Group:** Small **Available Version:** 63.0 * `issuer` (_string_) External system issuer URL. **Filter Group:** Small **Available Version:** 63.0 * `publicKey` (_string_) Public key value. Required when `isPublicKeyProvided` is `true`. **Filter Group:** Small **Available Version:** 63.0 * `serviceAccountId` (_string_) Service account ID for the external system. **Filter Group:** Small **Available Version:** 63.0 ### OutputD360FieldsMappingInputRepresentation Output D360 Fields Mapping Input Represents D360 output node field mapping. * `sourceField` (_string_, required) Source field name. **Available Version:** 60.0 * `targetField` (_string_, required) Target field name. **Available Version:** 60.0 ### OutputD360FieldsMappingRepresentation Output D360 Fields Mapping Represents a D360 output node field mapping. * `sourceField` (_string_) Source field name. **Filter Group:** Small **Available Version:** 60.0 * `targetField` (_string_) Target field name. **Filter Group:** Small **Available Version:** 60.0 ### OutputD360NodeInputRepresentation Output D360 Node Input Represents D360 output node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `OutputD360ParametersInputRepresentation`. ### OutputD360NodeRepresentation Output D360 Node Represents a D360 output node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `OutputD360ParametersRepresentation`. ### OutputD360ParametersInputRepresentation Output D360 Parameters Input Represents D360 output node parameters. * `fieldsMappings` (_array of OutputD360FieldsMappingInputRepresentation_, required) Field mappings. **Available Version:** 60.0 * `name` (_string_, required) D360 object name. **Available Version:** 60.0 * `type` (_string_, required) Output type. **Available Version:** 60.0 Allowed values: `DataLakeObject`, `DataModelObject`. ### OutputD360ParametersRepresentation Output D360 Parameters Represents D360 output node parameters. * `dedupOrder` (_array of SortSpecificationRepresentation_) Order for eliminating duplicate primary keys in output nodes. **Filter Group:** Small **Available Version:** 60.0 * `fieldsMappings` (_array of OutputD360FieldsMappingRepresentation_) List of field mappings. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the D360 object. **Filter Group:** Small **Available Version:** 60.0 * `streaming` (_object_) List of streaming parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `StreamingParametersRepresentation`. * `type` (_string_) Type of output. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `DataLakeObject`, `DataModelObject`. * `writeMode` (_string_) Type of write mode. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Append`, `DeleteOnly`, `Merge`, `MergeUpsertDelete`, `Overwrite`. ### PivotV2InputRepresentation Pivot V2 Input Pivot v2 input representation. * `pivotFieldsInfo` (_object_, required) Pivot fields info. **Available Version:** 60.0 Includes all fields of `NameLabelInputRepresentation`. Additional properties: `array of object`. * `sourceFields` (_array of string_, required) Source fields. **Available Version:** 60.0 * `valueCombinations` (_array of array of string_, required) Value combinations. **Available Version:** 60.0 ### PivotV2Representation Pivot V2 Output Pivot v2 representation. * `pivotFieldsInfo` (_array of NameLabelRepresentation_) Pivot fields info. **Filter Group:** Small **Available Version:** 60.0 * `sourceFields` (_array of string_) List of source fields. **Filter Group:** Small **Available Version:** 60.0 * `valueCombinations` (_array of array of string_) Value combinations. **Filter Group:** Small **Available Version:** 60.0 ### PredictionContributorInputRepresentation Prediction Contributor Input Represents the input for a prediction contributor. * `field` (_object_) Prediction field. **Available Version:** 60.0 Includes all fields of `PredictionFieldInputRepresentation`. * `impact` (_object_) Prediction impact. **Available Version:** 60.0 Includes all fields of `PredictionFieldInputRepresentation`. * `value` (_object_) Prediction value. **Available Version:** 60.0 Includes all fields of `PredictionFieldInputRepresentation`. ### PredictionContributorRepresentation Prediction Contributor Output Represents a prediction contributor. * `field` (_object_) Contributor field. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `PredictionFieldRepresentation`. * `impact` (_object_) Contributor impact. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `PredictionFieldRepresentation`. * `value` (_object_) Contributor value. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `PredictionFieldRepresentation`. ### PredictionFieldInputRepresentation Prediction Field Input Represents the input for a prediction field. * `label` (_string_) Label of the prediction field. **Available Version:** 60.0 * `modelOutputFieldName` (_string_) Name of the prediction model output field. **Available Version:** 60.0 * `name` (_string_) Name of the prediction field. **Available Version:** 60.0 * `type` (_string_) Data type of the prediction field. **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### PredictionFieldRepresentation Prediction Field Output Represents a prediction field. * `label` (_string_) Label of the field. **Filter Group:** Small **Available Version:** 60.0 * `modelOutputFieldName` (_string_) Name of the model output field. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name of the field. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Data type of the field. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### PredictSourceInputRepresentation Predict Source Input Represents the input for a prediction source. * `name` (_string_) Name of the prediction source. **Available Version:** 60.0 * `type` (_string_) Type of the prediction source. **Available Version:** 60.0 Allowed values: `ConfiguredModel`, `MlModelGroup`. ### PredictSourceRepresentation Predict Source Output Represents a prediction source. * `name` (_string_) Name of the source. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Type of the source. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `ConfiguredModel`, `MlModelGroup`. ### SampleParametersInputRepresentation Sample Parameters Input Represents sample parameters for a load node. * `filters` (_object_, required) Sample filters. **Available Version:** 60.0 Includes all fields of `FilterParametersInputRepresentation`. * `sortBy` (_array of string_, required) Fields to sort sample on. **Available Version:** 60.0 * `sortDirection` (_string_, required) Sample sort direction. **Available Version:** 60.0 Allowed values: `Ascending`, `Descending`. * `type` (_string_, required) Sample type. **Available Version:** 60.0 Allowed values: `Custom`, `TopN`, `Unique`. * `uniqueSampleFieldName` (_string_, required) Field name for unique sample. **Available Version:** 60.0 ### SampleParametersRepresentation Sample Parameters Output Represents the sample parameters of a load node. * `filters` (_object_) Sample filters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `FilterParametersRepresentation`. * `sortBy` (_array of string_) Fields to sort sample on. **Filter Group:** Small **Available Version:** 60.0 * `sortDirection` (_string_) Sample sort direction. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Ascending`, `Descending`. * `type` (_string_) Sample type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Custom`, `TopN`, `Unique`. * `uniqueSampleFieldName` (_string_) Field name for unique sample. **Filter Group:** Small **Available Version:** 60.0 ### SchemaNodeInputRepresentation Schema Node Input Represents a schema node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `SchemaParametersInputRepresentation`. ### SchemaNodeRepresentation Schema Node Output Represents a schema node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SchemaParametersRepresentation`. ### SnowflakeDataShareTargetInputRepresentation Snowflake Data Share Target Input Represents the input for creating a Snowflake data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `accountUrl` (_string_) Snowflake account URL. **Available Version:** 63.0 * `subType` (_string_) Subtype of Snowflake data share target. **Available Version:** 63.0 Allowed values: `CleanRoom`. ### SnowflakeDataShareTargetRepresentation Snowflake Data Share Target Output Represents a Snowflake data share target. Includes all fields of `DataShareTargetRepresentation`. * `accountUrl` (_string_) Snowflake account URL. **Filter Group:** Small **Available Version:** 63.0 * `subType` (_string_) Subtype of Snowflake data share target. **Filter Group:** Small **Available Version:** 63.0 Allowed values: `CleanRoom`. ### SnowflakeOpenFlowDataShareTargetInputRepresentation Snowflake Open Flow Data Share Target Input Represents the input for creating a Snowflake Open Flow data share target. Includes all fields of `DataShareTargetInputRepresentation`. * `accountUrl` (_string_) Snowflake account URL. **Available Version:** 63.0 * `publicCert` (_string_) Public certificate created as part of connection creation in Snowflake. **Available Version:** 63.0 * `serviceAccountId` (_string_) Snowflake service account ID created as part of connection creation in Snowflake. **Available Version:** 63.0 ### SnowflakeOpenFlowDataShareTargetRepresentation Snowflake Open Flow Data Share Target Output Represents a Snowflake Open Flow data share target. Includes all fields of `DataShareTargetRepresentation`. * `accountUrl` (_string_) Snowflake account URL. **Filter Group:** Small **Available Version:** 63.0 * `publicCert` (_string_) Public certificate for the data share target. **Filter Group:** Small **Available Version:** 63.0 * `serviceAccountId` (_string_) Snowflake service account ID. **Filter Group:** Small **Available Version:** 63.0 ### SortSpecificationRepresentation Sort Specification Output Represents a parameter sort specification. * `direction` (_string_) Direction for the sort. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Ascending`, `Descending`. * `fieldName` (_string_) Field name. **Filter Group:** Small **Available Version:** 60.0 ### SplitNodeInputRepresentation Split Node Input Represents a split node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `SplitParametersInputRepresentation`. ### SplitNodeRepresentation Split Node Output Represents a split node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SplitParametersRepresentation`. ### SplitParametersInputRepresentation Split Parameters Input Represents a split node. * `delimiter` (_string_, required) Field delimiter. **Available Version:** 60.0 * `sourceField` (_string_, required) Source field. **Available Version:** 60.0 * `targetFields` (_array of NameLabelInputRepresentation_, required) Target fields. **Available Version:** 60.0 ### SplitParametersRepresentation Split Parameters Output Represents split node parameters. * `delimiter` (_string_) Delimiter of the split parameters. **Filter Group:** Small **Available Version:** 60.0 * `sourceField` (_string_) Source field. **Filter Group:** Small **Available Version:** 60.0 * `targetFields` (_array of NameLabelRepresentation_) List of target fields. **Filter Group:** Small **Available Version:** 60.0 ### SqlFilterNodeInputRepresentation SQL Filter Node Input Represents a SQL filter node in batch data transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `SqlFilterParametersInputRepresentation`. ### SqlFilterNodeRepresentation Sql Filter Node Output Represents a SQL filter node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `SqlFilterParametersRepresentation`. ### SqlFilterParametersInputRepresentation SQL Filter Parameters Input Represents a SQL filter expression. * `expressionType` (_string_) Type of filter expression. **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. * `sqlFilterExpression` (_string_, required) SQL filter expression. **Available Version:** 60.0 ### SqlFilterParametersRepresentation Sql Filter Parameters Output Represents SQL filter node parameters. * `expressionType` (_string_) Type of SQL filter expression. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Dcsql`, `Sql`. * `sqlFilterExpression` (_string_) SQL filter expression. **Filter Group:** Small **Available Version:** 60.0 ### SqlFormulaFieldInputRepresentation SQL Formula Field Input Represents a SQL formula field. * `formulaExpression` (_string_, required) Formula expression. **Available Version:** 60.0 * `label` (_string_, required) Label. **Available Version:** 60.0 * `name` (_string_, required) Name. **Available Version:** 60.0 * `type` (_string_, required) SQL formula type. **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### SqlFormulaFieldRepresentation SQL Formula Field Output SQL formula field representation. Discriminator: `type` selects the concrete type. * `defaultValue` (_string_) Default value. **Filter Group:** Small **Available Version:** 60.0 * `formulaExpression` (_string_) Formula expression. **Filter Group:** Small **Available Version:** 60.0 * `label` (_string_) Label. **Filter Group:** Small **Available Version:** 60.0 * `name` (_string_) Name. **Filter Group:** Small **Available Version:** 60.0 * `type` (_string_) Sql Formula type. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `DateOnly`, `DateTime`, `Number`, `Text`. ### StreamingAppConnectionInputRepresentation Streaming App Connection Input Input representation for a Streaming App connector. Includes all fields of `ConnectionInputRepresentation`. * `streamingAppSubType` (_string_) Subtype of the specified type of the Streaming App connector. Specify a subtype to create a connector of that subtype. Omit the subtype to create a connector of the specified type. **Available Version:** 64.0 Allowed values: `WebApp_GA4`. * `streamingAppType` (_string_, required) Connector type of the Streaming App connector. **Available Version:** 64.0 Allowed values: `MobileApp`, `ServerApp`, `WebApp`. ### StreamingAppConnectionPatchInputRepresentation Streaming App Connection Patch Input Input representation for a Streaming App connector for a patch request. Includes all fields of `ConnectionPatchInputRepresentation`. * `modules` (_array of ConnectionModuleConfigInputRepresentation_, required) List of Streaming App modules to be added. **Available Version:** 63.0 ### StreamingAppConnectionRepresentation Streaming App Connection Output Represents a Streaming App connector. Includes all fields of `ConnectionRepresentation`. * `modules` (_array of ConnectionModuleConfigRepresentation_) List of Steaming App modules. **Filter Group:** Small **Available Version:** 63.0 * `sourceId` (_string_) Source ID of the Streaming App connector. **Filter Group:** Small **Available Version:** 60.0 * `status` (_string_) Status of the Streaming App connector. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Connected`, `Disconnected`, `Failed`, `NeedsReAuth`. * `streamingAppSubType` (_string_) Subtype of the Streaming App connector. **Filter Group:** Small **Available Version:** 64.0 Allowed values: `WebApp_GA4`. * `streamingAppType` (_string_) Type of the Streaming App connector. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `MobileApp`, `ServerApp`, `WebApp`. * `tenantSpecificEndpoint` (_string_) Tenant-specific endpoint of the Streaming App connector. **Filter Group:** Small **Available Version:** 63.0 ### StreamingAppConnectionSchemaFieldInputRepresentation Streaming App Connection Schema Field Input Represents the input for Streaming App field types. Includes all fields of `ConnectionSchemaFieldInputRepresentation`. * `dataType` (_string_) Data type of the schema field. **Available Version:** 60.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. * `isDataRequired` (_boolean_) Indicates whether the field is mandatory (`true`) or not (`false`). **Available Version:** 60.0 * `primaryIndexOrder` (_integer_) Index that defines which event field is the primary key. **Available Version:** 60.0 ### StreamingAppConnectionSchemaFieldRepresentation Streaming App Connection Schema Field Output Represents a Streaming App connection schema field. Includes all fields of `ConnectionSchemaFieldRepresentation`. * `dataType` (_string_) Data type of the schema fields. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Boolean`, `Currency`, `Date`, `DateOnly`, `DateTime`, `Email`, `Number`, `Percent`, `Phone`, `Text`, `Url`. * `isDataRequired` (_boolean_) Indicates whether the field is mandatory (`true`) or not (`false`). **Filter Group:** Small **Available Version:** 60.0 * `primaryIndexOrder` (_integer_) Index that defines which event field is the primary key. **Filter Group:** Small **Available Version:** 60.0 ### StreamingAppConnectionSchemaInputRepresentation Streaming App Connection Schema Input Represents the input for a Streaming App schema. Includes all fields of `ConnectionSchemaInputRepresentation`. * `availabilityStatus` (_string_) Availability status of the event. **Available Version:** 60.0 Allowed values: `Available`, `InUse`. * `category` (_string_) Category of the event. **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `fields` (_array of StreamingAppConnectionSchemaFieldInputRepresentation_) List of schema fields. **Available Version:** 60.0 ### StreamingAppConnectionSchemaRepresentation Streaming App Connection Schema Output Represents a Streaming App connection schema. Includes all fields of `ConnectionSchemaRepresentation`. * `availabilityStatus` (_string_) Availability status of the event. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Available`, `InUse`. * `category` (_string_) Category of the event. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Engagement`, `Other`, `Profile`. * `fields` (_array of StreamingAppConnectionSchemaFieldRepresentation_) List of schema fields. **Filter Group:** Small **Available Version:** 60.0 ### StreamingParametersRepresentation Streaming Parameters Output Represents an output node's streaming parameters. * `outputMode` (_string_) Type of output mode. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Append`, `Complete`, `Update`. * `triggerIntervalSec` (_integer_) Trigger interval in seconds. **Filter Group:** Small **Available Version:** 60.0 * `triggerType` (_string_) Type of trigger. **Filter Group:** Small **Available Version:** 60.0 Allowed values: `Fixed`. ### TypecastNodeInputRepresentation Typecast Node Input Represents a typecast node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `TypecastParametersInputRepresentation`. ### TypeCastNodeRepresentation Type Cast Node Output Represents a typecast node. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `TypeCastParametersRepresentation`. ### TypecastParametersInputRepresentation Typecast Parameters Input Represents a typecast node. * `fields` (_array of SchemaFieldParametersInputRepresentation_, required) Fields to typecast. **Available Version:** 60.0 ### TypeCastParametersRepresentation Type Cast Parameters Output Represents parameters of a typecast node. * `fields` (_array of SchemaFieldRepresentation_) Fields to edit. **Filter Group:** Small **Available Version:** 60.0 ### UpdateNodeInputRepresentation Update Node Input Update node in Batch Data Transforms. Includes all fields of `DataTransformNodeInputRepresentation`. * `parameters` (_object_, required) Node-specific parameters. **Available Version:** 60.0 Includes all fields of `UpdateParametersInputRepresentation`. ### UpdateNodeRepresentation Update Node Output Update data node in batch data transforms. Includes all fields of `DataTransformNodeRepresentation`. * `parameters` (_object_) Node-specific parameters. **Filter Group:** Small **Available Version:** 60.0 Includes all fields of `UpdateParametersRepresentation`. ### UpdateParametersInputRepresentation Update Parameters Input Represents input for an update node. * `leftKeys` (_array of string_, required) Left keys. **Available Version:** 60.0 * `rightKeys` (_array of string_, required) Right keys. **Available Version:** 60.0 * `updateColumns` (_object_, required) Update columns. **Available Version:** 60.0 ### UpdateParametersRepresentation Update Parameters Output Represents update node output. * `leftKeys` (_array of string_) Left keys. **Filter Group:** Small **Available Version:** 60.0 * `rightKeys` (_array of string_) Right keys. **Filter Group:** Small **Available Version:** 60.0 * `updateColumns` (_object_) Update columns. **Filter Group:** Small **Available Version:** 60.0