diff --git a/curated/salesforce.json b/curated/salesforce.json new file mode 100644 index 00000000..a69048bc --- /dev/null +++ b/curated/salesforce.json @@ -0,0 +1,130 @@ +{ + "slug": "salesforce", + "name": "Salesforce", + "tagline": "CRM, Data 360, Agentforce, and platform APIs behind governed agent access.", + "description": "Salesforce exposes REST, GraphQL, CLI, hosted MCP, and Data 360 APIs. For agent-native work, the highest-value gap is making the Data 360 surfaces discoverable with clear credential recipes and safe execution policies.", + "domain": "salesforce.com", + "icon": "https://www.google.com/s2/favicons?domain=salesforce.com&sz=64", + "categories": [ + "crm", + "data-platform", + "ai-agents" + ], + "auth": { + "methods": [ + { + "type": "oauth2-client-credentials", + "label": "External Client App client credentials", + "note": "Use a Salesforce External Client App with Client Credentials enabled, least-privilege run-as user, and scopes api, cdp_api, and cdp_query_api." + }, + { + "type": "oauth2-token-exchange", + "label": "Data 360 instance token exchange", + "note": "Exchange a core org token at /services/a360/token for instance-host APIs such as Ingestion and Profile. ECA scopes for these surfaces include cdp_ingest_api and cdp_profile_api." + }, + { + "type": "oauth2-pkce", + "label": "Per-user OAuth", + "note": "Use per-user OAuth for human-scoped actions and Salesforce Hosted MCP servers where available." + } + ], + "guide": "For a governed org-plane agent, create an External Client App in Salesforce, enable Client Credentials Flow, grant scopes api, cdp_api, and cdp_query_api, and assign a least-privilege Data 360 integration user. Register Salesforce Data 360 Connect as an OpenAPI source in Executor, then register the ECA as a confidential OAuth client through Executor's browser handoff so the client secret never crosses chat or shell history.", + "sources": [ + { + "title": "Data 360 Connect REST API spec", + "url": "https://developer.salesforce.com/docs/data/connectapi/references/spec" + }, + { + "title": "Data 360 Ingestion API", + "url": "https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-ingestion-api.html" + }, + { + "title": "Data 360 Profile API", + "url": "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-call-overview.html" + }, + { + "title": "OAuth and Connect REST API", + "url": "https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_using_oauth.htm" + } + ], + "generatedAt": "2026-07-03", + "verified": false + }, + "interfaces": [ + { + "format": "openapi", + "name": "Data 360 Connect REST API", + "endpoint": "https://{my-domain}.my.salesforce.com/services/data/v{version}", + "specUrl": "/specs/salesforce-data-360-connect.yaml", + "auth": "oauth2-client-credentials", + "docs": "https://developer.salesforce.com/docs/data/connectapi/references", + "note": "The official docs endpoint can be awkward for server-side fetches; this workspace mirrors the spec for Executor registration and integrations.sh discovery.", + "origin": "vendor" + }, + { + "format": "openapi", + "name": "Data 360 Ingestion API", + "endpoint": "https://{tenant}.c360a.salesforce.com/api/v1/ingest", + "specUrl": "/specs/salesforce-data-360-ingestion.openapi.json", + "auth": "oauth2-token-exchange", + "docs": "https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-ingestion-api.html", + "note": "The instance host and bearer token come from the Salesforce /services/a360/token exchange. In this workspace, registration uses browser handoff until the trusted token bridge exists.", + "origin": "workspace-curated" + }, + { + "format": "openapi", + "name": "Data 360 Profile API", + "endpoint": "https://{tenant}.c360a.salesforce.com/api/v1/profile", + "specUrl": "/specs/salesforce-data-360-profile.openapi.json", + "auth": "oauth2-token-exchange", + "docs": "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-call-overview.html", + "note": "The instance host and bearer token come from the Salesforce /services/a360/token exchange. Profile calls are read/query oriented but still require Data 360 instance credentials.", + "origin": "workspace-curated" + }, + { + "format": "openapi", + "name": "Salesforce REST API", + "endpoint": "https://{my-domain}.my.salesforce.com/services/data/v{version}", + "auth": "oauth2", + "docs": "https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest", + "origin": "vendor" + }, + { + "format": "graphql", + "name": "Salesforce GraphQL API", + "endpoint": "https://{my-domain}.my.salesforce.com/services/data/v{version}/graphql", + "auth": "oauth2", + "docs": "https://developer.salesforce.com/docs/platform/graphql/overview", + "origin": "vendor" + }, + { + "format": "cli", + "name": "sf", + "install": "npm install -g @salesforce/cli && sf org login web", + "auth": "oauth", + "docs": "https://developer.salesforce.com/tools/salesforcecli", + "origin": "vendor" + }, + { + "format": "mcp", + "name": "Salesforce Hosted MCP servers", + "endpoint": "Salesforce-hosted MCP endpoints per org/user where enabled", + "auth": "oauth2-pkce", + "docs": "https://developer.salesforce.com", + "note": "Use the user-plane OAuth scope mcp_api when onboarding hosted MCP sources.", + "origin": "vendor" + } + ], + "links": { + "homepage": "https://salesforce.com", + "docs": "https://developer.salesforce.com/docs" + }, + "related": [ + "openapi/salesforce-data-360-connect", + "openapi/salesforce-data-360-ingestion", + "openapi/salesforce-data-360-profile", + "openapi/salesforce-com-openapi", + "graphql/salesforce-com-graphql", + "cli/salesforce-com-cli" + ] +} diff --git a/overrides/openapi/salesforce-data-360-connect.json b/overrides/openapi/salesforce-data-360-connect.json new file mode 100644 index 00000000..87cb83ab --- /dev/null +++ b/overrides/openapi/salesforce-data-360-connect.json @@ -0,0 +1,19 @@ +{ + "name": "Salesforce Data 360 Connect REST API", + "description": "Official Salesforce Data 360 Connect REST API. Covers metadata, streams, DMOs/DLOs, identity resolution, calculated insights, segments, activations, query, retrievers, data spaces, data actions, clean rooms, and related lifecycle APIs.", + "url": "https://developer.salesforce.com/docs/data/connectapi/references/spec", + "icon": "https://www.google.com/s2/favicons?domain=salesforce.com&sz=64", + "categories": [ + "crm", + "data-platform", + "ai-agents" + ], + "openapi": { + "provider": "salesforce.com", + "service": "data-360-connect", + "version": "67.0", + "specUrl": "/specs/salesforce-data-360-connect.yaml", + "docsUrl": "https://developer.salesforce.com/docs/data/connectapi/references", + "openapiVer": "3.0.0" + } +} diff --git a/overrides/openapi/salesforce-data-360-ingestion.json b/overrides/openapi/salesforce-data-360-ingestion.json new file mode 100644 index 00000000..994e197d --- /dev/null +++ b/overrides/openapi/salesforce-data-360-ingestion.json @@ -0,0 +1,19 @@ +{ + "name": "Salesforce Data 360 Ingestion API", + "description": "Instance-host Data 360 Ingestion API for streaming upsert/delete and bulk CSV job lifecycle. Requires the Data 360 instance token returned by /services/a360/token.", + "url": "https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-ingestion-api.html", + "icon": "https://www.google.com/s2/favicons?domain=salesforce.com&sz=64", + "categories": [ + "crm", + "data-platform", + "ai-agents" + ], + "openapi": { + "provider": "salesforce.com", + "service": "data-360-ingestion", + "version": "1.0.0", + "specUrl": "/specs/salesforce-data-360-ingestion.openapi.json", + "docsUrl": "https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-ingestion-api.html", + "openapiVer": "3.0.3" + } +} diff --git a/overrides/openapi/salesforce-data-360-profile.json b/overrides/openapi/salesforce-data-360-profile.json new file mode 100644 index 00000000..ecd20a66 --- /dev/null +++ b/overrides/openapi/salesforce-data-360-profile.json @@ -0,0 +1,19 @@ +{ + "name": "Salesforce Data 360 Profile API", + "description": "Instance-host Data 360 Profile API for profile metadata, record lookup, child data, and calculated insight reads. Requires the Data 360 instance token returned by /services/a360/token.", + "url": "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-call-overview.html", + "icon": "https://www.google.com/s2/favicons?domain=salesforce.com&sz=64", + "categories": [ + "crm", + "data-platform", + "ai-agents" + ], + "openapi": { + "provider": "salesforce.com", + "service": "data-360-profile", + "version": "1.0.0", + "specUrl": "/specs/salesforce-data-360-profile.openapi.json", + "docsUrl": "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-call-overview.html", + "openapiVer": "3.0.3" + } +} diff --git a/public/specs/salesforce-data-360-connect.yaml b/public/specs/salesforce-data-360-connect.yaml new file mode 100644 index 00000000..0ac48336 --- /dev/null +++ b/public/specs/salesforce-data-360-connect.yaml @@ -0,0 +1,63813 @@ +openapi: 3.0.0 +info: + title: Salesforce Data 360 Connect REST API + version: "67.0" + description: | + >**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/atlas.en-us.c360a*api.meta/c360a*api/c360a_api_intro_cdpapis.htm). 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. +servers: + - url: https://{dne_cdpInstanceUrl}/services/data/v{version} + variables: + dne_cdpInstanceUrl: + default: None + description: | + 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" + description: Version of the Connect API. +paths: + /ssot/activation-targets: + get: + summary: Get activation targets + tags: + - Activation Targets + description: | + Get a list of activation targets with selected filters. + + **Available Version:** 60.0 + parameters: + - name: batchSize + in: query + description: | + Number of results to return. Values are from `1` through `200`. If unspecified, the default value is `20`. + + **Available Version:** 60.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + Sort order for the result set by `createdDate`. If unspecified, items are returned by ID in ascending order. + + **Available Version:** 60.0 + schema: + type: string + - name: filters + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-activation-targets-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + post: + summary: Create activation target + tags: + - Activation Targets + description: | + 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) + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetInputRepresentation" + examples: + Amazon S3 connector request: + $ref: "#/components/examples/Amazon-S3-connector-request-example" + Marketing Cloud connector request: + $ref: "#/components/examples/Marketing-Cloud-connector-request-example" + File-based connectors request: + $ref: "#/components/examples/File-based-connectors-(Azure-GCS-SFTP)-request-example" + Data Cloud activation target request: + $ref: "#/components/examples/Data-Cloud-activation-target-request-example" + Ecosystem external platform request: + $ref: "#/components/examples/Ecosystem-external-platform-request-example" + Strategic partner request: + $ref: "#/components/examples/strategic-partner-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetRepresentation" + examples: + Amazon S3 connector response: + $ref: "#/components/examples/Amazon-S3-connector-response-example" + Marketing Cloud connector response: + $ref: "#/components/examples/Marketing-Cloud-connector-response-example" + File-based connectors response: + $ref: "#/components/examples/File-based-connectors-(Azure-GCS-SFTP)-response-example" + Data Cloud activation target response: + $ref: "#/components/examples/Data-Cloud-activation-target-response-example" + Ecosystem external platform response: + $ref: "#/components/examples/Ecosystem-external-platform-response-example" + Strategic partner response: + $ref: "#/components/examples/strategic-partner-response-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + /ssot/activation-targets/{activationTargetId}: + get: + summary: Get activation target + tags: + - Activation Targets + description: | + Get an activation target by ID or developer name. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetRepresentation" + examples: + Amazon S3 connector response: + $ref: "#/components/examples/Amazon-S3-connector-response-example" + Marketing Cloud connector response: + $ref: "#/components/examples/Marketing-Cloud-connector-response-example" + File-based connectors response: + $ref: "#/components/examples/File-based-connectors-(Azure-GCS-SFTP)-response-example" + Data Cloud activation target response: + $ref: "#/components/examples/Data-Cloud-activation-target-response-example" + Ecosystem external platform response: + $ref: "#/components/examples/Ecosystem-external-platform-response-example" + Strategic partner response: + $ref: "#/components/examples/strategic-partner-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + patch: + summary: Update activation target + tags: + - Activation Targets + description: | + Update a specific activation target by ID or developer name. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-activation-target-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationTargetRepresentation" + examples: + Amazon S3 connector response: + $ref: "#/components/examples/Amazon-S3-connector-response-example" + Marketing Cloud connector response: + $ref: "#/components/examples/Marketing-Cloud-connector-response-example" + File-based connectors response: + $ref: "#/components/examples/File-based-connectors-(Azure-GCS-SFTP)-response-example" + Data Cloud activation target response: + $ref: "#/components/examples/Data-Cloud-activation-target-response-example" + Ecosystem external platform response: + $ref: "#/components/examples/Ecosystem-external-platform-response-example" + Strategic partner response: + $ref: "#/components/examples/strategic-partner-response-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + parameters: + - name: activationTargetId + in: path + required: true + schema: + type: string + description: | + Unique identifier of a specific activation target, such as the ID or developer name. + + **Available Version:** 60.0 + /ssot/activations: + get: + summary: Get activations + tags: + - Activations + description: | + Get a list of activations with selected filters. + + **Available Version:** 60.0 + parameters: + - name: batchSize + in: query + description: | + Number of results to return. Values are from `1` through `200`. If unspecified, the default value is `20`. + + **Available Version:** 60.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + Sort order for the result set by `createdDate`. If unspecified, items are returned by ID in ascending order. + + **Available Version:** 60.0 + schema: + type: string + - name: filters + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-activations-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + post: + summary: Create activation + tags: + - Activations + description: | + Create an activation. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationDefinitionInputRepresentation" + examples: + S3 activation request: + $ref: "#/components/examples/create-S3-activation-request-example" + External platform activation request: + $ref: "#/components/examples/create-strategic-partner-activation-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationRepresentation" + examples: + S3 activation response: + $ref: "#/components/examples/create-s3-activation-response-example" + External platform activation response: + $ref: "#/components/examples/create-strategic-partner-activation-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + /ssot/activations/{activationId}: + delete: + summary: Delete activation + tags: + - Activations + description: | + 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 + responses: + "200": + description: Success + get: + summary: Get activation + tags: + - Activations + description: | + Get an activation by ID. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationRepresentation" + examples: + S3 activation response: + $ref: "#/components/examples/activation-response-example" + External platform activation response: + $ref: "#/components/examples/external-platform-activation-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + put: + summary: Update activation + tags: + - Activations + description: | + Update a specific activation by ID. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationDefinitionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-activation-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationRepresentation" + examples: + Example: + $ref: "#/components/examples/activation-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + parameters: + - name: activationId + in: path + required: true + schema: + type: string + description: | + Unique identifier of a specific activation, such as the ID or developer name. + + **Available Version:** 60.0 + /ssot/activations/{activationId}/actions/publish: + post: + summary: Publish a Batch DMO activation + tags: + - Activations + description: | + Initiate an on-demand publish job for a Batch data model object (DMO) activation. + + **Available Version:** 66.0 + parameters: + - name: activationId + in: path + schema: + type: string + description: | + Unique identifier of a specific activation, such as the market segment activation ID or developer name. + + **Available Version:** 66.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationPublishActionInputRepresentation" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ActivationPublishActionRepresentation' + examples: + Example: + $ref: "#/components/examples/publish-activation-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + /ssot/activations/{activationId}/data: + get: + summary: Get Audience DMO activation records + tags: + - Activations + description: | + Query activation data. Get a list of all activation records from Audience data model objects (DMOs). + + **Available Version:** 61.0 + parameters: + - name: X-Chatter-Entity-Encoding + in: header + required: true + description: Required. Value must be `false`. + schema: + type: string + - name: batchSize + in: query + description: | + Number of results to return. Values are from `1` through `4999`. If unspecified, the default value is `10000`. + + **Available Version:** 61.0 + schema: + type: integer + - name: filters + in: query + description: | + 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 + schema: + type: string + - name: offset + in: query + description: | + 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 + schema: + type: integer + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/AudienceDMOCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-audience-dmo-response-example" + "400": + description: The server could not process the request as the parameters or payload are incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested resource. Verify the URL is correct. + parameters: + - name: activationId + in: path + required: true + schema: + type: string + description: | + Unique identifier of a specific activation, such as the ID or developer name. + + **Available Version:** 61.0 + /ssot/activation-external-platforms: + get: + summary: Get activation external platforms + tags: + - Activations + description: | + Get a paginated list of activation external platforms. + + **Available Version:** 64.0 + parameters: + - in: query + name: batchSize + schema: + type: integer + description: | + Number of external platforms to return. Values are from `1` through `20`. If unspecified, the default value is `20`. + + **Available Version:** 64.0 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of external platforms to return. If unspecified, the default value is `20`. + + **Available Version:** 64.0 + - name: offset + in: query + schema: + type: integer + description: | + 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 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ActivationExternalPlatformCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-activation-external-platforms-output-example" + /ssot/calculated-insights: + get: + summary: Get calculated insights + tags: + - Calculated Insights + description: | + Get calculated insights in Data 360. + + **Available Version:** 57.0 + parameters: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `200`. If unspecified, the default value is `25`. + + **Available Version:** 57.0 + schema: + type: integer + - name: dataspace + in: query + description: | + Name of the data space. + + **Available Version:** 57.0 + schema: + type: string + - name: definitionType + in: query + description: | + Definition type of the calculated insight. Values are: + - `CALCULATED_METRIC` + - `EXTERNAL_METRIC` + - `STREAMING_METRIC` + + **Available Version:** 57.0 + schema: + type: string + - name: offset + in: query + required: true + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 57.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: pageToken + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-calculated-insights-output-example" + "400": + description: Illegal character in query at index *index number*. + post: + summary: Create calculated insights + tags: + - Calculated Insights + description: | + Create a calculated insight in Data 360. + + **Available Version:** 57.0 + + **Root XML tag:** `` + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-calculated-insight-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightRepresentation" + examples: + Example: + $ref: "#/components/examples/create-calculated-insight-output-example" + "400": + description: | + 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*. + /ssot/calculated-insights/{apiName}: + delete: + summary: Delete calculated insight + tags: + - Calculated Insights + description: | + Delete a calculated insight in Data 360. + + **Available Version:** 57.0 + responses: + "204": + description: Success + "400": + description: | + - Calculated insight API name must end in __cio. + - Could not retrieve calculated insight with developer name, *apiName*. + get: + summary: Get calculated insight + tags: + - Calculated Insights + description: | + Get a calculated insight in Data 360. + + **Available Version:** 57.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightRepresentation" + examples: + Example: + $ref: "#/components/examples/get-calculated-insight-output-example" + "400": + description: Calculated insight API name must end in __cio. + "404": + description: Calculated insight record not found. + patch: + summary: Update calculated insight + tags: + - Calculated Insights + description: | + Update a calculated insight in Data 360. + + **Available Version:** 57.0 + + **Root XML tag:** `` + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-calculated-insight-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightRepresentation" + examples: + Example: + $ref: "#/components/examples/update-calculated-insight-output-example" + "400": + description: | + Invalid input or entity save error. + + For example: + - Cannot change the calculated insight developer name when status is ACTIVE. + parameters: + - name: apiName + in: path + required: true + schema: + type: string + description: | + API name of the calculated insight with suffix `__cio`. + + **Available Version:** 57.0 + /ssot/calculated-insights/{apiName}/actions/run: + post: + summary: Run calculated insight + tags: + - Calculated Insights + description: | + 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 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpCalculatedInsightStandardActionResponseRepresentation" + "400": + description: Calculated insight API name must end in __cio. + "404": + description: Calculated insight record not found. + parameters: + - name: apiName + in: path + required: true + schema: + type: string + description: | + API name of the calculated insight with suffix `__cio`. + + **Available Version:** 57.0 + /ssot/connections: + get: + summary: Get connections + tags: + - Connections + description: | + Get a paginated list of Data 360 connections that exist in an org by connector type. + + **Available Version:** 60.0 + parameters: + - name: connectorType + in: query + required: true + description: | + Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. + + **Available Version:** 62.0 + schema: + type: string + - name: devName + in: query + description: | + Developer name of the connector. + + **Available Version:** 62.0 + schema: + type: string + - name: label + in: query + description: | + Label or public-facing name to filter on. + + **Available Version:** 62.0 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of connections to return. + + **Available Version:** 62.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + Sort connectors by field names. Supported field names are `label`, `createdDate`, and `lastModifiedDate`. + + **Available Version:** 62.0 + schema: + type: string + - name: organizationId + in: query + description: | + Organization ID to filter on. + + **Available Version:** 62.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCollectionRepresentation" + examples: + SalesforceMarketingCloud connection request: + $ref: "#/components/examples/get-salesforcemarketingcloud-connection-response-example" + SalesforceDotCom connection request: + $ref: "#/components/examples/get-salesforcedotcom-connections-response-example" + "401": + description: 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": + description: The server can't find the requested resource. + post: + summary: Create connection + tags: + - Connections + description: | + Create a Data 360 connector. + + **Available Version:** 64.0 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionInputRepresentation" + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionRepresentation" + "400": + description: 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": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}: + delete: + summary: Delete connection + tags: + - Connections + description: | + Delete a Data 360 connector. + + **Available Version:** 60.0 + responses: + "204": + description: Success + "401": + description: 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": + description: The server can't find the requested resource. + get: + summary: Get connection + tags: + - Connections + description: | + 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 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-connection-response-example" + "401": + description: 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": + description: The server can't find the requested resource. + patch: + summary: Update connection + tags: + - Connections + description: | + Update a Data 360 connector, replacing only the data passed in the request. + + **Available Version:** 63.0 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionPatchInputRepresentation" + examples: + SalesforceMarketingCloud connection request: + $ref: "#/components/examples/update-mc-connection-request" + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionRepresentation" + examples: + SalesforceMarketingCloud connection response: + $ref: "#/components/examples/update-mc-connection-response" + "400": + description: 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": + description: 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": + description: The server can't find the requested resource. + put: + summary: Replace connection + tags: + - Connections + description: | + Update a Data 360 connector, completely replacing all existing data for the connector with the data passed in the request. + + **Available Version:** 61.0 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionInputRepresentation" + responses: + "204": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionRepresentation" + "400": + description: 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": + description: 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": + description: The server can't find the requested resource. + parameters: + - name: connectionId + in: path + required: true + description: | + ID of the connection. + + **Available Version:** 62.0 + schema: + type: string + /ssot/connections/{connectionId}/database-schemas: + post: + summary: Get connection database schemas + tags: + - Connections + description: | + Get a list of database schema names for a connection. + + **Available Version:** 63.0 + parameters: + - name: connectionId + in: path + required: true + description: | + ID of the connection. + + **Available Version:** 62.0 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionDbSchemaCollectionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-database-schemas-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionDbSchemaCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-database-schemas-response" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/databases: + post: + summary: Get connection databases + tags: + - Connections + description: | + Get a list of databases for a connection. This `POST` endpoint doesn't accept a request body. + + **Available Version:** 63.0 + parameters: + - name: connectionId + in: path + required: true + description: | + ID of the connection. + + **Available Version:** 62.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionDatabaseCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-databases-response" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/endpoints: + get: + summary: Get connection endpoints + tags: + - Connections + description: | + 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 + responses: + "200": + description: Success + "401": + description: 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": + description: The server can't find the requested resource. + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + The ID for the connection. + + **Available Version:** 61.0 + /ssot/connections/{connectionId}/objects/{resourceName}/fields: + post: + summary: Get connection fields + tags: + - Connections + description: | + Get a list of fields for a connection object. + + **Available Version:** 62.0 + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 62.0 + - name: resourceName + in: path + required: true + schema: + type: string + description: | + - 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionFieldCollectionInputRepresentation" + examples: + Data extension source object request: + $ref: "#/components/examples/get-data-extension-connection-fields-request" + Standard Marketing Cloud bundle stream request: + $ref: "#/components/examples/get-bundle-stream-connection-fields-request" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionFieldCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-connection-fields-response" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/objects: + post: + summary: Get connection objects + tags: + - Connections + description: | + Get a list of source objects for a connection. + + **Available Version:** 62.0 + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 62.0 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionObjectCollectionInputRepresentation" + examples: + Data extension source object request: + $ref: "#/components/examples/get-data-extensions-connection-objects-request" + Standard Marketing Cloud bundle stream request: + $ref: "#/components/examples/get-bundle-streams-connection-objects-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionObjectCollectionRepresentation" + examples: + Connection object response: + $ref: "#/components/examples/get-connection-objects-response" + Data extension source object response: + $ref: "#/components/examples/get-data-extensions-connection-objects-response" + Standard Marketing Cloud bundle stream response: + $ref: "#/components/examples/get-bundle-streams-connection-objects-response" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/objects/{resourceName}/preview: + post: + summary: Get connection preview + tags: + - Connections + description: | + Get a preview of the data in an object and pass it through parser settings. + + **Available Version:** 62.0 + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 62.0 + - name: resourceName + in: path + required: true + schema: + type: string + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionPreviewInputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-preview-request" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionPreviewRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-preview-response" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/schema: + get: + summary: Get connection schema + tags: + - Connections + description: | + Get the schema model for a connection. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSchemaCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/connection-schema-output-example" + "401": + description: 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": + description: The server can't find the requested resource. + put: + summary: Upsert connection schema + tags: + - Connections + description: | + Create or update a schema model for a connection. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSchemaCollectionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/put-connection-schema-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSchemaCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/connection-schema-output-example" + "400": + description: 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": + description: 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": + description: The server can't find the requested resource. + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + The ID for the connection. + + **Available Version:** 60.0 + /ssot/connections/{connectionId}/sitemap: + get: + summary: Get connection site map + tags: + - Connections + description: | + Get the sitemap for a Streaming App connection. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSitemapRepresentation" + examples: + Example: + $ref: "#/components/examples/connection-sitemap-output-example" + "401": + description: 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": + description: The server can't find the requested resource. + put: + summary: Upsert connection site map + tags: + - Connections + description: | + Create or update the sitemap for a Streaming App connection. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSitemapInputRepresentation" + examples: + Example: + $ref: "#/components/examples/put-connection-sitemap-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSitemapRepresentation" + examples: + Example: + $ref: "#/components/examples/connection-sitemap-output-example" + "400": + description: 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": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + parameters: + - name: connectionId + in: path + required: true + schema: + type: string + description: | + The ID for the connection. + + **Available Version:** 60.0 + /ssot/connections/actions/test: + post: + summary: Test connection action + tags: + - Connections + description: | + Test a connection without creating it. + + **Available Version:** 62.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionTestInputRepresentation" + examples: + Example: + $ref: "#/components/examples/test-connection-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionTestActionRepresentation" + examples: + Example: + $ref: "#/components/examples/clean-success" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/actions/{command}: + post: + summary: Run connection action + tags: + - Connections + description: | + Run a command on a connection without creating the connection. + + **Available Version:** 64.0 + parameters: + - name: command + in: path + schema: + type: string + description: | + Name of the command to run, for example, `GET_SCHEMAS`. + + **Available Version:** 64.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCommandActionInputRepresentation" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCommandActionRepresentation" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/actions/test: + post: + summary: Test existing connection action + tags: + - Connections + description: | + Test an existing connection and update its status based on the test result. + + **Available Version:** 62.0 + parameters: + - name: connectionId + in: path + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 62.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionTestActionRepresentation" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/actions/{command}: + post: + summary: Run existing connection action + tags: + - Connections + description: | + Run a command on an existing connection. + + **Available Version:** 64.0 + parameters: + - name: command + in: path + schema: + type: string + description: | + Name of the command to run, for example, `GET_SCHEMAS`. + + **Available Version:** 64.0 + required: true + - name: connectionId + in: path + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 64.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCommandExistingActionInputRepresentation" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCommandActionRepresentation" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connections/{connectionId}/schema/actions/test: + post: + summary: Test existing connection schema action + tags: + - Connections + description: | + Test a schema for an existing connection. + + **Available Version:** 62.0 + parameters: + - name: connectionId + in: path + schema: + type: string + description: | + ID of the connection. + + **Available Version:** 62.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionSchemaActionResponseRepresentation" + "400": + description: The request could not be understood. + "401": + description: 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": + description: The server can't find the requested resource. + "422": + description: The request exceeded the maximum number of connections. + /ssot/connectors: + get: + summary: Get connectors + tags: + - Connections + - Connectors + description: | + Get a paginated list of Data 360 connectors, including high-level information and attributes for each connector. + + **Available Version:** 62.0 + parameters: + - name: fieldGroup + in: query + schema: + type: string + description: | + 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 + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectorInfoCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-connector-info-list-response" + "401": + description: 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": + description: The server can't find the requested resource. + /ssot/connectors/{connectorType}: + get: + summary: Get connector metadata + tags: + - Connections + - Connectors + - Metadata + description: | + Get metadata about a Data 360 connector. + + **Available Version:** 59.0 + parameters: + - name: connectorType + in: path + schema: + type: string + description: | + 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 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectorMetadataRepresentation" + examples: + Example: + $ref: "#/components/examples/get-connector-info-response" + "401": + description: 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": + description: The server can't find the requested resource. + /ssot/data-action-targets: + get: + summary: Get data action targets + tags: + - Data Action Targets + description: | + Get a paginated list of data action targets. + + **Available Version:** 58.0 + parameters: + - name: batchSize + in: query + description: | + Number of items returned. + + **Available Version:** 58.0 + schema: + type: integer + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 58.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionTargetCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-action-targets-response-example" + post: + summary: Create data action target + tags: + - Data Action Targets + description: | + Create a new data action target. + + **Available Version:** 58.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionTargetInputRepresentation" + examples: + Web hook data action target request: + $ref: "#/components/examples/create-webHook-data-action-target-request-example" + Core data action target request: + $ref: "#/components/examples/create-core-data-action-target-request-example" + Marketing Cloud data action target request: + $ref: "#/components/examples/create-mc-data-action-target-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionTargetOutputRepresentation" + examples: + Web hook data action target response: + $ref: "#/components/examples/webHook-data-action-target-response-example" + Core data action target response: + $ref: "#/components/examples/core-data-action-target-response-example" + /ssot/data-action-targets/{apiName}: + delete: + summary: Delete data action target + tags: + - Data Action Targets + description: | + Delete a data action target. + + **Available Version:** 58.0 + responses: + "200": + description: Success + get: + summary: Get data action target + tags: + - Data Action Targets + description: | + Get a data action target. + + **Available Version:** 58.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionTargetOutputRepresentation" + examples: + Web hook data action target response: + $ref: "#/components/examples/webHook-data-action-target-response-example" + Core data action target response: + $ref: "#/components/examples/core-data-action-target-response-example" + parameters: + - name: apiName + in: path + required: true + schema: + type: string + description: | + Developer name of the data action target. + + **Available Version:** 58.0 + /ssot/data-action-targets/{apiName}/signing-key: + post: + summary: Generate data action target signing key + tags: + - Data Action Targets + description: | + Generate the signing key for a data action target. + + **Available Version:** 62.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionTargetSigningKeyOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-signing-key-response-example" + parameters: + - name: apiName + in: path + required: true + schema: + type: string + description: | + Developer name of the data action target. + + **Available Version:** 62.0 + /ssot/data-actions: + get: + summary: Get data actions + tags: + - Data Actions + description: | + Get a paginated list of data actions in the org. + + **Available Version:** 58.0 + parameters: + - name: batchSize + in: query + description: | + Number of items returned. + + **Available Version:** 62.0 + schema: + type: integer + - name: dataspace + in: query + description: | + The Data 360 data space from which to return data actions. + + **Available Version:** 62.0 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 62.0 + schema: + type: integer + - name: orderby + in: query + description: | + Name of the field to order the results by. + + **Available Version:** 62.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-actions-response-example" + post: + summary: Create data action + tags: + - Data Actions + description: | + Create a new data action. + + **Available Version:** 58.0 + parameters: + - name: dataspace + in: query + schema: + type: string + description: | + The Data 360 data space fromm which to return the data action. + + **Available Version:** 62.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-action-request-example" + required: true + responses: + "201": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataActionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-action-response-example" + /ssot/data-clean-room/collaborations: + get: + summary: Get collaborations + tags: + - Clean Rooms + description: | + Get a list of clean room collaborations. + + **Available Version:** 63.0 + parameters: + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room collaborations to return from `1` through `20`. By default, `20` collaborations are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomCollaborationCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/collaborations-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + post: + summary: Create a collaboration + tags: + - Clean Rooms + description: | + Create a new clean room collaboration. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomCollaborationInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-collaboration-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomCollaborationRepresentation" + examples: + Example: + $ref: "#/components/examples/collaboration-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: | + Internal error. + + For example: + - Multiple records found for the given providerDevName, *providerDevName*. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/accept-invitation: + post: + summary: Accept a collaboration invitation + tags: + - Clean Rooms + description: | + Accept an invitation for a clean room collaboration. + + **Available Version:** 63.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 63.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomAcceptInvitationInputRepresentation" + examples: + Simple request: + $ref: "#/components/examples/accept-collaboration-invitation-input-example" + Snowflake connector request: + $ref: "#/components/examples/accept-collaboration-invitation-snowflake-input-example" + AWS S3 connector request: + $ref: "#/components/examples/accept-collaboration-invitation-aws-s3-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomMemberRepresentation" + examples: + Example: + $ref: "#/components/examples/accept-collaboration-invitation-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/disable: + post: + summary: Disable a collaboration + tags: + - Clean Rooms + description: | + Disable a clean room collaboration. + + **Available Version:** 66.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 66.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DataCleanRoomCollaborationRepresentation' + examples: + example1: + $ref: "#/components/examples/disable-collaboration-output-example" + "401": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/refresh-metadata: + put: + summary: Refresh collaboration metadata + tags: + - Clean Rooms + description: | + Refresh metadata for a clean room collaboration. + + **Available Version:** 66.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 66.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DataCleanRoomGenericResponseRepresentation' + examples: + example1: + $ref: "#/components/examples/clean-success" + "401": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/reject-invitation: + post: + summary: Reject a collaboration invitation + tags: + - Clean Rooms + description: | + Reject an invitation for a clean room collaboration. + + **Available Version:** 63.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 63.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomRejectInvitationInputRepresentation" + examples: + Example: + $ref: "#/components/examples/reject-collaboration-invitation-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomMemberRepresentation" + examples: + Example: + $ref: "#/components/examples/reject-collaboration-invitation-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/actions/run: + post: + summary: Run a query + tags: + - Clean Rooms + description: | + 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: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 63.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomQueryJobInputRepresentation" + examples: + AWS flow request: + $ref: "#/components/examples/run-AWS-flow-query-job-input-example" + Native flow request: + $ref: "#/components/examples/run-Native-flow-query-job-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomQueryJobRepresentation" + examples: + AWS flow response: + $ref: "#/components/examples/run-AWS-flow-query-job-output-example" + Native flow response: + $ref: "#/components/examples/run-Native-flow-query-job-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/jobs: + get: + summary: Get query jobs + tags: + - Clean Rooms + description: | + Get a list of clean room query jobs. + + **Available Version:** 63.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 63.0 + required: true + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room query jobs to return from `1` through `20`. By default, `20` query jobs are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomQueryJobCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/data-clean-room-query-jobs-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: | + Internal error. + + For example: + - Cannot invoke `cdp.api.datacleanroom.DataCleanRoom.getDataCleanRoomDefinition()` because `dataCleanRoom` is null. + /ssot/data-clean-room/collaborations/{collaborationIdOrApiName}/result-data-objects: + get: + summary: Get collaboration result objects + tags: + - Clean Rooms + description: | + Retrieve a list of all data model objects (DMOs) created by a specific clean room collaboration. + + **Available Version:** 66.0 + parameters: + - name: collaborationIdOrApiName + in: path + schema: + type: string + description: | + ID or developer name of the clean room collaboration. + + **Available Version:** 66.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DataCleanRoomCollaborationResultDataObjectCollectionRepresentation' + examples: + example1: + $ref: "#/components/examples/clean-room-result-data-objects-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/providers: + get: + summary: Get providers + tags: + - Clean Rooms + description: | + Get a list of clean room providers. + + **Available Version:** 63.0 + parameters: + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room providers to return from `1` through `20`. By default, `20` providers are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomProviderCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/providers-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + post: + summary: Create a provider + tags: + - Clean Rooms + description: | + Create a new clean room provider. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomProviderInputRepresentation" + examples: + AWS request: + $ref: "#/components/examples/AWS-provider-input-example" + Extensible request: + $ref: "#/components/examples/Extensible-provider-input-example" + Native request: + $ref: "#/components/examples/Native-provider-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomProviderRepresentation" + examples: + AWS response: + $ref: "#/components/examples/AWS-provider-output-example" + Extensible response: + $ref: "#/components/examples/Extensible-provider-output-example" + Native response: + $ref: "#/components/examples/Native-provider-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/providers/{providerIdOrName}: + get: + summary: Get a provider + tags: + - Clean Rooms + description: | + Get a clean room provider. + + **Available Version:** 63.0 + parameters: + - name: providerIdOrName + in: path + schema: + type: string + description: | + ID or developer name of the clean room provider. + + **Available Version:** 63.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomProviderRepresentation" + examples: + Example: + $ref: "#/components/examples/provider-output-example" + "400": + description: The server could not process the request as the params/payload was incorrect. + "401": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/providers/{providerIdOrName}/templates: + get: + summary: Get provider templates + tags: + - Clean Rooms + description: | + Get a list of all templates associated with a clean room provider. + + **Available Version:** 63.0 + parameters: + - name: providerIdOrName + in: path + schema: + type: string + description: | + ID or developer name of the clean room provider. + + **Available Version:** 63.0 + required: true + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room templates to return from `1` through `20`. By default, `20` templates are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomTemplateCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/templates-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/specifications: + get: + summary: Get specifications + tags: + - Clean Rooms + description: | + Get a list of all clean room specifications. + + **Available Version:** 63.0 + parameters: + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room specifications to return from `1` through `20`. By default, `20` specifications are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of records to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomSpecificationCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/specifications-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + post: + summary: Create a specification + tags: + - Clean Rooms + description: | + Create a new clean room specification. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomDataSpecificationInputRepresentation" + examples: + Example: + $ref: "#/components/examples/specification-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomDataSpecificationRepresentation" + examples: + Example: + $ref: "#/components/examples/specification-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/specifications/{specificationIdOrApiName}: + delete: + summary: Delete a specification + tags: + - Clean Rooms + description: | + Deletes a specific clean room specification. + + **Available Version:** 66.0 + parameters: + - name: specificationIdOrApiName + in: path + schema: + type: string + description: | + ID or API name of the clean room specification. + + **Available Version:** 66.0 + required: true + responses: + "200": + description: Success + "401": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/templates: + get: + summary: Get templates + tags: + - Clean Rooms + description: | + Get a list of all clean room templates. + + **Available Version:** 63.0 + parameters: + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room templates to return from `1` through `20`. By default, `20` templates are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of records to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataCleanRoomTemplateCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/templates-output-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/templates/{useCaseTemplateType}/collaborations: + get: + summary: Get template collaborations + tags: + - Clean Rooms + description: | + Retrieve a paginated list of all collaborations for a specific type of use case template. + + **Available Version:** 66.0 + parameters: + - name: useCaseTemplateType + in: path + schema: + type: string + description: | + Type of use case template. + + **Available Version:** 66.0 + required: true + - name: filters + in: query + schema: + type: string + description: | + 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 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of clean room templates to return from `1` through `20`. By default, `20` collaborations are returned. + + **Available Version:** 66.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of records to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 66.0 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DataCleanRoomCollaborationCollectionForUseCaseTypeRepresentation' + examples: + example1: + $ref: "#/components/examples/get-template-collaborations-response-example" + "400": + description: | + 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": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-clean-room/test-connection: + post: + summary: Test connection + tags: + - Clean Rooms + description: | + Test the connection between the clean room and the provider's external storage. + + **Available Version:** 66.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CleanroomTestConnectionInputRepresentation" + examples: + example1: + $ref: "#/components/examples/test-clean-room-connection-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CleanRoomTestConnectionRepresentation' + examples: + Success response: + $ref: "#/components/examples/test-clean-room-connection-success-output-example" + Failure response: + $ref: "#/components/examples/test-clean-room-connection-fail-output-example" + "401": + description: 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": + description: 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": + description: The server could not find the requested web page. Verify the URL is correct. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/data-graphs: + post: + summary: Create data graph + tags: + - Data Graphs + description: | + Create a data graph. + + **Available Version:** 59.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataGraphInputRepresentation" + examples: + example1: + $ref: "#/components/examples/create-data-graph-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataGraphOutputRepresentation" + /ssot/data-graphs/data/{dataGraphEntityName}: + get: + summary: Get data graph data by entity name + tags: + - Data Graphs + description: | + 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: + - name: dataGraphEntityName + in: path + required: true + schema: + type: string + description: | + API name of the data graph to query. + + **Available Version:** 59.0 + - name: dataspace + in: query + description: | + Name of the data space in which to query the data graph. By default, the endpoint queries the `default` dataspace. + + **Available Version:** 59.0 + schema: + type: string + - name: lookupKeys + in: query + required: true + description: | + 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 + schema: + type: string + - name: noCache + in: query + description: | + 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 + schema: + type: boolean + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-graph-by-lookup-output-example" + /ssot/data-graphs/data/{dataGraphEntityName}/{id}: + get: + summary: Get data graph data by ID + tags: + - Data Graphs + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space to query. If unspecified, the `default` data space is used. + + **Available Version:** 59.0 + schema: + type: string + - name: live + in: query + description: | + Indicates whether live lookup for the data graph is enabled (`true`) or not (`false`). + + **Available Version:** 63.0 + schema: + type: boolean + - name: id + in: path + required: true + schema: + type: string + description: | + 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 + - name: dataGraphEntityName + in: path + required: true + schema: + type: string + description: | + API name of the data graph to query. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-graph-by-id-output-example" + /ssot/data-graphs/metadata: + get: + summary: Get data graph metadata + tags: + - Data Graphs + - Metadata + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space to query. If unspecified, the `default` data space is used. + + **Available Version:** 59.0 + schema: + type: string + - name: dataGraphEntityName + in: query + description: | + API name of the data graph to query. If unspecified, metadata for all data graphs is returned. + + **Available Version:** 59.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDgMetadataRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-graph-metadata-output-example" + /ssot/data-graphs/{dataGraphName}: + delete: + summary: Delete data graph + tags: + - Data Graphs + description: | + Delete a data graph. + + **Available Version:** 59.0 + responses: + "200": + description: Success + get: + summary: Get data graph + tags: + - Data Graphs + description: | + Query a data graph. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataGraphOutputRepresentation" + parameters: + - name: dataGraphName + in: path + required: true + schema: + type: string + description: | + Name of the data graph. + + **Available Version:** 64.0 + /ssot/data-graphs/{dataGraphName}/actions/activate: + post: + summary: Activate data graph + tags: + - Data Graphs + description: | + 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: + - name: dataGraphName + in: path + schema: + type: string + description: | + Name of the data graph. + + **Available Version:** 67.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataGraphActivateInputRepresentation" + examples: + example1: + $ref: "#/components/examples/activate-data-graph-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CdpDataGraphActionResponseRepresentation' + examples: + example1: + $ref: "#/components/examples/clean-success" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/data-graphs/{dataGraphName}/actions/refresh: + post: + summary: Refresh data graph + tags: + - Data Graphs + description: | + Refresh a data graph. + + **Available Version:** 64.0 + parameters: + - name: dataGraphName + in: path + required: true + schema: + type: string + description: | + Name of the data graph. + + **Available Version:** 64.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataGraphActionResponseRepresentation" + examples: + Example: + $ref: "#/components/examples/clean-success" + /ssot/data-kits: + get: + summary: Get data kits + tags: + - Data Kits + description: | + Get a list of data kits by namespace. + + **Available Version:** 63.0 + parameters: + - name: namespace + in: query + schema: + type: string + description: | + Namespace prefix of the data kit package. + + **Available Version:** 63.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-kits-output" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + post: + summary: Create data kit + tags: + - Data Kits + description: | + Create a standard data kit. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-kit-input" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-kit-output" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/data-kits/available-components: + get: + summary: Get data kit available components + tags: + - Data Kits + description: | + Get a list of available components within data kits by component type. + + **Available Version:** 63.0 + parameters: + - name: componentType + in: query + schema: + type: string + description: | + Type of components to return. These values are supported: + - `DataStreamBundle` + - `CalculatedInsight` + - `DataLakeObject` + - `DataTransform` + - `EngagementSignal` + - `PersonalizationObjective` + - `PersonalizationRecommender` + - `PersonalizationPoint` + - `PersonalizationSchema` + + **Available Version:** 63.0 + - name: dataKitDevName + in: query + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of available components to return from `1` through `200`. By default, `200` components are returned. + + **Available Version:** 63.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of records to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 63.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitComponentCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-available-components-output" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/data-kits/{dataKitDevName}: + delete: + summary: Delete data kit + tags: + - Data Kits + description: | + Delete a data kit. + + **Available Version:** 64.0 + parameters: + - name: dataKitDevName + in: path + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + required: true + responses: + "200": + description: Success + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: | + PackageKitDefinition does not exist: *dataKitDevName* + patch: + summary: Update data kit components + tags: + - Data Kits + description: | + 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: + - name: dataKitDevName + in: path + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + required: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitPatchInputRepresentation" + examples: + example1: + $ref: "#/components/examples/update-data-kit-input" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitRepresentation" + examples: + Example: + $ref: "#/components/examples/update-data-kit-output" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + post: + summary: Deploy data kit components + tags: + - Data Kits + description: | + Deploy multiple components from a specific data kit. + + **Available Version:** 64.0 + + >**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. + parameters: + - name: dataKitDevName + in: path + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 64.0 + required: true + - name: asyncMode + in: query + schema: + type: boolean + description: | + Specifies asynchronous data kit deployment. Must be set to `true`; other values are not currently supported. + + **Available Version:** 64.0 + required: true + - name: dataspace + in: query + schema: + type: string + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataKitDeployInputRepresentation" + examples: + B2C commerce bundle request: + $ref: "#/components/examples/deploy-b2c-commerce-bundle-data-kit-input" + BYOL bundle request: + $ref: "#/components/examples/deploy-byol-bundle-data-kit-input" + Calculated insight request: + $ref: "#/components/examples/deploy-calculated-insight-data-kit-input" + Connector framework bundle request: + $ref: "#/components/examples/deploy-connector-framework-bundle-data-kit-input" + CRM bundle request: + $ref: "#/components/examples/deploy-crm-bundle-data-kit-input" + Data transform request: + $ref: "#/components/examples/deploy-batch-data-transform-data-kit-input" + DLO request: + $ref: "#/components/examples/deploy-dlo-data-kit-input" + Ingestion API bundle request: + $ref: "#/components/examples/deploy-ingestion-api-bundle-data-kit-input" + Streaming app bundle request: + $ref: "#/components/examples/deploy-streaming-app-bundle-data-kit-input" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitAsyncRepresentation" + examples: + Example: + $ref: "#/components/examples/data-kit-async-output-example" + "400": + description: Invalid data in the deployment request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/datakit/{dataKitDevName}/manifest: + get: + summary: Get data kit manifest + tags: + - Data Kits + description: | + Get a list of all member components and dependencies for a data kit. + + **Available Version:** 63.0 + parameters: + - name: dataKitDevName + in: path + schema: + type: string + description: | + Developer name of the data kit or name of the `DataPackageKitDefinition`. + + **Available Version:** 63.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataKitMembersList" + examples: + Example: + $ref: "#/components/examples/data-kit-manifest-output" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/data-kits/{dataKitName}/undeploy: + post: + summary: Undeploy data kit component + tags: + - Data Kits + description: | + 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: + - name: asyncMode + in: query + required: true + description: | + Indicates whether the deployment is asynchronous. Only the `true` value is accepted. + + **Available Version:** 63.0 + schema: + type: boolean + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 63.0 + schema: + type: string + - name: dataKitName + in: path + required: true + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitUnDeployInputRepresentation" + examples: + Example: + $ref: "#/components/examples/undeploy-data-kit-component-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitAsyncRepresentation" + examples: + Example: + $ref: "#/components/examples/data-kit-async-output-example" + /ssot/data-kits/{dataKitName}/components/{componentName}/dependencies: + get: + summary: Get data kit component dependency + tags: + - Data Kits + description: | + Get the dependencies for components deployed from a data kit. + + **Available Version:** 63.0 + parameters: + - name: componentType + in: query + required: true + description: | + 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 + schema: + type: string + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 63.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitComponentDependencyCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-kit-component-dependencies-output-example" + parameters: + - name: componentName + in: path + required: true + schema: + type: string + description: | + Name of the component. + + **Available Version:** 63.0 + - name: dataKitName + in: path + required: true + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + /ssot/data-kits/{dataKitName}/components/{componentName}/deployment-status: + get: + summary: Get data kit component status + tags: + - Data Kits + description: | + Get the status of a component deployed from a data kit. + + **Available Version:** 62.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataKitComponentDeploymentStatusRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-kit-component-status-output-example" + parameters: + - name: componentName + in: path + required: true + schema: + type: string + description: | + Name of the component. + + **Available Version:** 62.0 + - name: dataKitName + in: path + required: true + schema: + type: string + description: | + Developer name of the data kit. + + **Available Version:** 62.0 + /ssot/data-lake-objects: + get: + summary: Get data lake objects + tags: + - Data Lake Objects + description: | + Get a collection of all data lake objects (DLOs). + + **Available Version:** 60.0 + parameters: + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of relationships to return. If unspecified, the default value is `20`. + + **Available Version:** 60.0 + - name: offset + in: query + schema: + type: integer + description: | + 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 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-DLOs-output-example" + post: + summary: Create data lake object + tags: + - Data Lake Objects + description: | + Create a data lake object (DLO). + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-DLO-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/DLO-output-example" + /ssot/data-lake-objects/{recordIdOrDeveloperName}: + delete: + summary: Delete data lake object + tags: + - Data Lake Objects + description: | + Delete a data lake object (DLO). + + **Available Version:** 60.0 + parameters: + - name: recordIdOrDeveloperName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the DLO. + + **Available Version:** 60.0 + responses: + "204": + description: Success + get: + summary: Get data lake object + tags: + - Data Lake Objects + description: | + Get a data lake object (DLO). + + **Available Version:** 60.0 + parameters: + - name: recordIdOrDeveloperName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the DLO. + + **Available Version:** 60.0 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of relationships to return. If unspecified, the default value is `20`. + + **Available Version:** 60.0 + - name: offset + in: query + schema: + type: integer + description: | + 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 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/DLO-output-example" + patch: + summary: Update data lake object + tags: + - Data Lake Objects + description: | + Update a data lake object (DLO) by adding new fields or changing the label. + + **Available Version:** 60.0 + parameters: + - name: recordIdOrDeveloperName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the DLO. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectPatchInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-DLO-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataLakeObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/DLO-output-example" + /ssot/data-model-objects: + get: + summary: Get data model objects + tags: + - Data Model Objects + description: | + Get a paginated list of all data model objects (DMOs). + + **Available Version:** 61.0 + parameters: + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of DMOs to return. If unspecified, the default value is `50`. + + **Available Version:** 61.0 + - name: offset + in: query + schema: + type: integer + description: | + 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 + - name: orderBy + in: query + schema: + type: string + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-DMOs-output-example" + "400": + description: | + Number outside valid range. Maximum SOQL offset allowed for apiName MktDataModelObject is 2000. + + post: + summary: Create data model object + tags: + - Data Model Objects + description: | + Create a custom data model object (DMO). + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectInputRepresentation" + examples: + Example: + $ref: "#/components/examples/post-DMO-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/post-DMO-output-example" + "400": + description: | + 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. + /ssot/data-model-objects/{dataModelObjectName}: + delete: + summary: Delete data model object + tags: + - Data Model Objects + description: | + Delete a standard or custom data model object (DMO). + + **Available Version:** 61.0 + responses: + "204": + description: Success + "404": + description: Not found. + get: + summary: Get data model object + tags: + - Data Model Objects + description: | + Get a data model object (DMO). + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/get-DMO-output-example" + "404": + description: | + No record exists or user might not have access to DMO with developer name: *dataModelObjectName*. + patch: + summary: Update data model object + tags: + - Data Model Objects + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectInputRepresentation" + examples: + Example: + $ref: "#/components/examples/patch-DMO-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataModelObjectRepresentation" + examples: + Example: + $ref: "#/components/examples/patch-DMO-output-example" + "400": + description: | + 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)*. + parameters: + - name: dataModelObjectName + in: path + required: true + schema: + type: string + description: | + Developer name of the DMO. + + **Available Version:** 61.0 + /ssot/data-model-object-mappings: + get: + summary: Get data model object mappings + tags: + - Data Model Objects + description: | + Get the details of all mappings associated with a data model object (DMO). + + **Available Version:** 61.0 + parameters: + - name: dataspace + in: query + schema: + type: string + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 61.0 + - name: dloDeveloperName + in: query + schema: + type: string + description: | + Developer name of the data lake object (DLO) source object. + + **Available Version:** 61.0 + - name: dmoDeveloperName + in: query + required: true + schema: + type: string + description: | + Developer name of the DMO target object. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-DMO-mappings-output-example" + "400": + description: DMO or source object (CRM) developer name is missing. + "404": + description: | + 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: + summary: Create data model object mapping + tags: + - Data Model Objects + description: | + 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: + - name: dataspace + in: query + required: true + schema: + type: string + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapInputRepresentation" + examples: + Example: + $ref: "#/components/examples/post-DMO-mapping-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapRepresentation" + examples: + Example: + $ref: "#/components/examples/post-DMO-mapping-output-example" + "400": + description: | + 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": + description: | + Not found. + + For example: + - DLO not found for the given developer name: *sourceEntityDeveloperName*. + /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}: + delete: + summary: Delete data model object mapping + tags: + - Data Model Objects + description: | + Delete a mapping between a data lake object (DLO) source and a data model object (DMO) target. + + **Available Version:** 61.0 + responses: + "200": + description: Success + "404": + description: | + Object source target map not found for the given name: *objectSourceTargetMapDeveloperName*. + get: + summary: Get data model object mapping + tags: + - Data Model Objects + description: | + 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 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapRepresentation" + examples: + Example: + $ref: "#/components/examples/get-DMO-mapping-output-example" + "404": + description: | + Object source target map not found for the given name: *objectSourceTargetMapDeveloperName*. + parameters: + - name: objectSourceTargetMapDeveloperName + in: path + required: true + schema: + type: string + description: | + 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 + - name: dataspace + in: query + schema: + type: string + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 61.0 + /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings: + delete: + summary: Delete data model object field mapping + tags: + - Data Model Objects + description: | + Delete a field mapping between a data lake object (DLO) source and a data model object (DMO) target. + + **Available Version:** 61.0 + parameters: + - name: objectSourceTargetMapDeveloperName + in: path + required: true + schema: + type: string + description: | + 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 + - name: dataspace + in: query + schema: + type: string + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 61.0 + responses: + "200": + description: Success + "404": + description: | + Object source target map not found for the given name: *objectSourceTargetMapDeveloperName*. + /ssot/data-model-object-mappings/{objectSourceTargetMapDeveloperName}/field-mappings/{fieldSourceTargetMapDeveloperName}: + patch: + summary: Delete data model object field mapping + tags: + - Data Model Objects + description: | + 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: + - name: fieldSourceTargetMapDeveloperName + in: path + schema: + type: string + description: | + 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 + - name: objectSourceTargetMapDeveloperName + in: path + required: true + schema: + type: string + description: | + 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 + - name: dataspace + in: query + schema: + type: string + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapInputRepresentation" + examples: + Example: + $ref: "#/components/examples/patch-DMO-mapping-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpObjectSourceTargetMapRepresentation" + examples: + Example: + $ref: "#/components/examples/patch-DMO-mapping-output-example" + "400": + description: | + Invalid input. + + For example: + - Source entity developer name in request body is missing. + - Field mapping(s) in request body is missing. + "404": + description: | + Not found. + + For example: + - Object source target map not found for the given name: *objectSourceTargetMapDeveloperName*. + /ssot/data-model-objects/relationships/{name}: + delete: + summary: Delete field source target relationship + tags: + - Data Model Objects + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 64.0 + schema: + type: string + - name: name + in: path + required: true + schema: + type: string + description: | + ID or developer name of the field source target relationship. + + **Available Version:** 64.0 + responses: + "200": + description: Success + /ssot/data-model-objects/{dataModelObjectName}/relationships: + get: + summary: Get field source target relationships + tags: + - Data Model Objects + description: | + 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: + - name: creationType + in: query + description: | + Filter the returned results based on relationship creation type. + + **Available Version:** 64.0 + schema: + enum: + - CalculatedInsight + - Curated + - Custom + - SegmentMembership + - Standard + - System + type: string + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 64.0 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of relationships to return. If unspecified, the default value is `20`. + + **Available Version:** 64.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + 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 + schema: + enum: + - FilterSortOrderAsc + - FilterSortOrderDesc + type: string + - name: sortBy + in: query + description: | + The field on which the results are to be sorted. + + **Available Version:** 64.0 + schema: + type: string + - name: status + in: query + description: | + Filter the returned results based on relationship status. + + **Available Version:** 64.0 + schema: + enum: + - Active + - Creating + - DeactivateByUser + - Deleting + - Error + - Inactive + - Updating + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/FieldSrcTrgtRelationshipCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/all-dmo-relationships-output-example" + post: + summary: Create field source target relationships + tags: + - Data Model Objects + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 64.0 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/FieldSrcTrgtRelationshipCollectionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-dmo-relationships-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/FieldSrcTrgtRelationshipCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/all-dmo-relationships-output-example" + parameters: + - name: dataModelObjectName + in: path + required: true + schema: + type: string + description: | + Name of the data model object (DMO), which is either the source DMO or the target DMO. + + **Available Version:** 64.0 + /ssot/data-spaces: + get: + summary: Get data spaces + tags: + - Data Spaces + description: | + Get a collection of all data spaces that a user is assigned to. + + **Available Version:** 62.0 + parameters: + - name: limit + in: query + description: | + 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 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-all-data-spaces-output-example" + post: + summary: Create data space + tags: + - Data Spaces + description: | + Create a new data space based on the input details provided. + + **Available Version:** 62.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-space-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceInfoRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-space-output-example" + /ssot/data-spaces/{idOrName}: + get: + summary: Get data space + tags: + - Data Spaces + description: | + Get a data space by ID or API name. + + **Available Version:** 62.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceInfoRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-space-output-example" + patch: + summary: Update data space + tags: + - Data Spaces + description: | + Update an existing data space. + + **Available Version:** 62.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpacePatchInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-data-space-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceInfoRepresentation" + examples: + Example: + $ref: "#/components/examples/update-data-space-output-example" + parameters: + - name: idOrName + in: path + required: true + schema: + type: string + description: | + ID or API name of the data space. + + **Available Version:** 62.0 + /ssot/data-spaces/{idOrName}/members: + delete: + summary: Delete data space members + tags: + - Data Spaces + description: | + Delete the specified data lake objects (DLOs) from a data space. + + **Available Version:** 66.0 + parameters: + - name: idOrName + in: path + schema: + type: string + description: | + ID or API name of the data space. + + **Available Version:** 66.0 + required: true + - name: memberNames + in: query + schema: + type: string + description: | + DLO names separated by commas, for example, `DataSpaceMember1__dll,DataSpaceMember2__dll`. Maximum 10 members per request. + + **Available Version:** 66.0 + required: true + responses: + "200": + description: | + 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: + summary: Get data space members + tags: + - Data Spaces + description: | + Get information about the objects that can access a data space. Currently, only data lake objects (DLOs) are supported. + + **Available Version:** 61.0 + parameters: + - name: limit + in: query + description: | + 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:** 61.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceMemberCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-space-members-output-example" + put: + summary: Upsert data space members + tags: + - Data Spaces + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceMemberCollectionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/upsert-data-space-members-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceMemberPutCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/upsert-data-space-members-output-example" + parameters: + - name: idOrName + in: path + required: true + schema: + type: string + description: | + ID or API name of the data space. + + **Available Version:** 61.0 + /ssot/data-spaces/{idOrName}/members/{dataSpaceMemberObjectName}: + get: + summary: Get data space member + tags: + - Data Spaces + description: | + Get details about a data space member for a given data lake object (DLO). + + **Available Version:** 62.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataSpaceMemberRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-space-member-output-example" + parameters: + - name: dataSpaceMemberObjectName + in: path + required: true + schema: + type: string + description: | + Developer name of the data space member. For example, `DLO_DloDeveloperName`. + + **Available Version:** 62.0 + - name: idOrName + in: path + required: true + schema: + type: string + description: | + ID or API name of the data space. + + **Available Version:** 62.0 + /ssot/data-streams: + get: + summary: Get data streams + tags: + - Data Streams + description: | + Get a list of data streams. + + **Available Version:** 60.0 + parameters: + - name: connectionName + in: query + schema: + type: string + description: | + Name of the data stream connection. + + **Available Version:** 60.0 + - name: filter + in: query + schema: + type: string + description: | + 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 + - name: includeMappings + in: query + description: | + Indicates whether or not to include mappings in the results. + + **Available Version:** 60.0 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of rows to return from `1` through `200`. If unspecified, the default number of rows is `10`. + + **Available Version:** 60.0 + schema: + type: integer + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 60.0 + schema: + type: integer + - name: orderBy + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamCollectionRepresentation" + examples: + SFDC data streams response: + $ref: "#/components/examples/get-sfdc-data-streams-output-example" + Marketing Cloud data streams response: + $ref: "#/components/examples/get-mc-data-streams-output-example" + post: + summary: Create data stream + tags: + - Data Streams + description: | + Create a data stream. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamInputRepresentation" + examples: + S3 data stream request: + $ref: "#/components/examples/create-s3-data-stream-request-example" + S3 data stream from existing DLO request: + $ref: "#/components/examples/create-s3-data-stream-from-existing-DLO-request-example" + S3 data stream with org currency request: + $ref: "#/components/examples/create-s3-data-stream-with-org-currency-request-example" + Full refresh data stream request: + $ref: "#/components/examples/create-full-refresh-data-stream-request" + Incremental datetime data stream request: + $ref: "#/components/examples/create-incremental-datetime-data-stream-request" + Incremental numeric data stream request: + $ref: "#/components/examples/create-incremental-numeric-data-stream-request" + Bundle data stream request: + $ref: "#/components/examples/create-bundle-data-stream-request" + Snowflake data stream request: + $ref: "#/components/examples/create-snowflake-data-stream-request" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamRepresentation" + examples: + S3 data stream response: + $ref: "#/components/examples/create-s3-data-stream-response-example" + S3 data stream from existing DLO response: + $ref: "#/components/examples/create-s3-data-stream-from-existing-DLO-response-example" + S3 data stream with org currency response: + $ref: "#/components/examples/create-s3-data-stream-with-org-currency-response-example" + /ssot/data-streams/{recordIdOrDeveloperName}: + delete: + summary: Delete data stream + tags: + - Data Streams + description: | + Delete a data stream. + + **Available Version:** 60.0 + parameters: + - name: shouldDeleteDataLakeObject + in: query + description: | + 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 + schema: + type: boolean + responses: + "204": + description: Success + get: + summary: Get data stream + tags: + - Data Streams + description: | + Get a data stream. + + **Available Version:** 60.0 + parameters: + - name: includeMappings + in: query + description: | + Indicates whether or not to include mappings in the results. + + **Available Version:** 60.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamDetailedRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-stream-output-example" + patch: + summary: Update data stream + tags: + - Data Streams + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamPatchInputRepresentation" + examples: + S3 data stream request: + $ref: "#/components/examples/update-s3-data-stream-request-example" + BYOL data stream request: + $ref: "#/components/examples/update-BYOL-data-stream-request-example" + Add a new source field request: + $ref: "#/components/examples/update-data-stream-source-field-request-example" + Add a new formula field request: + $ref: "#/components/examples/update-data-stream-formula-field-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamRepresentation" + examples: + S3 data stream response: + $ref: "#/components/examples/update-s3-data-stream-response-example" + BYOL data stream response: + $ref: "#/components/examples/update-BYOL-data-stream-response-example" + parameters: + - name: recordIdOrDeveloperName + in: path + required: true + schema: + type: string + description: | + Record ID or developer name of the data stream. + + **Available Version:** 60.0 + /ssot/data-streams/{recordIdOrDeveloperName}/actions/run: + post: + summary: Run data streams + tags: + - Data Streams + description: | + Start a data stream run to ingest data from the source and refresh the data lake object (DLO). + + **Available Version:** 62.0 + parameters: + - name: recordIdOrDeveloperName + in: path + required: true + schema: + type: string + description: | + Record ID or developer name of the data stream. + + **Available Version:** 60.0 + - name: interactive + in: query + schema: + type: boolean + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataStreamActionResponseRepresentation" + /ssot/data-transforms: + get: + summary: Get data transforms + tags: + - Data Transforms + description: | + Get a list of data transforms. + + **Available Version:** 60.0 + parameters: + - name: filterGroup + in: query + description: | + 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 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of rows to return from `1` through `20`. If unspecified, the default number of rows is `20`. + + **Available Version:** 60.0 + schema: + type: integer + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderBy + in: query + description: | + Sort order for the result set. If unspecified, items are returned in the order they are retrieved. + + **Available Version:** 60.0 + schema: + enum: + - DataTransformStatusAsc + - DataTransformStatusDesc + - LabelAsc + - LabelDesc + - LastRunStatusAsc + - LastRunStatusDesc + - LastRunTimeAsc + - LastRunTimeDesc + - MruAsc + - MruDesc + - NameAsc + - NameDesc + - TypeAsc + - TypeDesc + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-transforms-output-example" + "401": + description: Insufficient access. Development gate is closed or access check is false. + "404": + description: User does not have read access to this data transform. + post: + summary: Create data transform + tags: + - Data Transforms + description: | + Create a data transform. + + **Available Version:** 60.0 + parameters: + - name: filterGroup + in: query + description: | + 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 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformInputRepresentation" + examples: + Batch data transform request: + $ref: "#/components/examples/create-batch-data-transform-request-example" + Streaming data transform request: + $ref: "#/components/examples/create-streaming-data-transform-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformRepresentation" + examples: + Batch data transform response: + $ref: "#/components/examples/create-data-transform-response-example" + "400": + description: | + Bad request. + + For example: + - Validation fails on *definition.nodes*. + - Streaming data transform cannot have multiple definitions. + - Batch data transform definition limit exceeded. + "401": + description: Insufficient access. + "409": + description: Developer name already exists. + /ssot/data-transforms/{dataTransformNameOrId}: + delete: + summary: Delete data transform + tags: + - Data Transforms + description: | + Initiate the deletion of a data transform. + + **Available Version:** 60.0 + responses: + "200": + description: Success + "400": + description: Delete not allowed. + "401": + description: Insufficient access. + get: + summary: Get data transform + tags: + - Data Transforms + description: | + Get a data transform. + + **Available Version:** 60.0 + parameters: + - name: filterGroup + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformRepresentation" + "401": + description: Insufficient access. + "404": + description: User does not have read access to this data transform. + put: + summary: Update data transform + tags: + - Data Transforms + description: | + Update a data transform. + + **Available Version:** 60.0 + parameters: + - name: filterGroup + in: query + description: | + 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 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformInputRepresentation" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformRepresentation" + "400": + description: | + 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. + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform to update. + + **Available Version:** 60.0 + /ssot/data-transforms/{dataTransformNameOrId}/actions/cancel: + post: + summary: Cancel data transform + tags: + - Data Transforms + description: | + Cancel a data transform. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataTransformActionResponseRepresentation" + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform to cancel. + + **Available Version:** 60.0 + /ssot/data-transforms/{dataTransformNameOrId}/actions/refresh-status: + post: + summary: Refresh data transform status + tags: + - Data Transforms + description: | + Refresh the status of a data transform. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataTransformActionResponseRepresentation" + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform to refresh. + + **Available Version:** 60.0 + /ssot/data-transforms/{dataTransformNameOrId}/actions/retry: + post: + summary: Retry data transform + tags: + - Data Transforms + description: | + Retry a data transform. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataTransformActionResponseRepresentation" + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform to retry. + + **Available Version:** 60.0 + /ssot/data-transforms/{dataTransformNameOrId}/actions/run: + post: + summary: Run data transform + tags: + - Data Transforms + description: | + Run a data transform. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpDataTransformActionResponseRepresentation" + "400": + description: | + Bad request. + + For example: + - Unable to run streaming transform. + - Unable to run inactive transform. + - Definition name is required for multi-definition transforms. + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform to run. + + **Available Version:** 60.0 + /ssot/data-transforms/{dataTransformNameOrId}/run-history: + get: + summary: Get data transform run history + tags: + - Data Transforms + description: | + 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: + - name: limit + in: query + description: | + Maximum number of results to return. + + **Available Version:** 62.0 + schema: + type: integer + - name: offset + in: query + description: | + Number of results to skip. Typically used to paginate results. + + **Available Version:** 62.0 + schema: + type: integer + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformRunHistoryCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-data-transform-run-history-output-example" + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or Id of the data transform to get run history for. + + **Available Version:** 62.0 + /ssot/data-transforms/{dataTransformNameOrId}/schedule: + get: + summary: Get data transform schedule + tags: + - Data Transforms + description: | + Get a data transform's schedule. The response contains different fields depending on its frequency. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpScheduleBaseRepresentation" + "400": + description: Bad request. For example, the definition name is required for multi-definition transforms. + "403": + description: Invalid input. + put: + summary: Update data transform schedule + tags: + - Data Transforms + description: | + Update a data transform's schedule. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpScheduleInputRepresentation" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpScheduleBaseRepresentation" + parameters: + - name: dataTransformNameOrId + in: path + required: true + schema: + type: string + description: | + Name or ID of the data transform. + + **Available Version:** 60.0 + /ssot/data-transforms-validation: + post: + summary: Validate data transform + tags: + - Data Transforms + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformInputRepresentation" + examples: + Example: + $ref: "#/components/examples/validate-data-transforms-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/DataTransformValidationRepresentation" + examples: + Example: + $ref: "#/components/examples/validate-data-transforms-output-example" + /ssot/document-processing/actions/detect-schema: + post: + summary: Detect Document AI schema + tags: + - Document AI + description: | + Detects which extraction schema best matches a document using single or multi-schema mode. + + **Available Version:** 67.0 + parameters: + - name: threshold + in: query + schema: + format: double + type: number + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/IdpSchemaDetectionInputRepresentation" + examples: + Single schema detection request: + $ref: "#/components/examples/detect-schema-input-example" + Multi schema detection request: + $ref: "#/components/examples/detect-schema-multi-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/IdpSchemaDetectionRepresentation' + examples: + Single schema detection response: + $ref: "#/components/examples/detect-schema-output-example" + Multi schema detection response: + $ref: "#/components/examples/detect-schema-multi-output-example" + /ssot/document-processing/actions/extract-data: + post: + summary: Extract Document AI configuration data + tags: + - Document AI + description: | + Extract data from a source of unstructured data. You can specify a page range for extraction and assign confidence scores for each extracted field. + + **Available Version:** 63.0 + parameters: + - schema: + type: integer + description: | + Ending page number for data extraction. + + **Available Version:** 66.0 + in: query + name: endPage + - schema: + type: boolean + description: | + Indicates whether to assign a confidence score to each field in the extracted data (`true`) or not (`false`). + + **Available Version:** 64.0 + in: query + name: extractDataWithConfidenceScore + - schema: + type: integer + description: | + Starting page number for data extraction. + + **Available Version:** 66.0 + in: query + name: startPage + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/IdpExtractDataInputRepresentation" + examples: + Base64 file source request: + $ref: "#/components/examples/extract-data-request-with-base64-example" + Base64 file source and a schema request: + $ref: "#/components/examples/extract-data-request-with-base64-schema-example" + Content document file source request: + $ref: "#/components/examples/extract-data-request-with-content-document-example" + Content document file source and a schema request: + $ref: "#/components/examples/extract-data-request-with-content-document-schema-example" + SF Drive file source request: + $ref: "#/components/examples/extract-data-request-with-sfdrive-example" + SF Drive file source and a schema request: + $ref: "#/components/examples/extract-data-request-with-sfdrive-schema-example" + Schema config request: + $ref: "#/components/examples/extract-data-request-with-schema-config-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpExtractedDataRepresentation" + examples: + Example: + $ref: "#/components/examples/extract-data-output-example" + /ssot/document-processing/actions/generate-schema: + post: + summary: Generate Document AI schema + tags: + - Document AI + description: | + Generate a schema from a source of unstructured data. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/IdpGenerateSchemaInputRepresentation" + examples: + Base64 file source request: + $ref: "#/components/examples/generate-schema-request-with-base64-example" + Content document file source request: + $ref: "#/components/examples/generate-schema-request-with-content-document-example" + SF Drive file source request: + $ref: "#/components/examples/generate-schema-request-with-sfdrive-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpGeneratedSchemaRepresentation" + examples: + Example: + $ref: "#/components/examples/generate-schema-output-example" + /ssot/document-processing/configurations: + get: + summary: Get Document AI configurations + tags: + - Document AI + description: | + Get all Document AI configurations. + + **Available Version:** 63.0 + parameters: + - name: activationStatus + in: query + description: | + Filter by activation status, either `Activated` or `Deactivated`. + + **Available Version:** 63.0 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of records to return. + + **Available Version:** 63.0 + schema: + type: integer + - name: offset + in: query + description: | + Number of records to skip. + + **Available Version:** 63.0 + schema: + type: integer + - name: orderBy + in: query + description: | + Return record sorted by a given field. Sort order is DESC by default. (for example, "Label DESC"). + + **Available Version:** 63.0 + schema: + type: string + - name: search + in: query + description: | + Return only records that contain a specific search term. + + **Available Version:** 63.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationsCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-all-document-ai-configurations-output-example" + post: + summary: Create Document AI configuration + tags: + - Document AI + description: | + Create a new Document AI configuration. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-document-ai-configuration-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationDetailsRepresentation" + examples: + Example: + $ref: "#/components/examples/document-ai-configuration-output-example" + /ssot/document-processing/configurations/{idOrApiName}: + get: + summary: Get Document AI configuration + tags: + - Document AI + description: | + Get the details of a Document AI configuration. + + **Available Version:** 63.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationDetailsRepresentation" + examples: + Example: + $ref: "#/components/examples/get-document-ai-configuration-output-example" + patch: + summary: Update Document AI configuration + tags: + - Document AI + description: | + Update an existing Document AI configuration. + + **Available Version:** 63.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationPatchInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-document-ai-configuration-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpConfigurationDetailsRepresentation" + examples: + Example: + $ref: "#/components/examples/document-ai-configuration-output-example" + delete: + summary: Delete Document AI configuration + tags: + - Document AI + description: | + Delete a Document AI configuration. + + **Available Version:** 63.0 + responses: + "200": + description: Configuration successfully deleted. + parameters: + - name: idOrApiName + in: path + required: true + schema: + type: string + description: | + ID or API name of the Document AI configuration. + + **Available Version:** 63.0 + /ssot/document-processing/configurations/{idOrApiName}/actions/run: + post: + summary: Run Document AI process + tags: + - Document AI + description: | + Run the Document AI configuration to process documents. + + **Available Version:** 63.0 + responses: + "200": + description: A run is triggered. + parameters: + - name: idOrApiName + in: path + required: true + schema: + type: string + description: | + ID or API name of the configuration. + + **Available Version:** 63.0 + /ssot/document-processing/global-config: + get: + summary: Get Document AI global configuration + tags: + - Document AI + description: | + Get the global configurations for Document AI. + + **Available Version:** 63.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/IdpGlobalConfigRepresentation" + examples: + Example: + $ref: "#/components/examples/get-document-ai-global-configuration-output-example" + /ssot/identity-resolutions: + get: + summary: Get identity resolution rulesets + tags: + - Identity Resolutions + description: | + Get identity resolution rulesets in Data 360. + + **Available Version:** 57.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionsOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-identity-resolutions-output-example" + post: + summary: Create identity resolution ruleset + tags: + - Identity Resolutions + description: | + Create an identity resolution ruleset in Data 360. + + **Available Version:** 57.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionConfigInput" + examples: + Example: + $ref: "#/components/examples/create-identity-resolution-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-identity-resolution-output-example" + /ssot/identity-resolutions/{identityResolution}: + delete: + summary: Delete identity resolution ruleset + tags: + - Identity Resolutions + description: | + Delete an identity resolution ruleset in Data 360. + + **Available Version:** 57.0 + responses: + "204": + description: Success + "404": + description: | + Identity resolution not found: *identityResolution*. + get: + summary: Get identity resolution ruleset + tags: + - Identity Resolutions + description: | + Get an identity resolution ruleset in Data 360. + + **Available Version:** 57.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-identity-resolution-output-example" + "404": + description: | + Identity resolution not found: *identityResolution*. + patch: + summary: Update identity resolution ruleset + tags: + - Identity Resolutions + description: | + Update an identity resolution ruleset in Data 360. + + **Available Version:** 57.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionConfigPatchInput" + examples: + Example: + $ref: "#/components/examples/update-identity-resolution-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-identity-resolution-output-example" + "404": + description: | + Invalid input or item not found. + + For example: + - Include input for the '*field name*' field and try again. + - Identity resolution not found: *identityResolution*. + parameters: + - name: identityResolution + in: path + required: true + schema: + type: string + description: | + Developer name or ID of the ruleset. + + **Available Version:** 57.0 + /ssot/identity-resolutions/{identityResolution}/actions/run-now: + post: + summary: Run identity resolution ruleset now + tags: + - Identity Resolutions + description: | + Run an identity resolution ruleset job on demand in Data 360. + + **Available Version:** 57.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionRunNowInput" + examples: + Example: + $ref: "#/components/examples/run-identity-resolution-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpIdentityResolutionRunNowOutputRepresentation" + parameters: + - name: identityResolution + in: path + required: true + schema: + type: string + description: | + Developer name or ID of the ruleset. + + **Available Version:** 57.0 + /ssot/insight/calculated-insights/{ciName}: + get: + summary: Get calculated insight object + tags: + - Insights + description: | + Query a Calculated Insight object in Data 360. + + **Available Version:** 52.0 + parameters: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `4999`. + + **Available Version:** 52.0 + schema: + type: integer + - name: dimensions + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + description: | + Filter the result set to a more narrow scope or specific type, such as `[GenderId__c=Male,\u200BFirstName__c=Angel]`. + + **Available Version:** 52.0 + schema: + type: string + - name: measures + in: query + description: | + 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 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 52.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: timeGranularity + in: query + description: | + Time range for the measures. Values are `HOUR`, `DAY`, `MONTH`, `QUARTER`, or `YEAR`. If unspecified, no time range is applied. + + **Available Version:** 54.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/example" + parameters: + - name: ciName + in: path + required: true + schema: + type: string + description: | + Name of the calculated insight object. + + **Available Version:** 52.0 + /ssot/insight/metadata: + get: + summary: Get insight metadata + tags: + - Insights + - Metadata + description: | + Get Insight metadata, including Calculated Insight objects, their dimensions, and their measures in Data 360. + + **Available Version:** 52.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-insight-metadata-output-example" + /ssot/insight/metadata/{ciName}: + get: + summary: Get calculated insight object metadata + tags: + - Insights + - Metadata + description: | + Get metadata for a Calculated Insight object in Data 360. Metadata includes dimensions and measures. + + **Available Version:** 52.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-calculated-insight-metadata-output-example" + "404": + description: The requested resource does not exist. + parameters: + - name: ciName + in: path + required: true + schema: + type: string + description: | + Name of the calculated insight object. + + **Available Version:** 52.0 + /ssot/machine-learning/alerts: + post: + summary: Create data alert + tags: + - Machine Learning + description: | + Create a new data alert within the data alert collection. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlDataAlertQueryInputRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-alert-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/MlDataAlertCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/create-data-alert-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/alerts/{alertId}: + patch: + summary: Update data alert + tags: + - Machine Learning + description: | + Partially update an existing data alert. + + **Available Version:** 61.0 + parameters: + - name: alertId + in: path + required: true + schema: + type: string + description: | + ID of the data alert. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlDataAlertInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-data-alert-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/MlDataAlertRepresentation" + examples: + Example: + $ref: "#/components/examples/update-data-alert-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/configured-models: + get: + summary: Get configured models + tags: + - Machine Learning + description: | + Get the set of configured models and their properties. + + **Available Version:** 61.0 + parameters: + - name: assetIdOrName + in: query + description: | + The model's name or ID. If not provided, information for all configured models is returned. + + **Available Version:** 61.0 + schema: + type: string + - name: assetType + in: query + description: | + Whether the model is a configured model or a model artifact. + + **Available Version:** 61.0 + schema: + enum: + - ModelArtifact + - ModelSetup + type: string + - name: capabilities + in: query + description: | + Model capability. + + **Available Version:** 61.0 + schema: + type: array + items: + enum: + - BinaryClassification + - ChatCompletion + - Completion + - Embedding + - Generic + - MulticlassClassification + - Regression + type: string + - name: connectorType + in: query + description: | + For models that are externally connected, indicates the type of connector. + + **Available Version:** 61.0 + schema: + enum: + - Anthropic + - AzureOpenAI + - Bedrock + - Databricks + - Generic + - InternalEmbedding + - OpenAI + - SageMaker + - VertexAI + type: string + - name: limit + in: query + description: | + Maximum number of models to display on each page. + + **Available Version:** 61.0 + schema: + type: integer + - name: modelType + in: query + description: | + The type of model. + + **Available Version:** 61.0 + schema: + enum: + - Generative + - Predictive + - Unknown + type: string + - name: offset + in: query + description: | + The number of models to skip, or offset, during pagination. + + **Available Version:** 61.0 + schema: + type: integer + - name: outOfTheBox + in: query + description: | + If `true`, the model is managed by Salesforce. + + **Available Version:** 61.0 + schema: + type: boolean + - name: search + in: query + description: | + The search string to use when filtering the query. + + **Available Version:** 61.0 + schema: + type: string + - name: sourceType + in: query + description: | + 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 + schema: + enum: + - EdcNoCode + - ModelConnector + - OutOfTheBox + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/MlConfiguredModelCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-configured-model-collection-output-example" + /ssot/machine-learning/configured-models/{configuredModelIdOrName}: + delete: + summary: Delete configured model + tags: + - Machine Learning + description: | + Delete a configured model. + + **Available Version:** 61.0 + responses: + "200": + description: Success + get: + summary: Get configured model + tags: + - Machine Learning + description: | + Get the configured model. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. + + **Available Version:** 61.0 + parameters: + - name: filterGroup + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/MlConfiguredModelRepresentation" + examples: + Example: + $ref: "#/components/examples/configured-model-output-example" + patch: + summary: Update configured model + tags: + - Machine Learning + description: | + Update a configured model. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlConfiguredModelInputRepresentation" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/MlConfiguredModelRepresentation" + examples: + Example: + $ref: "#/components/examples/configured-model-output-example" + parameters: + - name: configuredModelIdOrName + in: path + required: true + schema: + type: string + description: | + The model's fully qualified name or ID. If using the model's name, use `__`, for example `mynamespace__ourGPT35Turbo`. + + **Available Version:** 61.0 + /ssot/machine-learning/jobs: + get: + summary: Get predict jobs + tags: + - Machine Learning + description: | + Get a list of predict jobs. + + **Available Version:** 59.0 + parameters: + - name: jobIdOrName + in: query + schema: + type: string + description: | + ID or API name of the predict job. + + **Available Version:** 59.0 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of predict jobs to return. + + **Available Version:** 59.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 59.0 + - name: type + in: query + schema: + enum: + - Prediction + - Training + type: string + description: | + Type of job. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CdpMlJobCollectionRepresentation' + examples: + example1: + $ref: "#/components/examples/get-jobs-output-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/jobs/{jobId}: + get: + summary: Get a predict job + tags: + - Machine Learning + description: | + Get a specific predict job. + + **Available Version:** 59.0 + parameters: + - name: jobId + in: path + schema: + type: string + description: | + ID of the predict job. + + **Available Version:** 59.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CdpMlJobBaseRepresentation' + examples: + example1: + $ref: "#/components/examples/get-job-output-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/jobs/{jobId}/tasks: + get: + summary: Get predict job tasks + tags: + - Machine Learning + description: | + Get a list of tasks associated with a specific predict job. + + **Available Version:** 59.0 + parameters: + - name: jobId + in: path + schema: + type: string + description: | + ID of the predict job. + + **Available Version:** 59.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CdpMlTaskCollection' + examples: + example1: + $ref: "#/components/examples/get-tasks-output-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/jobs/{jobId}/tasks/{taskId}: + get: + summary: Get a predict job task + tags: + - Machine Learning + description: | + Get a task associated with a specific predict job. + + **Available Version:** 59.0 + parameters: + - name: jobId + in: path + schema: + type: string + description: | + ID of the predict job. + + **Available Version:** 59.0 + required: true + - name: taskId + in: path + schema: + type: string + description: | + ID of the task. + + **Available Version:** 59.0 + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CdpMlTaskBase' + examples: + example1: + $ref: "#/components/examples/get-task-output-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/model-artifacts: + get: + summary: Get model artifacts + tags: + - Machine Learning + description: | + Get model artifacts. + + **Available Version:** 61.0 + parameters: + - name: limit + in: query + description: | + Maximum number of artifacts to return. + + **Available Version:** 61.0 + schema: + type: integer + - name: modelType + in: query + description: | + Type of artifacts to return. + + **Available Version:** 61.0 + schema: + enum: + - Generative + - Predictive + - Unknown + type: string + - name: offset + in: query + description: | + The number of models to skip, or offset, during pagination. + + **Available Version:** 61.0 + schema: + type: integer + - name: sourceType + in: query + description: | + 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 + schema: + enum: + - EdcNoCode + - ModelConnector + - OutOfTheBox + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlModelArtifactCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/get-model-artifact-collection-output-example" + /ssot/machine-learning/model-artifacts/{modelArtifactIdOrName}: + delete: + summary: Delete model artifact + tags: + - Machine Learning + description: | + Delete the model artifact. + + **Available Version:** 61.0 + responses: + "200": + description: Success + get: + summary: Get model artifact + tags: + - Machine Learning + description: | + Get the model artifact. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlModelArtifactBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-artifact-output-example" + patch: + summary: Update model artifact + tags: + - Machine Learning + description: | + Update the model artifact. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlModelArtifactInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-model-artifact-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlModelArtifactBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-artifact-output-example" + parameters: + - name: modelArtifactIdOrName + in: path + required: true + schema: + type: string + description: | + The artifact's name or ID. If using the artifact's name, use `__`. + + **Available Version:** 61.0 + /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions: + get: + summary: Get model setup versions + tags: + - Machine Learning + description: | + Retrieve a list of model setup versions. + + **Available Version:** 59.0 + parameters: + - name: active + in: query + schema: + type: boolean + description: | + Indicates whether the model setup is active (`true`) or not (`false`). + + **Available Version:** 59.0 + - name: limit + in: query + schema: + type: integer + description: | + Maximum number of model setup versions to return. + + **Available Version:** 59.0 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupVersionCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-versions-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + post: + summary: Create model setup version + tags: + - Machine Learning + description: | + Create a new model setup version. + + **Available Version:** 59.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupBaseInputRepresentation" + examples: + Example: + $ref: "#/components/examples/post-model-setup-version-input-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-version-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + parameters: + - name: modelSetupIdOrName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the model setup. + + **Available Version:** 59.0 + /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}: + get: + summary: Get model setup version + tags: + - Machine Learning + description: | + Retrieve a specific model setup version. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-version-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + patch: + summary: Update model setup version + tags: + - Machine Learning + description: | + Partially update an existing model setup version. + + **Available Version:** 59.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlSetupBaseUpdateInputRepresentation" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-version-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + parameters: + - name: modelSetupIdOrName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the model setup. + + **Available Version:** 59.0 + - name: modelSetupVersionId + in: path + required: true + schema: + type: string + description: | + ID of the model setup version. + + **Available Version:** 59.0 + /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions: + get: + summary: Get model setup version partitions + tags: + - Machine Learning + description: | + Retrieve all partitions of a specific model setup version. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupVersionPartitionCollectionRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-version-partitions-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/model-setups/{modelSetupIdOrName}/setup-versions/{modelSetupVersionId}/partitions/{modelSetupPartitionId}: + get: + summary: Get model setup version partition + tags: + - Machine Learning + description: | + Retrieve a partition of a specific model setup version. + + **Available Version:** 59.0 + parameters: + - name: modelSetupPartitionId + in: path + required: true + schema: + type: string + description: | + ID of the model setup partition. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlSetupPartitionBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/model-setup-version-partition-output-example" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + parameters: + - name: modelSetupIdOrName + in: path + required: true + schema: + type: string + description: | + ID or developer name of the model setup. + + **Available Version:** 59.0 + - name: modelSetupVersionId + in: path + required: true + schema: + type: string + description: | + ID of the model setup version. + + **Available Version:** 59.0 + /ssot/machine-learning/predict: + post: + summary: Get prediction + tags: + - Machine Learning + description: | + Make a prediction using the specified model and parameters. This request is synchronous. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlPredictInputBaseRepresentation" + examples: + Example: + $ref: "#/components/examples/get-prediction-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpMlPredictResultRepresentation" + examples: + Max top factors response: + $ref: "#/components/examples/maxTopFactors-output-example" + Binary classification response: + $ref: "#/components/examples/binary-classification-output-example" + /ssot/machine-learning/prediction-job-definitions: + get: + summary: Get prediction job definitions + tags: + - Machine Learning + description: | + Get a list of existing prediction job definitions. + + **Available Version:** 59.0 + parameters: + - name: modelId + in: query + schema: + type: string + description: | + ID of the machine learning model. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlPredictionJobDefCollectionRepresentation' + examples: + example1: + $ref: "#/components/examples/get-prediction-jobs-output-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + post: + summary: Create a prediction job definition + tags: + - Machine Learning + description: | + Create a new prediction job definition. + + **Available Version:** 59.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlPredictionJobDefBaseInputRepresentation" + examples: + Binary request: + $ref: "#/components/examples/prediction-job-def-post-binary-request-example" + Clustering request: + $ref: "#/components/examples/prediction-job-def-post-clustering-request-example" + Multiclass request: + $ref: "#/components/examples/prediction-job-def-post-multiclass-request-example" + Sentiment request: + $ref: "#/components/examples/prediction-job-def-post-sentiment-request-example" + Topic request: + $ref: "#/components/examples/prediction-job-def-post-topic-request-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlPredictionJobDefBaseRepresentation' + examples: + Binary response: + $ref: "#/components/examples/prediction-job-def-binary-response-example" + Clustering response: + $ref: "#/components/examples/prediction-job-def-clustering-response-example" + Multiclass response: + $ref: "#/components/examples/prediction-job-def-multiclass-response-example" + Sentiment response: + $ref: "#/components/examples/prediction-job-def-sentiment-response-example" + Topic response: + $ref: "#/components/examples/prediction-job-def-topic-response-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + /ssot/machine-learning/prediction-job-definitions/{predictionJobDefIdOrName}: + delete: + summary: Delete a prediction job definition + tags: + - Machine Learning + description: | + Delete a specific prediction job definition. + + **Available Version:** 59.0 + responses: + "200": + description: Success + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + get: + summary: Get a prediction job definition + tags: + - Machine Learning + description: | + Get a specific prediction job definition. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlPredictionJobDefBaseRepresentation' + examples: + Binary response: + $ref: "#/components/examples/prediction-job-def-binary-response-example" + Clustering response: + $ref: "#/components/examples/prediction-job-def-clustering-response-example" + Multiclass response: + $ref: "#/components/examples/prediction-job-def-multiclass-response-example" + Sentiment response: + $ref: "#/components/examples/prediction-job-def-sentiment-response-example" + Topic response: + $ref: "#/components/examples/prediction-job-def-topic-response-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + patch: + summary: Update a prediction job definition + tags: + - Machine Learning + description: | + Update a specific prediction job definition. + + **Available Version:** 59.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlPredictionJobDefBaseInputRepresentation" + examples: + example1: + $ref: "#/components/examples/prediction-job-def-patch-request-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlPredictionJobDefBaseRepresentation' + examples: + Binary response: + $ref: "#/components/examples/prediction-job-def-binary-response-example" + Clustering response: + $ref: "#/components/examples/prediction-job-def-clustering-response-example" + Multiclass response: + $ref: "#/components/examples/prediction-job-def-multiclass-response-example" + Sentiment response: + $ref: "#/components/examples/prediction-job-def-sentiment-response-example" + Topic response: + $ref: "#/components/examples/prediction-job-def-topic-response-example" + "400": + description: Bad request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + parameters: + - name: predictionJobDefIdOrName + in: path + schema: + type: string + description: | + ID or API name of the prediction job definition. + + **Available Version:** 59.0 + required: true + /ssot/machine-learning/retrievers: + get: + summary: Get retrievers + tags: + - Machine Learning + description: | + Get a paginated list of retrievers. Out-of-the-box retrievers are returned first. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + parameters: + - name: dataCloudOneVisibility + in: query + schema: + enum: + - All + - Consumable + - Local + - Remote + type: string + description: | + Filter retrievers by visibility across organizations in Data Cloud One. + + **Available Version:** 61.0 + - name: detailLevel + in: query + schema: + enum: + - Basic + - Detailed + type: string + description: | + Response detail level. If unspecified, the default value is `Detailed`. + + **Available Version:** 61.0 + - name: isActive + in: query + schema: + type: boolean + description: | + Indicates whether to return only active retrievers (`true`) or not (`false`). + + **Available Version:** 61.0 + - name: isDefault + in: query + schema: + type: boolean + description: | + Indicates whether to return only default retrievers (`true`) or not (`false`). + + **Available Version:** 61.0 + - name: limit + in: query + schema: + type: integer + description: | + 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 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 61.0 + - name: queryType + in: query + schema: + type: array + items: + type: string + enum: + - CustomSql + - Ensemble + - NoCode + description: | + Filter by query type. + + **Available Version:** 61.0 + - name: search + in: query + schema: + type: string + description: | + Search keyword to match against label or API name. + + **Available Version:** 61.0 + - name: sortBy + in: query + schema: + type: array + items: + type: string + enum: + - CreatedDate + - DataSourceType + - Label + - LastModifiedBy + - LastModifiedDate + - OwnerType + - QueryType + - Status + description: | + Field to sort results by. If unspecified, items are returned in `CreatedDate DESC` order. + + **Available Version:** 61.0 + - name: sortOrder + in: query + schema: + type: array + items: + type: string + enum: + - Ascending + - Descending + description: | + Sort order. If unspecified, the default value is `Ascending`. + + **Available Version:** 61.0 + - name: sourceDmo + in: query + schema: + type: string + description: | + Filter by source data model object (DMO) ID or API name. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverCollectionRepresentation' + examples: + example1: + $ref: "#/components/examples/get-retrievers-response" + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + post: + summary: Create retriever + tags: + - Machine Learning + description: | + 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. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlRetrieverInputRepresentation" + examples: + NoCode request: + $ref: "#/components/examples/nocode-create-retriever-request" + Custom SQL request: + $ref: "#/components/examples/customsql-create-retriever-request" + Ensemble request: + $ref: "#/components/examples/ensemble-create-retriever-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverRepresentation' + examples: + NoCode response: + $ref: "#/components/examples/nocode-get-create-update-retriever-response" + Custom SQL response: + $ref: "#/components/examples/customsql-get-create-update-retriever-response" + Ensemble response: + $ref: "#/components/examples/ensemble-get-create-update-retriever-response" + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/machine-learning/retrievers/actions/review: + post: + summary: Review retriever + tags: + - Machine Learning + description: | + 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. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 67.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlRetrieverReviewInputRepresentation" + examples: + example1: + $ref: "#/components/examples/review-retriever-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverReviewRepresentation' + examples: + example1: + $ref: "#/components/examples/review-retriever-response" + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + /ssot/machine-learning/retrievers/{retrieverIdOrName}: + delete: + summary: Delete retriever + tags: + - Machine Learning + description: | + Delete a retriever and all its configuration versions. The retriever must not be used by other entities. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + responses: + "200": + description: Success + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + get: + summary: Get retriever + tags: + - Machine Learning + description: | + Get a retriever with its latest and active configurations. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverRepresentation' + examples: + NoCode response: + $ref: '#/components/examples/nocode-get-create-update-retriever-response' + Custom SQL response: + $ref: '#/components/examples/customsql-get-create-update-retriever-response' + Ensemble response: + $ref: '#/components/examples/ensemble-get-create-update-retriever-response' + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + patch: + summary: Update retriever + tags: + - Machine Learning + description: | + Update a retriever label or description. To change the retrieval behavior, create a new configuration version. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlRetrieverUpdateInputRepresentation" + examples: + example1: + $ref: "#/components/examples/update-retriever-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverRepresentation' + examples: + NoCode response: + $ref: '#/components/examples/nocode-get-create-update-retriever-response' + Custom SQL response: + $ref: '#/components/examples/customsql-get-create-update-retriever-response' + Ensemble response: + $ref: '#/components/examples/ensemble-get-create-update-retriever-response' + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + parameters: + - name: retrieverIdOrName + in: path + schema: + type: string + description: | + Record ID or API name of the retriever. + + **Available Version:** 61.0 + required: true + /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations: + get: + summary: Get retriever configurations + tags: + - Machine Learning + description: | + Get all configuration versions for the retriever. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + parameters: + - name: limit + in: query + schema: + type: integer + description: | + 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 + - name: offset + in: query + schema: + type: integer + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverConfigurationCollectionRepresentation' + examples: + example1: + $ref: '#/components/examples/get-configurations-response' + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + post: + summary: Create retriever configuration + tags: + - Machine Learning + description: | + 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. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlRetrieverConfigurationBaseInputRepresentation" + examples: + NoCode request: + $ref: "#/components/examples/nocode-create-configuration-request" + Custom SQL request: + $ref: "#/components/examples/customsql-create-configuration-request" + Ensemble request: + $ref: "#/components/examples/ensemble-create-configuration-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverConfigurationDetailRepresentation' + examples: + NoCode response: + $ref: "#/components/examples/nocode-get-create-update-configuration-response" + Custom SQL response: + $ref: "#/components/examples/customsql-get-create-update-configuration-response" + Ensemble response: + $ref: "#/components/examples/ensemble-get-create-update-configuration-response" + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + parameters: + - name: retrieverIdOrName + in: path + schema: + type: string + description: | + Record ID or API name of the retriever. + + **Available Version:** 61.0 + required: true + /ssot/machine-learning/retrievers/{retrieverIdOrName}/configurations/{retrieverConfigurationIdOrName}: + delete: + summary: Delete retriever configuration + tags: + - Machine Learning + description: | + Delete a retriever configuration. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + responses: + "200": + description: Success + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + get: + summary: Get retriever configuration + tags: + - Machine Learning + description: | + Get a retriever configuration. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverConfigurationDetailRepresentation' + examples: + NoCode response: + $ref: '#/components/examples/nocode-get-create-update-configuration-response' + Custom SQL response: + $ref: '#/components/examples/customsql-get-create-update-configuration-response' + Ensemble response: + $ref: '#/components/examples/ensemble-get-create-update-configuration-response' + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + patch: + summary: Update retriever configuration + tags: + - Machine Learning + description: | + 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. + + >**Note:** + >This endpoint is a pilot or beta service that is subject to the Beta Services Terms at [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/agreements/) or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the [Product Terms Directory](https://ptd.salesforce.com/). Use of this pilot or beta service is at the Customer's sole discretion. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MlRetrieverConfigurationUpdateInputRepresentation" + examples: + example1: + $ref: "#/components/examples/update-retriever-configuration-request" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MlRetrieverConfigurationDetailRepresentation' + examples: + NoCode response: + $ref: '#/components/examples/nocode-get-create-update-configuration-response' + Custom SQL response: + $ref: '#/components/examples/customsql-get-create-update-configuration-response' + Ensemble response: + $ref: '#/components/examples/ensemble-get-create-update-configuration-response' + "400": + description: Invalid request. Possible causes include missing required fields or invalid data. The response contains errorCode and message. + "401": + description: 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": + description: 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": + description: The server can't find the requested resource. + "500": + description: An error has occurred within Salesforce, so the request could not be completed. Please try again. For more help, contact Salesforce Customer Support. + parameters: + - name: retrieverConfigurationIdOrName + in: path + schema: + type: string + description: | + Record ID or API name of the configuration. + + **Available Version:** 61.0 + required: true + - name: retrieverIdOrName + in: path + schema: + type: string + description: | + Record ID or API name of the retriever. + + **Available Version:** 61.0 + required: true + /ssot/metadata: + get: + summary: Get metadata + tags: + - Metadata + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space. If unspecified, the `default` data space is used. + + **Available Version:** 55.0 + schema: + type: string + - name: entityCategory + in: query + description: | + Category of the metadata entity. Valid values are `Profile`, `Engagement`, and `Related`. If unspecified, all category entities are returned. + + **Available Version:** 54.0 + schema: + type: string + - name: entityName + in: query + description: | + Metadata name of the entity, for example `UnifiedIndividual__dlm`. If unspecified, a complete list of entities is returned. + + **Available Version:** 54.0 + schema: + type: string + - name: entityType + in: query + description: | + Type of metadata entity requested. Valid values are `DataLakeObject`, `DataModelObject`, and `CalculatedInsight`. If unspecified, all types are returned. + + **Available Version:** 54.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-metadata-output-example" + /ssot/metadata-entities: + get: + summary: Get metadata entities + tags: + - Metadata + description: | + 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: + - name: dataspace + in: query + schema: + type: string + description: | + Name of the data space in which the metadata is requested. + + **Available Version:** 66.0 + - name: entityCategory + in: query + schema: + type: string + description: | + 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 + - name: entityType + in: query + schema: + type: string + description: | + Type of metadata entity. If unspecified, all types are returned. Supported values are: + - `CalculatedInsight` + - `DataLakeObject` + - `DataModelObject` + + **Available Version:** 66.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataEntitiesOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-metadata-entities-response" + "400": + description: Bad request. + "403": + description: Forbidden. + "404": + description: Metadata entities not found. + /ssot/private-network-routes: + get: + summary: Get private network routes + tags: + - Private Network Routes + description: | + Get a paginated list of Private Network Routes. + + **Available Version:** 65.0 + parameters: + - name: limit + description: | + Maximum number of rows to return from `1` through `1000`. By default, the endpoint returns `100` rows. + + **Available Version:** 65.0 + in: query + schema: + type: integer + - name: offset + description: | + Number of rows to skip before returning results. By default, the endpoint skips `0` rows. + + **Available Version:** 65.0 + in: query + schema: + type: integer + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateNetworkRouteCollectionRepresentation" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + "429": + description: Too Many Requests. + post: + summary: Create private network route + tags: + - Private Network Routes + description: | + 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 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateNetworkRouteInputRepresentation" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateNetworkRouteCollectionRepresentation" + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + "409": + description: A private network route with this connection URL already exists. A new connection can't be established. + "429": + description: Too Many Requests. + /ssot/private-network-routes/{routeIdOrName}: + delete: + summary: Delete private network route + tags: + - Private Network Routes + description: | + Delete a Private Network Route. + + **Available Version:** 65.0 + responses: + "200": + description: Success + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + "409": + description: A private network route with this connection URL already exists. A new connection can't be established. + "429": + description: Too Many Requests. + get: + summary: Get private network route + tags: + - Private Network Routes + description: | + Get detailed information about a Private Network Route. + + **Available Version:** 65.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/PrivateNetworkRouteRepresentation" + "308": + description: Record Not Found Here. + "400": + description: Bad Request. + "401": + description: Unauthorized. + "403": + description: Forbidden. + "404": + description: Not Found. + "429": + description: Too Many Requests. + parameters: + - name: routeIdOrName + description: | + ID or name of the Private Network Route. + + **Available Version:** 65.0 + in: path + schema: + type: string + required: true + /ssot/profile/metadata: + get: + summary: Get profile metadata + tags: + - Profile + - Metadata + description: | + 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": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-profile-metadata-output-example" + /ssot/profile/metadata/{dataModelName}: + get: + summary: Get profile data model object metadata + tags: + - Profile + - Metadata + description: | + 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 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryMetadataOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-profile-metadata-dmo-output-example" + parameters: + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + /ssot/profile/{dataModelName}: + get: + summary: Get profile data model object + tags: + - Profile + description: | + Query a profile data model object using filters in Data 360. + + **Available Version:** 52.0 + parameters: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. + + **Available Version:** 52.0 + schema: + type: integer + - name: fields + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + required: true + description: | + Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. + + **Available Version:** 52.0 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 52.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-profile-query-dmo-output-example" + parameters: + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + /ssot/profile/{dataModelName}/{id}: + get: + summary: Get profile data model object with search key + tags: + - Profile + description: | + Query a profile data model object using filters and a search key in Data 360. + + **Available Version:** 52.0 + parameters: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. + + **Available Version:** 52. + schema: + type: integer + - name: fields + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + description: | + Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. + + **Available Version:** 52.0 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 52.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: searchKey + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/example" + parameters: + - name: id + in: path + required: true + schema: + type: string + description: | + ID of the data model object (value of the primary or secondary key field). + + **Available Version:** 52.0 + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + /ssot/profile/{dataModelName}/{id}/calculated-insights/{ciName}: + get: + summary: Get profile data model object and calculated insight with search key + tags: + - Profile + description: | + 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: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. + + **Available Version:** 52.0 + schema: + type: integer + - name: dimensions + in: query + description: | + 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 + schema: + type: string + - name: fields + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + description: | + Comma-separated list of equality expressions within square brackets, for example, `[FirstName__c=DON]`. + + **Available Version:** 52.0 + schema: + type: string + - name: measures + in: query + description: | + 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 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 52.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: searchKey + in: query + description: | + 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 + schema: + type: string + - name: timeGranularity + in: query + description: | + Time range for the measures. Values are: `HOUR`, `DAY`, `MONTH`, `QUARTER`, or `YEAR`. + + If unspecified, no time range is applied. + + **Available Version:** 54.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/example" + parameters: + - name: ciName + in: path + required: true + schema: + type: string + description: | + Name of the calculated insight object. + + **Available Version:** 52.0 + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + - name: id + in: path + required: true + schema: + type: string + description: | + ID of the data model object (value of the primary or secondary key field). + + **Available Version:** 52.0 + /ssot/profile/{dataModelName}/{id}/{childDataModelName}: + get: + summary: Get profile data model object and child object with search key + tags: + - Profile + description: | + Query a profile data model object and a child object using filters and a search key in Data 360. + + **Available Version:** 52.0 + parameters: + - name: batchSize + in: query + description: | + Number of items to return. Values are from `1` through `4999`. If unspecified, the default value is `100`. + + **Available Version:** 52.0 + schema: + type: integer + - name: fields + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + description: | + 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 + schema: + type: string + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 52.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + - name: searchKey + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/example" + parameters: + - name: childDataModelName + in: path + required: true + schema: + type: string + description: | + Name of the child data model object. + + **Available Version:** 52.0 + - name: dataModelName + in: path + required: true + schema: + type: string + description: | + Name of the data model object. + + **Available Version:** 52.0 + - name: id + in: path + required: true + schema: + type: string + description: | + ID of the data model object (value of the primary or secondary key field). + + **Available Version:** 52.0 + /ssot/query: + post: + summary: Query data V1 + tags: + - Query V1 & V2 + description: | + 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: + - name: batchSize + in: query + description: | + Number of records to return. Values are from `1` through `49999`. If unspecified, the default value is `49999`. + + **Available Version:** 52.0 + schema: + type: integer + - name: dataspace + in: query + description: | + Name of the data space. + + **Available Version:** 52.0 + schema: + type: string + - name: offset + in: query + description: | + 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 + schema: + type: integer + - name: orderby + in: query + description: | + Comma-separated values to sort the results in ascending or descending order, for example, `GenderId__c ASC,Occupation__c DESC`. + + **Available Version:** 52.0 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryInputRepresentation" + examples: + Example: + $ref: "#/components/examples/query-data-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/example" + /ssot/queryv2: + post: + summary: Query data V2 + tags: + - Query V1 & V2 + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space. + + **Available Version:** 54.0 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryInputRepresentation" + examples: + Example: + $ref: "#/components/examples/query-data-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputV2Representation" + /ssot/queryv2/{nextBatchId}: + get: + summary: Query batch data V1 + tags: + - Query V1 & V2 + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space. + + **Available Version:** 54.0 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryOutputV2Representation" + parameters: + - name: nextBatchId + in: path + required: true + schema: + type: string + description: | + ID from the Data 360 Query Output V2 response body. + + **Available Version:** 54.0 + /ssot/query-sql: + post: + summary: Submit SQL query + tags: + - Query (Current) + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space to query. If unspecified, the `default` data space is used. + + **Available Version:** 63.0 + schema: + type: string + - name: workloadName + in: query + description: | + 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 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/QuerySqlInputRepresentation" + examples: + Simple request: + $ref: "#/components/examples/create-query-request-simple-example" + Request with SQL parameters: + $ref: "#/components/examples/create-query-request-parameters-example" + Request with querySettings: + $ref: "#/components/examples/create-query-request-settings-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/QuerySqlRepresentation" + examples: + Simple response: + $ref: "#/components/examples/create-query-response-simple-example" + Response with SQL parameters: + $ref: "#/components/examples/create-query-response-parameters-example" + "400": + description: Invalid request. The `details` field will contain more information about the SQL code and error. + "401": + description: Invalid JWT. + "403": + description: Permission denied. + "408": + description: Request timed out in processing. + "500": + description: Server error. + /ssot/query-sql/{queryId}: + delete: + summary: Cancel SQL query + tags: + - Query (Current) + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space to query. If unspecified, the `default` data space is used. + + **Available Version:** 63.0 + schema: + type: string + - name: workloadName + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + "400": + description: Invalid request. + "401": + description: Invalid JWT. + "403": + description: Permission denied. + "500": + description: Server error. + get: + summary: Get SQL query status + tags: + - Query (Current) + description: | + 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: + - name: dataspace + in: query + description: | + Name of the data space to query. If unspecified, the `default` data space is used. + + **Available Version:** 63.0 + schema: + type: string + - name: waitTimeMs + in: query + description: | + 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 + schema: + type: integer + - name: workloadName + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/QuerySqlStatusRepresentation" + examples: + Example: + $ref: "#/components/examples/get-query-status-response-example" + "400": + description: Invalid request. + "401": + description: Invalid JWT. + "403": + description: Permission denied. + "500": + description: Server error. + parameters: + - name: queryId + in: path + required: true + schema: + type: string + description: | + 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 + /ssot/query-sql/{queryId}/rows: + get: + summary: Get SQL query rows + tags: + - Query (Current) + description: | + 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: + - name: dataspace + in: query + required: true + description: | + 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 + schema: + type: string + - name: offset + in: query + required: true + description: | + 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 + schema: + format: int64 + type: integer + - name: rowLimit + in: query + description: | + 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 + schema: + format: int64 + type: integer + - name: workloadName + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/QuerySqlPageRepresentation" + examples: + Example: + $ref: "#/components/examples/get-query-rows-response-example" + "400": + description: Invalid request. + "401": + description: Invalid JWT. + "403": + description: Permission denied. + "408": + description: Request timed out in processing. + "500": + description: Server error. + parameters: + - name: queryId + in: path + required: true + schema: + type: string + description: | + 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 + /ssot/search-index: + get: + summary: Get semantic search definition details + tags: + - Search Index + description: | + Get all search index definition details. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchDefDetailsRepresentation" + examples: + Semantic search response: + $ref: "#/components/examples/get-semantic-search-collection-output-example" + Hybrid search response: + $ref: "#/components/examples/get-hybrid-search-collection-output-example" + "400": + description: Bad request. + "403": + description: User does not have permission to access. + "422": + description: Unprocessable entity. + post: + summary: Create semantic search + tags: + - Search Index + description: | + Define the connect APIs that perform create, read, update, and delete operations for a search index of unstructured data. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchInputRepresentation" + examples: + Semantic search type for a DMO request: + $ref: "#/components/examples/semantic-search-for-DMO-request-example" + Semantic search type for a UDMO request: + $ref: "#/components/examples/semantic-search-for-UDMO-request-example" + Hybrid search type request: + $ref: "#/components/examples/hybrid-search-request-example" + Index config request: + $ref: "#/components/examples/semantic-search-with-index-config-request-example" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchRepresentation" + examples: + Example: + $ref: "#/components/examples/semantic-search-output-example" + "400": + description: Bad request. + "403": + description: User does not have permission to access. + "422": + description: Unprocessable entity. + /ssot/search-index/config: + get: + summary: Get semantic search configuration + tags: + - Search Index + description: | + Get a search index configuration. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchConfigRepresentation" + examples: + Example: + $ref: "#/components/examples/get-search-index-configuration-response-example" + /ssot/search-index/{searchIndexApiNameOrId}: + delete: + summary: Delete semantic search + tags: + - Search Index + description: | + Delete a search index definition. + + **Available Version:** 60.0 + responses: + "200": + description: Success + get: + summary: Get semantic search + tags: + - Search Index + description: | + Get information about the specified search index definition record. + + **Available Version:** 60.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchDefDetailRepresentation" + examples: + Semantic search response: + $ref: "#/components/examples/get-semantic-response-example" + Hybrid search response: + $ref: "#/components/examples/get-hybrid-response-example" + "400": + description: Bad request. + "403": + description: User does not have permission to access. + "422": + description: Unprocessable entity. + patch: + summary: Update semantic search + tags: + - Search Index + description: | + Update a Semantic Index record. + + **Available Version:** 60.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchInputRepresentation" + examples: + Search index request: + $ref: "#/components/examples/semantic-search-request-example" + Index config request: + $ref: "#/components/examples/semantic-search-with-index-config-request-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/SemanticSearchRepresentation" + examples: + Example: + $ref: "#/components/examples/semantic-search-output-example" + "400": + description: Bad request. + "403": + description: User does not have permission to access. + "422": + description: Unprocessable entity. + parameters: + - name: searchIndexApiNameOrId + in: path + required: true + schema: + type: string + description: | + ID or API Name of the search index. + + **Available Version:** 60.0 + /ssot/segments: + get: + summary: Get segments + tags: + - Segments + description: | + Get segments in Data 360. + + >**Important:** + >For this endpoint, authorize using the Core Salesforce token instead of the CDP token. + + **Available Version:** 55.0 + parameters: + - name: batchSize + in: query + description: | + 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 + schema: + type: integer + - name: dataspace + in: query + description: | + 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 + schema: + type: string + - name: filters + in: query + schema: + type: string + description: | + 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. + + These values are supported: + - `LastPublishedEndDateTime` - Not present in the output type. Indicates the end date and time when the segment was last published. Use only the `!=` operator with this value. + - `MarketSegmentType` - Matches field `segmentType`. + - `Name` - Matches field `displayName`. + - `SegmentOn` - Matches field `segmentOnApiName`. + - `SegmentStatus` - Matches field `segmentStatus`. + + These operators are supported: + - `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. + + These are examples of filter parameter specifications: + - `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 + - name: offset + in: query + description: | + Number of segments to skip before returning results. If unspecified, no segments are skipped. + + **Available Version:** 56.0 + schema: + type: integer + - name: orderby + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentContainerOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-segments-output-example" + post: + summary: Create segment + tags: + - Segments + description: | + 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: + - name: dataspace + in: query + description: | + 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 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentInputRepresentation" + examples: + Daily publish segment request: + $ref: "#/components/examples/create-daily-publish-segment-input-example" + Weekly publish segment request: + $ref: "#/components/examples/create-weekly-publish-segment-input-example" + Monthly publish segment request: + $ref: "#/components/examples/create-monthly-publish-segment-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentOutputRepresentation" + examples: + Daily publish segment response: + $ref: "#/components/examples/create-daily-publish-segment-output-example" + Weekly publish segment response: + $ref: "#/components/examples/create-weekly-publish-segment-output-example" + Monthly publish segment response: + $ref: "#/components/examples/create-monthly-publish-segment-output-example" + "400": + description: | + Missing argument, parse error, or illegal query parameter value. + + For example: + - Invalid segment type. + - *developerName* or *displayName* is empty. + "409": + description: Segment already exists. + /ssot/segments/{segmentApiNameOrId}: + get: + summary: Get segment + tags: + - Segments + description: | + Get a segment. + + **Available Version:** 56.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentContainerOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-segment-output-example" + parameters: + - name: segmentApiNameOrId + in: path + required: true + schema: + type: string + description: | + API name or ID of the segment + + **Available Version:** 65.0 + /ssot/segments/{segmentApiName}: + delete: + summary: Delete segment + tags: + - Segments + description: | + Delete a segment in Data 360. + + **Available Version:** 56.0 + responses: + "204": + description: Success + patch: + summary: Update segment + tags: + - Segments + description: | + 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:** `` + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentInputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-segment-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/update-segment-output-example" + parameters: + - name: segmentApiName + in: path + required: true + schema: + type: string + description: | + Name of the segment API. + + **Available Version:** 56.0 + /ssot/segments/{segmentApiName}/actions/count: + post: + summary: Count segment + tags: + - Segments + description: | + Trigger a segment count on demand. + + **Available Version:** 61.0 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentActionInputRepresentation" + examples: + Example: + $ref: "#/components/examples/count-segment-input-example" + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentActionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/count-segment-output-example" + parameters: + - name: segmentApiName + in: path + required: true + schema: + type: string + description: | + Name of the segment API. + + **Available Version:** 61.0 + /ssot/segments/{segmentApiName}/actions/deactivate: + post: + summary: Deactivate segment by name + tags: + - Segments + description: | + Deactivate a segment on demand by API name. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentActionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/deactivate-segment-output-example" + parameters: + - name: segmentApiName + in: path + required: true + schema: + type: string + description: | + Name of the segment API. + + **Available Version:** 59.0 + /ssot/segments/{segmentApiName}/members: + get: + summary: Get segment members + tags: + - Segments + description: | + Get segment members in Data 360. + + **Available Version:** 58.0 + parameters: + - name: fields + in: query + description: | + 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 + schema: + type: array + items: + type: string + - name: filters + in: query + description: | + 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 + schema: + type: string + - name: limit + in: query + description: | + Maximum number of rows to return from `1` through `1000`. If unspecified, the default number of rows is `100`. + + **Available Version:** 58.0 + schema: + type: integer + - name: offset + in: query + description: | + Number of rows to skip before returning results. If unspecified, no rows are skipped. + + **Available Version:** 58.0 + schema: + type: integer + - name: orderBy + in: query + description: | + 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 + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentMemberOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/get-segment-members-output-example" + parameters: + - name: segmentApiName + in: path + required: true + schema: + type: string + description: | + Name of the segment API. + + **Available Version:** 58.0 + /ssot/segments/{segmentId}/actions/deactivate: + post: + summary: Deactivate segment by ID + tags: + - Segments + description: | + Deactivate a segment on demand by ID. + + **Available Version:** 59.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentActionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/deactivate-segment-output-example" + parameters: + - name: segmentId + in: path + description: | + ID of the segment. + + **Available Version:** 59.0 + required: true + schema: + type: string + /ssot/segments/{segmentId}/actions/publish: + post: + summary: Publish segment + tags: + - Segments + description: | + Publish a segment in Data 360. This `POST` endpoint doesn't accept request parameters or a request body. + + **Available Version:** 58.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpSegmentActionOutputRepresentation" + examples: + Example: + $ref: "#/components/examples/publish-segment-output-example" + parameters: + - name: segmentId + in: path + required: true + schema: + type: string + description: | + ID of the segment. + + **Available Version:** 58.0 + /ssot/universalIdLookup/{entityName}/{dataSourceId}/{dataSourceObjectId}/{sourceRecordId}: + get: + summary: Lookup universal ID + tags: + - Universal ID Lookup + description: | + Look up objects by source ID in Data 360. + + **Available Version:** 54.0 + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/CdpQueryDataOutputRepresentation" + parameters: + - name: sourceRecordId + in: path + required: true + schema: + type: string + description: | + ID of the source record. + + **Available Version:** 54.0 + - name: dataSourceId + in: path + required: true + schema: + type: string + description: | + The name of the bridge table entity. + + **Available Version:** 54.0 + - name: dataSourceObjectId + in: path + required: true + schema: + type: string + description: | + ID of the data source. + + **Available Version:** 54.0 + - name: entityName + in: path + required: true + schema: + type: string + description: | + ID of the data source object. + + **Available Version:** 54.0 +components: + schemas: + AbstractBucketAlgorithmRepresentation: + title: Abstract Bucket Algorithm Output + description: Represents a bucket algorithm. + type: object + properties: + type: + description: | + Algorithm type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - TypographicClustering + type: string + AccountEngagementConnectionRepresentation: + title: Account Engagement Connection Output + description: Represents an Account Engagement connector. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + modules: + description: | + List of Steaming app modules. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/ConnectionModuleConfigRepresentation" + sourceId: + description: | + Source ID of an Account Engagement connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + tenantSpecificEndpoint: + description: | + Tenant-specific endpoint of an Account Engagement connector. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + ActivationAdditionalAttributesConfigInputRepresentation: + title: Activation Additional Attributes Config Input + description: Represents the additional attributes configuration for the market + segment activation input. + type: object + properties: + activationPlatformAttrId: + description: | + Activation platform attribute ID. + + **Available Version:** 60.0 + type: string + dataSourceType: + description: | + Type of the data source. + + **Available Version:** 60.0 + type: string + entityName: + description: | + List of records in an Audience DMO. + + **Available Version:** 60.0 + type: string + externalPlatformAttributeName: + description: | + Attribute destination name for an external platform. + + **Available Version:** 64.0 + type: string + filterExpression: + description: | + Attribute filter expression. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AttributeFilterExpressionInputRepresentation" + isRolluppable: + description: | + Indicates whether the attribute can roll up (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + label: + description: | + Label of the attribute. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the attribute. + + **Available Version:** 60.0 + type: string + preferredName: + description: | + Preferred name of the attribute. + + **Available Version:** 60.0 + type: string + queryPathConfig: + description: | + Query path from the `activateOn` entity to the additional attribute entity. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + referenceAttributeName: + description: | + Developer name of the reference attribute. + + **Available Version:** 60.0 + type: string + source: + description: | + Data export source type. + + **Available Version:** 60.0 + type: string + enum: + - Direct + - Related + type: + description: | + Data export attribute type. + + **Available Version:** 60.0 + type: string + enum: + - Computed_Dimension + - Computed_Measure + - Model + - Model_Related + - Non_Aggregatable_Computed_Measure + ActivationAttributeRepresentation: + title: Activation Attribute Output + description: Represents the activation attribute output. + type: object + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + activationPlatformAttrId: + description: | + Activation platform ID for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + attributeLabel: + description: | + Label for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dataSourceType: + description: | + Data source type for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + entityName: + description: | + Entity name for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + externalPlatformAttributeName: + description: | + Attribute destination name for an external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + filterExpression: + description: | + Filter expression for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AttributeFilterExpressionRepresentation" + preferredName: + description: | + Preferred name for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + queryPathConfig: + description: | + Query path for the activation attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + referenceAttributeName: + description: | + Name for the activation's reference attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + source: + description: | + Activation attribute attributeSource. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Direct + - Related + type: string + type: + description: | + Type of the activation attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Computed_Dimension + - Computed_Measure + - Model + - Model_Related + - Non_Aggregatable_Computed_Measure + type: string + ActivationAttributesConfigRepresentation: + title: Activation Attributes Config Output + description: Represents the activation attributes configuration. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributes: + description: | + Attributes for the activation. + type: array + items: + $ref: "#/components/schemas/ActivationAttributeRepresentation" + ActivationCollectionRepresentation: + title: Activation Collection Output + description: Represents a collection of activations. + type: object + properties: + activations: + description: | + List of all activations. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationRepresentation" + batchSize: + description: | + Number of results returned. Default is 20. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + offset: + description: | + Number of records to skip for the next request. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + orderByExpression: + description: | + Sort order for the result set. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ActivationContactPointFieldConfigRepresentation: + title: Activation Contact Point Field Config Output + description: Represents the activation contact point field configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeId: + description: | + Attribute ID for the contact point. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + preferredName: + description: | + Preferred name for the contact point. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + referenceAttributeName: + description: | + Developer name for the reference attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + ActivationContactPointInputRepresentation: + title: Activation Contact Point Input + description: Represents the activation contact point input. + type: object + properties: + attributesConfig: + description: | + Attributes for the contact point. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ContactPointAttributesConfigInputRepresentation" + entityName: + description: | + Entity name for the contact point. + + **Available Version:** 60.0 + type: string + externalPlatformHashMethod: + description: | + External platform hash method for the contact point. + + **Available Version:** 60.0 + type: string + filterExpression: + description: | + Filter expression for the contact point. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ContactPointFilterExpressionInputRepresentation" + queryPathConfig: + description: | + Query path configuration list. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + sourcesConfig: + description: | + Source configurations for the contact point. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ContactPointSourcesConfigInputRepresentation" + type: + description: | + Type of contact point. + + **Available Version:** 60.0 + enum: + - Email + - Maid + - Ott + - Phone + - Push + - SubscriberKeyEmail + - SubscriberKeyPhone + - WhatsApp + type: string + required: + - attributesConfig + - entityName + - externalPlatformHashMethod + - filterExpression + - queryPathConfig + - sourcesConfig + - type + ActivationContactPointsFieldConfigRepresentation: + title: Activation Contact Points Field Config Output + description: Represents the activation contact point field configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + contactPointFields: + description: | + Fields for the contact point. + type: array + items: + $ref: "#/components/schemas/ActivationContactPointFieldConfigRepresentation" + ActivationContactPointSourceConfigRepresentation: + title: Activation Contact Point Source Config Output + description: Represents the activation contact point source configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataSourceId: + description: | + ID of the data source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dataSourceName: + description: | + Name of the data source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dataSourcePreference: + description: | + Preference of the data source. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - ContactPointPrefAny + - ContactPointPrefBusiness + - ContactPointPrefPersonal + - ContactPointPrefPrimary + type: string + dataSourcePriority: + description: | + Priority of the data source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + ActivationContactPointsSourceConfigRepresentation: + title: Activation Contact Points Source Config Output + description: Represents the activation contact points source configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + contactPointSources: + description: | + Contact point sources for the activation. + type: array + items: + $ref: "#/components/schemas/ActivationContactPointSourceConfigRepresentation" + ActivationDataRepresentation: + title: Activation Data Output + description: Represents an activation record in an Audience data model object + (DMO). + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + activatedEntityFqk: + description: | + Fully Qualified Key (FQK) of the activated entity. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + activatedOnId: + description: | + ActivateOn entity ID, such as Individual.Id or Unified Individual.Id. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + activationRecord: + description: | + Activated attributes payload as JSON BLOB + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + deltaType: + description: | + Activation delta type + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - "[object Object]" + - "[object Object]" + - "[object Object]" + - "[object Object]" + type: string + publishDate: + description: | + Date that the activation was published. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + segmentId: + description: | + Unique ID for each segment. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + segmentOnId: + description: | + Key identifier based on the SegmentOn entity. Same as Activated-entity-id when ActivateOn = SegmentOn. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + segmentedEntityFqk: + description: | + Fully Qualified Key of the segmented entity. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + type: object + ActivationDataSourceConfigInputRepresentation: + title: Activation Data Source Config Input + description: Represents the configuration input for an activation data source. + type: object + properties: + dataSources: + description: | + List of data sources for the activation. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataSourceNameConfigInputRepresentation" + required: + - dataSources + ActivationDataSourceConfigRepresentation: + title: Activation Data Source Config Output + description: Represents the configuration output for an activation data source. + type: object + properties: + name: + description: | + Name of the activation data source. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + ActivationDataSourcesRepresentation: + title: Activation Data Sources Output + description: Represents the activation data source output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataSources: + description: | + Data sources for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ActivationDataSourceConfigRepresentation" + ActivationDefinitionInputRepresentation: + title: Activation Definition Input + description: Represents the activation definition input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + activationMappingSchema: + description: | + Type of identifier to use for activation audience matching, such as `PII` or `ANON`. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + activationTargetName: + description: | + Name for the activation target. Either activationTargetName or dataExportDefinitionId must be present. + + **Available Version:** 60.0 + type: string + activationTargetSubjectConfig: + description: | + Subject configuration for the activation target. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationTargetSubjectConfigInputRepresentation" + activationType: + description: | + Type of activation. If unspecified, defaults to `Segment`. + + **Available Version:** 66.0 + type: string + enum: + - ApiTriggered + - Segment + attributeLimitingExpressionConfig: + description: | + Limiting expression configuration for the activation. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/AttributeLimitingExpressionInputConfigRepresentation" + attributesConfig: + description: | + Additional attributes for the activation. The `activateOn` attribute must be present. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AttributesConfigInputRepresentation" + contactPointsConfig: + description: | + Contact points configuration for the activation target. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ContactPointConfigInputRepresentation" + curatedEntity: + description: | + Curated entity details for the activation. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CuratedEntityInputRepresentation" + customerFileSource: + description: | + Customer file source for the activation target. + + **Available Version:** 60.0 + type: string + enum: + - FirstAndThirdParty + - FirstParty + - ThirdParty + dataExportDefinitionId: + description: | + Activation target ID for the activation. Either activationTargetName or dataExportDefinitionId must be present. + + **Available Version:** 60.0 + type: string + dataSourcesConfig: + description: | + Data source configuration for the activation. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ActivationDataSourceConfigInputRepresentation" + dataSpaceName: + description: | + Name of the data space for the activation. + + **Available Version:** 60.0 + type: string + description: + description: | + Description of the activation. + + **Available Version:** 60.0 + type: string + directDmoFiltersConfig: + description: | + Direct DMO filters. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DMOFilterConfigInputRepresentation" + limitValue: + description: | + Audience limit value for the activation. + + **Available Version:** 63.0 + type: integer + marketSegmentId: + description: | + 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 + type: string + name: + description: | + Name of the activation. + + **Available Version:** 60.0 + type: string + refreshType: + description: | + Indicates the refresh type for the activation, (`Full` or `Incremental`). + + **Available Version:** 60.0 + type: string + relatedDmoFiltersConfig: + description: | + DMO filters on related attributes for the activation. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DMOFilterConfigInputRepresentation" + segmentApiName: + description: | + Developer name of the segment. Either marketSegmentId or segmentApiName must be present. Exclude this property for `ApiTriggered` activation types. + + **Available Version:** 60.0 + type: string + shouldExcludeDeletes: + description: | + Indicates whether to exclude records removed since the last refresh (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + shouldExcludeUpdates: + description: | + Indicates whether to exclude records modified since the last refresh (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + sourceDmoName: + description: | + Developer name of the source DMO. Required for `ApiTriggered` activation types. Exclude this property for `Segment` activation types. + + **Available Version:** 66.0 + type: string + staticDataConfig: + description: | + Configuration of static data, which adds metadata or campaign details in the output. For example, `campaignId` or `campaignName`. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/StaticDataConfigInputRepresentation" + required: + - refreshType + ActivationExternalPlatformAttributeConfigRepresentation: + title: Activation External Platform Attribute Config Output + description: Represents the attribute configuration for an activation external platform. + type: object + properties: + attributes: + description: | + List of external platform attributes. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/ActivationExternalPlatformAttributeRepresentation" + ActivationExternalPlatformAttributeRepresentation: + title: Activation External Platform Attribute Output + description: Represents an attribute for an activation external platform. + type: object + properties: + destinationName: + description: | + Name of the external platform attribute's destination. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + displayName: + description: | + Display name of the external platform attribute. Applicable only for ecoSystem external platforms. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + ActivationExternalPlatformCollectionRepresentation: + title: Activation External Platform Collection Output + description: Represents a collection of activation external platforms. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + platforms: + description: | + List of activation external platforms. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/ActivationExternalPlatformRepresentation" + ActivationExternalPlatformRepresentation: + title: Activation External Platform Output + description: Represents an activation external platform. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeConfig: + description: | + Configuration of the external platform attributes. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/ActivationExternalPlatformAttributeConfigRepresentation" + creationType: + description: | + Creation type for the external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Json + - Manual + keyPrefixName: + description: | + Namespace prefix of the external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + privacyType: + description: | + Privacy type for the external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - NotApplicable + - ServiceProvider + - ThirdParty + - UpdateFailed + status: + description: | + Status of the external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Active + - Error + - Inactive + - Processing + type: + description: | + Platform type for the external platform. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Advertising + - Analytics + - Marketing + - Publishing + - Technology + ActivationPublishActionInputRepresentation: + title: Activation Publish Action Input + type: object + description: Represents a Batch DMO activation publish job input. + properties: + fullRefresh: + description: | + 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 + type: boolean + ActivationPublishActionRepresentation: + title: Activation Publish Action Output + description: Represents output for a Batch DMO activation publish job. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + properties: + publishStatus: + description: | + Publish status of the activation. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Error + - NotSupported + - PartnerError + - PartnerProcessing + - Publishing + - Queued + - SegmentError + - Skipped + - Success + ActivationRepresentation: + title: Activation Output + description: Represents an activation. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + activationDefinitionId: + description: | + ID of the activation definition. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + activationMappingSchema: + description: | + Type of identifier to use for activation audience matching, such as `PII` or `ANON`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + activationRecordSchema: + description: | + JSON schema representing the activation JSON payload in the activationRecord field of the AudienceDMO. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + activationTarget: + description: | + Activation target details. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationTargetRepresentation" + activationTargetSubjectConfig: + description: | + Activation target subject for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationTargetSubjectRepresentation" + activationType: + description: | + Type of activation. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - ApiTriggered + - Segment + attributeLimitingExpressionConfig: + description: | + Limiting expression configuration for the activation. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/AttributeLimitingExpressionConfigRepresentation" + attributesConfig: + description: | + Attributes for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationAttributesConfigRepresentation" + contactPointsConfig: + description: | + Contact points for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ContactPointsConfigRepresentation" + curatedEntity: + description: | + Curated entity object details for the activation. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + customerFileSource: + description: | + Customer file source of the activation platform. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - First_And_Third_Party + - First_Party + - Third_Party + type: string + dataSourcesConfig: + description: | + Data sources for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ActivationDataSourcesRepresentation" + dataSpaceName: + description: | + Data space name for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + description: + description: | + Description of the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + developerName: + description: | + Developer name for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + directDmoFiltersConfig: + description: | + Direct DMO filters for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DmoFiltersConfigRepresentation" + enabled: + description: | + Indicates whether the activation is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + historyAudienceDmoApiName: + description: | + API name for the history audience DMO. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + historyAudienceDmoLabel: + description: | + Name of the history audience DMO. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + isEnabled: + description: | + Indicates whether the activation is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + lastPublishDate: + description: | + Last publish timestamp of the activation. Use the format `yyyy-mm-dd`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + lastPublishStatus: + description: | + Last publish status of the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Error + - Partner_Error + - Partner_Processing + - Publishing + - Queued + - Segment_Error + - Skipped + - Success + type: string + lastPublishStatusErrorMsg: + description: | + Error message encountered during last publish. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + latestAudienceDmoApiName: + description: | + API name for the latest audience DMO. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + latestAudienceDmoLabel: + description: | + Name for the latest audience DMO. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + latestAudienceDmoLastRunTimestamp: + description: | + Timestamp of the last run for the latest audience DMO. Use the format `yyyy-mm-dd`. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + limitValue: + description: | + Audience limit value for the activation. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + marketSegmentId: + description: | + Segment ID of the activation. Returned for `Segment` type activations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + membershipName: + description: | + Membership name of the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + queryPathConfig: + description: | + Query path for the activation target. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + refreshType: + description: | + Refresh type of the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Full_Refresh + - Incremental + type: string + relatedDmoFiltersConfig: + description: | + DMO filters on related attributes for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DmoFiltersConfigRepresentation" + segmentApiName: + description: | + Segment API name. Returned for `Segment` type activations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + segmentId: + description: | + Segment ID of the activation. Returned for `Segment` type activations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + shouldExcludeDeletes: + description: | + Indicates whether to exclude records removed since the last refresh (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + shouldExcludeUpdates: + description: | + Indicates whether to exclude records modified since the last refresh (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + sourceDmoName: + description: | + Developer name of the source DMO. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + staticDataConfig: + description: | + Static data configuration for the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/StaticDataConfigRepresentation" + status: + description: | + Status of the activation. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Processing + - Error + - Inactive + type: string + required: + - attributesConfig + - queryPathConfig + - activationTarget + - contactPointsConfig + - lastPublishStatus + - curatedEntity + - refreshType + - dataSourcesConfig + - shouldExcludeDeletes + - activationTargetSubjectConfig + - dataSpaceName + ActivationTargetCollectionRepresentation: + title: Activation Target Collection Output + description: Activation target container. + type: object + properties: + activationTargets: + description: | + List of all activation targets. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ActivationTargetRepresentation" + offset: + description: | + Number of records skipped before returning results. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + batchSize: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + orderByExpression: + description: | + Expression to define the sort order of records. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ActivationTargetInputRepresentation: + title: Activation Target Input + description: Represents the activation target input. + type: object + properties: + connector: + description: | + Details of the connector used for the activation target. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataConnectorInputRepresentation" + dataSpaceName: + description: | + Name of the data space for the activation target. + + **Available Version:** 60.0 + type: string + description: + description: | + Description for the activation target. + + **Available Version:** 60.0 + type: string + isCappingEnabled: + description: | + Indicates whether communication capping is enabled (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + egressProperties: + description: | + Egress properties for the activation target, which are applicable only for file-based activation targets. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/EgressPropertiesInputRepresentation" + name: + description: | + Name of the activation target. + + **Available Version:** 60.0 + type: string + platformType: + description: | + Platform type for the activation target. + + **Available Version:** 60.0 + enum: + - AmazonS3 + - AzureBlob + - DataCloud + - ExternalPlatform + - GoogleCloudStorage + - SalesforceMarketingCloud + - Sftp + type: string + required: + - dataSpaceName + - name + ActivationTargetRepresentation: + title: Activation Target Output + description: Represents a list of all activation targets. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + connector: + description: | + Details about the connector that is used for the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataConnectorRepresentation" + dataSpaceName: + description: | + Data space name for this activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + description: + description: | + Description of the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + egressProperties: + description: | + Egress properties for the activation target, which are applicable only for file-based activation targets. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/EgressPropertiesRepresentation" + historyAudienceDmoApiName: + description: | + API name for the history audience DMO. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + historyAudienceDmoLabel: + description: | + Name of the history audience DMO. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + isCappingEnabled: + description: | + Indicates whether communication capping is enabled for the activation (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + isEnabled: + description: | + Indicates whether the activation target is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + latestAudienceDmoApiName: + description: | + API name for the latest audience DMO. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + latestAudienceDmoLabel: + description: | + Name of the latest audience DMO. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + organizationId: + description: | + Organization ID of the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + platformName: + description: | + Platform name for the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + platformPrivacyType: + description: | + Platform privacy type for the activation target. Derived from Activation Platform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + platformType: + description: | + Platform type for the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - AmazonS3 + - AzureBlob + - DataCloud + - ExternalPlatform + - GoogleCloudStorage + - SalesforceMarketingCloud + - Sftp + type: string + status: + description: | + Target status of the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Processing + - Error + - Inactive + type: string + required: + - status + ActivationTargetSubjectConfigInputRepresentation: + title: Activation Target Subject Config Input + description: Represents the activation target subject configuration input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + developerName: + description: | + Developer name of activation target subject configuration. + + **Available Version:** 60.0 + type: string + queryPathConfig: + description: | + Path of the activation target subject configuration. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + ActivationTargetSubjectRepresentation: + title: Activation Target Subject Output + description: Represents the activation target subject output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + developerName: + description: | + Developer name for the activation target subject. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + masterLabel: + description: | + Master label for the activation target subject. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + queryPathConfig: + description: | + Query path for the activation target. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + AggregateInputRepresentation: + title: Aggregate Input + description: Represents the input for an aggregation. + type: object + properties: + action: + description: | + Action to execute on the aggregation. + + **Available Version:** 60.0 + enum: + - Avg + - Count + - Maximum + - Median + - Minimum + - StdDev + - StdDevP + - Sum + - Unique + - Var + - VarP + type: string + label: + description: | + Label of field that is created after the aggregation. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field that is created after the aggregation. + + **Available Version:** 60.0 + type: string + source: + description: | + Name of the field that is the source of the aggregation. + + **Available Version:** 60.0 + type: string + required: + - action + - label + - name + - source + AggregateNodeInputRepresentation: + title: Aggregate Node Input + description: Represents an aggregate data node input in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AggregateParametersInputRepresentation" + required: + - parameters + AggregateNodeRepresentation: + title: Aggregate Node Output + description: Represents an aggregate data node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AggregateParametersRepresentation" + AggregateParametersInputRepresentation: + title: Aggregate Parameters Input + description: Represents the aggregate node parameters input. + type: object + properties: + aggregations: + description: | + Aggregations. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AggregateInputRepresentation" + groupings: + description: | + Groupings. + + **Available Version:** 60.0 + type: array + items: + type: string + nodeType: + description: | + Determines which fields are required. Hierarchical requires: `parentField` and `selfField`. `percentageField` is optional. Standard requires `aggregations`. + + **Available Version:** 60.0 + enum: + - Hierarchical + - Standard + type: string + parentField: + description: | + Defines the parent field in the hierarchical aggregate mode. + + **Available Version:** 60.0 + type: string + percentageField: + description: | + Percentage field. + + **Available Version:** 60.0 + type: string + pivot_v2: + description: | + Pivot v2. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PivotV2InputRepresentation" + selfField: + description: | + Defines the self field in the hierarchical aggregate mode. + + **Available Version:** 60.0 + type: string + required: + - aggregations + - groupings + - nodeType + - parentField + - percentageField + - pivot_v2 + - selfField + AggregateParametersRepresentation: + title: Aggregate Parameters Output + description: Represents aggregate node parameters. + type: object + properties: + aggregations: + description: | + Aggregations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AggregateRepresentation" + groupings: + description: | + Groupings. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + nodeType: + description: | + Aggregate type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Hierarchical + - Standard + type: string + parentField: + description: | + Parent field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + percentageField: + description: | + Percentage field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + pivot_v2: + description: | + Pivot V2. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PivotV2Representation" + selfField: + description: | + Self field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + AggregateRepresentation: + title: Aggregate Output + description: Represents an aggregate. + type: object + properties: + action: + description: | + Aggregate action. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Avg + - Count + - Maximum + - Median + - Minimum + - StdDev + - StdDevP + - Sum + - Unique + - Var + - VarP + type: string + label: + description: | + Aggregate label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Aggregate name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + source: + description: | + Aggregate source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + AmazonMSKRouteDetailsInputRepresentation: + title: Amazon MSK Route Details Input + description: | + Input representation of route details for the cloud service used by the Private Network Route: Amazon Managed Streaming for Apache Kafka (MSK). + allOf: + - $ref: "#/components/schemas/RouteDetailsInputRepresentation" + - type: object + properties: + brokerEndpoints: + description: | + Endpoint of the Amazon MSK broker. + + **Available Version:** 65.0 + type: array + items: + type: string + required: + - brokerEndpoints + AmazonMSKRouteDetailsRepresentation: + title: Amazon MSK Route Details Output + description: | + Represents route details for the cloud service used by the Private Network Route: Amazon Managed Streaming for Apache Kafka (MSK). + allOf: + - $ref: "#/components/schemas/RouteDetailsRepresentation" + - type: object + properties: + brokerEndpoints: + description: | + Endpoint of the Amazon MSK broker. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: array + items: + type: string + required: + - brokerEndpoints + AppendMappingInputRepresentation: + title: Append Mapping Input + description: Represents the field mapping input for append. + type: object + properties: + bottom: + description: | + Bottom dataset field. + + **Available Version:** 60.0 + type: string + top: + description: | + Top dataset field. + + **Available Version:** 60.0 + type: string + required: + - bottom + - top + AppendMappingRepresentation: + title: Append Mapping Output + description: Represents field mapping for append. + type: object + properties: + bottom: + description: | + Bottom dataset field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + top: + description: | + Top dataset field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + AppendParametersInputRepresentation: + title: Append Parameters Input + description: Represents the input for append parameters. + type: object + properties: + allowImplicitDisjointSchema: + description: | + Indicates whether to allow disjoint schema merge when automatically mapping + fields (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + columnMappings: + description: | + Map of batch data transform definition nodes. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + fieldMappings: + description: | + Field mappings. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AppendMappingInputRepresentation" + required: + - allowImplicitDisjointSchema + - columnMappings + - fieldMappings + AppendParametersRepresentation: + title: Append Parameters Output + description: Represents append parameters. + type: object + properties: + allowImplicitDisjointSchema: + description: | + Allows disjoint schema merge when automatically mapping + fields (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + columnMappings: + description: | + Column mappings. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + fieldMappings: + description: | + Field mappings. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AppendMappingRepresentation" + AppendV2NodeInputRepresentation: + title: Append V2 Node Input + description: Represents an append data node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AppendParametersInputRepresentation" + required: + - parameters + AppendV2NodeRepresentation: + title: Append V2 Node Output + description: Represents an append data node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AppendParametersRepresentation" + AttributeFilterExpressionInputRepresentation: + title: Attribute Filter Expression Input + description: Represents the attribute filter expression input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + conjunction: + description: | + Filter conjunction. + + **Available Version:** 60.0 + type: string + enum: + - FilterConjunctionAnd + - FilterConjunctionOr + filters: + description: | + Attribute filters. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AttributeFilterInputRepresentation" + AttributeFilterExpressionRepresentation: + title: Attribute Filter Expression Output + description: Represents the activation attribute filter expression output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + conjunction: + description: | + Conjunction for the activation attribute filter expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - FilterConjunctionAnd + - FilterConjunctionOr + type: string + filters: + description: | + Filters for the activation attribute filter expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/AttributeFilterRepresentation" + AttributeFilterInputRepresentation: + title: Attribute Filter Input + description: Represents the attribute filter input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + attributeId: + description: | + ID of the attribute. + + **Available Version:** 60.0 + type: string + attributeName: + description: | + Name of the attribute. + + **Available Version:** 60.0 + type: string + dateUnits: + description: | + Date unit filter. + + **Available Version:** 60.0 + type: string + enum: + - Days + - Months + - Years + operator: + description: | + Operator of the attribute. + + **Available Version:** 60.0 + type: string + type: + description: | + Filter operator type. + + **Available Version:** 60.0 + type: string + enum: + - FilterOperatorDataTypeBoolean + - FilterOperatorDataTypeDate + - FilterOperatorDataTypeDateOnly + - FilterOperatorDataTypeExactlyRelativeDate + - FilterOperatorDataTypeNumber + - FilterOperatorDataTypeRelateToNowDate + - FilterOperatorDataTypeText + value: + description: | + Filter values. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FilterValuesInputRepresentation" + AttributeFilterRepresentation: + title: Attribute Filter Output + description: Represents the attribute filter output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeId: + description: | + ID of the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + attributeName: + description: | + Name of the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dateUnits: + description: | + Date units for the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Days + - Months + - Years + type: string + operator: + description: | + Operator for the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type of the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - FilterOperatorDataTypeBoolean + - FilterOperatorDataTypeDate + - FilterOperatorDataTypeDateOnly + - FilterOperatorDataTypeExactlyRelativeDate + - FilterOperatorDataTypeNumber + - FilterOperatorDataTypeRelateToNowDate + - FilterOperatorDataTypeText + type: string + value: + description: | + Values for the attribute. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FilterValuesRepresentation" + AttributeLimitingExpressionConfigRepresentation: + title: Attribute Limiting Expression Config Output + description: Represents the limiting expression configurations for an activation. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeLimitingExpressions: + description: | + List of an attribute's limiting expressions. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/AttributeLimitingExpressionRepresentation" + AttributeLimitingExpressionInputConfigRepresentation: + title: Attribute Limiting Expression Config Input + description: Represents the limiting expression configuration input for an activation. + type: object + properties: + attributeLimitingExpressions: + description: | + Input list of an attribute's limiting expressions. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/AttributeLimitingExpressionInputRepresentation" + required: + - attributeLimitingExpressions + AttributeLimitingExpressionInputRepresentation: + title: Attribute Limiting Expression Input + description: Represents the limiting expression input for an activation. + type: object + properties: + attributeName: + description: | + Name of the attribute. + + **Available Version:** 63.0 + type: string + entityName: + description: | + Name of the entity. + + **Available Version:** 63.0 + type: string + order: + description: | + Sort order for the filter. + + **Available Version:** 63.0 + enum: + - FilterSortOrderAsc + - FilterSortOrderDesc + type: string + queryPathConfig: + description: | + Query path configuration input. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + type: + description: | + Type of attribute. + + **Available Version:** 63.0 + type: string + required: + - attributeName + - entityName + - order + - queryPathConfig + - type + AttributeLimitingExpressionRepresentation: + title: Attribute Limiting Expression Output + description: Represents a limiting expression for an activation. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeName: + description: | + Name of the attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + entityName: + description: | + Name of the entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + order: + description: | + Sort order for the filter. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - FilterSortOrderAsc + - FilterSortOrderDesc + type: string + queryPathConfig: + description: | + Query path for the attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + AttributesConfigInputRepresentation: + title: Attributes Config Input + description: Represents the configuration input for attributes. + type: object + properties: + attributes: + description: | + Additional attributes for the activation. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ActivationAdditionalAttributesConfigInputRepresentation" + required: + - attributes + AudienceDMOCollectionRepresentation: + title: Audience DMO Collection Output + description: Represents a collection of activation records from Audience data + model objects (DMOs). + type: object + properties: + batchSize: + description: | + Number of results returned. Default is 10000. Max is 49999. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + data: + description: | + List of activation records in an Audience data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/ActivationDataRepresentation" + offset: + description: | + Number of records to skip for the next request. Max is 10 million. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + BaseComparisonInputRepresentation: + title: Base Comparison Input + description: | + Represents the base comparison input. Abstract parent of: + - [Entity Scoped Group Input](?meta=type%3AEntity%2BScoped%2BGroup%2BInput) + - [Logical Comparison Input](?meta=type%3ALogical%2BComparison%2BInput) + - [Primitive Comparison Input](?meta=type%3APrimitive%2BComparison%2BInput) + type: object + properties: + filtersConfig: + description: | + Logical comparison input list wrapper. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TypeAndFilterInputRepresentationConfig" + operator: + description: | + Operator of the comparison. + + **Available Version:** 60.0 + type: string + required: + - filtersConfig + - operator + BaseComparisonRepresentation: + title: Base Comparison Output + description: | + Represents the base comparison output. Abstract parent of: + - [Entity Scoped Group Output](?meta=type%3AEntity%2BScoped%2BGroup%2BOutput) + - [LogicalComparison Output](?meta=type%3ALogical%2BComparison%2BOutput) + - [Primitive Comparison Output](?meta=type%3APrimitive%2BComparison%2BOutput) + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + filters: + description: | + List of logical comparison filters. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TypeAndFilterRepresentation" + operator: + description: | + Operator. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + BaseConnectionFieldRepresentation: + title: Base Connection Field Output + description: | + Abstract superclass that represents the output for a connection field. Abstract parent of: + - [Connection Field Output](?meta=type%3AConnection%2BField%2BOutput) + - [CRM Connection Field Output](?meta=type%3ACRM%2BConnection%2BField%2BOutput) + type: object + properties: + # Merged from CrmConnectionFieldRepresentation. + creationType: + description: | + For a CRM connection field, the creation type of the field. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Standard + format: + description: | + Date format of the field. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + # Merged from CrmConnectionFieldRepresentation. + isCalculated: + description: | + 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 + type: boolean + + isRequired: + description: | + Indicates whether the field is required (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + # Merged from CrmConnectionFieldRepresentation. + label: + description: | + 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 + type: string + name: + description: | + Name of the Data 360 source field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + originalType: + description: | + Data type of the source field. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + type: + description: | + Data type of the field. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Boolean + - Currency + - Date + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Unsupported + - Url + type: string + BaseConnectionObjectRepresentation: + title: Base Connection Object Output + description: Abstract superclass that represents a source object for a connection. + type: object + properties: + name: + description: | + Name of the source object for the connection. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + BatchActionRepresentation: + title: Batch Action Output + description: Batch actions. + type: object + properties: + cancelAction: + description: | + URL to cancel the action. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + refreshStatusAction: + description: | + URL to refresh the status of the action. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + retryAction: + description: | + URL to retry the action. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + runAction: + description: | + URL to run the action. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + BucketFieldInputRepresentation: + title: Bucket Field Input + description: Represents bucket node field. + type: object + properties: + label: + description: | + Label. + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Available Version:** 60.0 + type: string + type: + description: | + Field type. + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + required: + - label + - name + - type + BucketFieldRepresentation: + title: Bucket Field Output + description: Bucket node field representation. + type: object + properties: + bucketsSetup: + description: | + Buckets setup. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BucketSetupRepresentation" + label: + description: | + Label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Field type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + BucketNodeInputRepresentation: + title: Bucket Node Input + description: Represents a bucket node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BucketParametersInputRepresentation" + required: + - parameters + BucketNodeRepresentation: + title: Bucket Node Output + description: Bucket node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BucketParametersRepresentation" + type: object + BucketParametersInputRepresentation: + title: Bucket Parameters Input + description: Represents a bucket node. + type: object + properties: + fields: + description: | + List of fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BucketFieldInputRepresentation" + required: + - fields + BucketParametersRepresentation: + title: Bucket Parameters Output + description: Bucket node representation. + type: object + properties: + fields: + description: | + Fields + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BucketFieldRepresentation" + BucketRepresentation: + title: Bucket Output + description: Abstract bucket representation. + type: object + properties: + value: + description: | + Value. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + BucketSetupRepresentation: + title: Bucket Setup Output + description: Bucket setup representation. + type: object + properties: + algorithm: + description: | + Bucketing algorithm. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/AbstractBucketAlgorithmRepresentation" + buckets: + description: | + Buckets. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BucketRepresentation" + defaultBucketValue: + description: | + Default bucket value. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + isPassthroughEnabled: + description: | + Indicates whether passthrough is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + nullBucketValue: + description: | + Null bucket value. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceField: + description: | + Source fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BucketSourceFieldRepresentation" + BucketSourceFieldRepresentation: + title: Bucket Source Field Output + description: Measure bucket field representation. + type: object + properties: + name: + description: | + Name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + CdpActionResponseBaseRepresentation: + title: Action Response Base Output + description: | + Represents the base response for an action. Abstract parent of: + - [Calculated Insight Standard Action Response Output](?meta=type%3ACalculated%2BInsight%2BStandard%2BAction%2BResponse%2BOutput) + - [Connection Command Action Output](?meta=type%3AConnection%2BCommand%2BAction%2BOutput) + - [Connection Schema Action Response Output](?meta=type%3AConnection%2BSchema%2BAction%2BResponse%2BOutput) + - [Connection Test Action Output](?meta=type%3AConnection%2BTest%2BAction%2BOutput) + - [Data Graph Action Response Output](?meta=type%3AData%2BGraph%2BAction%2BResponse%2BOutput) + - [Data Stream Action Response Output](?meta=type%3AData%2BStream%2BAction%2BResponse%2BOutput) + - [Data Transform Action Response Output](?meta=type%3AData%2BTransform%2BAction%2BResponse%2BOutput) + - [Segment Action Output](?meta=type%3ASegment%2BAction%2BOutput) + type: object + properties: + errors: + description: | + List of errors that resulted from the action. + + **Filter Group:** Big + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpErrorRepresentation" + success: + description: | + Indicates whether the action was initiated successfully (`true`) or not (`false`). + + **Filter Group:** Big + + **Available Version:** 57.0 + type: boolean + CdpAssetBaseInputRepresentation: + title: Asset Base Input + type: object + description: Represents a base asset. + properties: + id: + description: | + ID of the asset. + + **Available Version:** 58.0 + type: string + name: + description: | + Name of the asset. + + **Available Version:** 58.0 + type: string + namespace: + description: | + Namespace of the asset. + + **Available Version:** 58.0 + type: string + CdpAssetBaseRepresentation: + title: Asset Base Output + description: Represents a base asset. + type: object + properties: + createdBy: + description: | + Who or what created the model configuration, artifact, or other asset. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpUserRepresentation" + createdDate: + description: | + Date that the artifact was created. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + id: + description: | + 18-character ID of the asset. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + label: + description: | + 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 + type: string + lastModifiedBy: + description: | + Who or what last modified the asset. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpUserRepresentation" + lastModifiedDate: + description: | + When the asset was last modified. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the asset. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + namespace: + description: | + 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 + type: string + url: + description: | + 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 + type: string + CdpAssetReferenceInputRepresentation: + title: Asset Reference Input + description: Input representation for an asset reference. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + CdpAssetReferenceRepresentation: + title: Asset Reference Output + description: Represents an asset reference. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + CdpCalculatedInsightCollectionDataRepresentation: + title: Calculated Insight Collection Data Output + description: Representation for calculated insight collection data. + type: object + properties: + count: + description: | + Number of results returned in the page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + currentPageToken: + description: | + Token identifying the current page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + currentPageUrl: + description: | + Connect REST API URL identifying the current page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + items: + description: | + List of calculated insights. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpCalculatedInsightRepresentation" + nextPageToken: + description: | + Token identifying the next page, or `null` if there isn't a next page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + nextPageUrl: + description: | + Connect REST API URL identifying the next page, or `null` if there isn't a next page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + previousPageToken: + description: | + Token identifying the previous page, or `null` if there isn't a previous page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + previousPageUrl: + description: | + Connect REST API URL identifying the previous page, or `null` if there isn't a previous page. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + total: + description: | + Total row count of calculated insights. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + CdpCalculatedInsightCollectionRepresentation: + title: Calculated Insight Collection Output + description: Container of a calculated insights page. + type: object + properties: + collection: + description: | + Collection of calculated insights. + + **Filter Group:** Small + + **Available Version:** 57.0 + allOf: + - $ref: "#/components/schemas/CdpCalculatedInsightCollectionDataRepresentation" + CdpCalculatedInsightDataSourceRepresentation: + title: Calculated Insight Data Source Output + description: Represents a calculated insight data source. + type: object + properties: + sourceApiName: + description: Source Api Name + type: string + type: + description: Type + type: string + CdpCalculatedInsightDimensionRepresentation: + title: Calculated Insight Dimension Output + description: Represents a calculated insight dimension. + type: object + properties: + apiName: + description: Api Name + type: string + creationType: + description: Creation Type + type: string + dataSource: + description: Data Source + allOf: + - $ref: "#/components/schemas/CdpCalculatedInsightDataSourceRepresentation" + dataType: + description: Data Type + type: string + dateGranularity: + description: Date Granularity + type: string + displayName: + description: Display Name + type: string + fieldRole: + description: Field Role + type: string + formula: + description: Formula + type: string + CdpCalculatedInsightInputRepresentation: + title: Calculated Insight Input + description: Input representation for a calculated insight. + type: object + properties: + apiName: + description: | + API name of the calculated insight with suffix __cio. Required for POST. Optional for PATCH. + + **Available Version:** 57.0 + type: string + createdFromPackage: + description: | + Specifies whether the calculated insight was created from an installed package (`true`) or not (`false`). + + **Available Version:** 57.0 + type: boolean + dataSpaceName: + description: | + Name of the data space. + + **Available Version:** 57.0 + type: string + definitionType: + description: | + Definition type of the calculated insight. Required for POST. Optional for PATCH. + + **Available Version:** 57.0 + enum: + - CALCULATED_METRIC + - EXTERNAL_METRIC + - STREAMING_METRIC + type: string + description: + description: | + Calculated insight description. + + **Available Version:** 57.0 + type: string + displayName: + description: | + Calculated insight display name. Required for POST. Optional for PATCH. + + **Available Version:*** 57.0 + type: string + draft: + description: | + Specifies whether to save the calculated insight as draft (`true`) or not (`false`). + + **Available Version:** 57.0 + type: boolean + expression: + description: | + Calculated insight ANSI SQL expression. Required for POST. Optional for PATCH. + + **Available Version:** 57.0 + type: string + packagedCalculatedInsightApiName: + description: | + API name of the packaged calculated insight. + + **Available Version:** 57.0 + type: string + publishScheduleEndDate: + description: | + 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 + type: string + publishScheduleInterval: + description: | + Indicates how frequently the calculated insight is processed. Required for calculated insights. Don't use with streaming insights. + + **Available Version:** 62.0 + enum: + - ExternallyManaged + - NotScheduled + - One + - Six + - Streaming + - SystemManaged + - Twelve + - TwentyFour + type: string + publishScheduleStartDateTime: + description: | + 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 + type: string + required: + - publishScheduleInterval + - publishScheduleStartDateTime + CdpCalculatedInsightMeasureRepresentation: + title: Calculated Insight Measure Output + description: Represents a calculated insight measure. + type: object + properties: + apiName: + description: Api Name + type: string + creationType: + description: Creation Type + type: string + dataSource: + description: Data Source + allOf: + - $ref: "#/components/schemas/CdpCalculatedInsightDataSourceRepresentation" + dataType: + description: Data Type + type: string + displayName: + description: Display Name + type: string + fieldAggregationType: + description: Field Aggregation Type + type: string + fieldRole: + description: Field Role + type: string + formula: + description: Formula + type: string + CdpCalculatedInsightRepresentation: + title: Calculated Insight Output + description: Represents a calculated insight. + type: object + properties: + apiName: + description: | + API name of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + calculatedInsightStatus: + description: | + Status of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + creationType: + description: | + Creation type of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + dataSpace: + description: | + Data space of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + definitionStatus: + description: | + Definition status of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + definitionType: + description: | + Definition type of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + description: + description: | + Description of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + dimensions: + description: | + Dimensions of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpCalculatedInsightDimensionRepresentation" + displayName: + description: | + Display name of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + expression: + description: | + Expression of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + isEnabled: + description: | + Specifies whether the calculated insight is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 57.0 + type: boolean + lastCalcInsightStatusDateTime: + description: | + Last calculated insight status date and time. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastCalcInsightStatusErrorCode: + description: | + Last calculated insight status error code. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastRunDateTime: + description: | + Last run date and time of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastRunStatus: + description: | + Last run status of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastRunStatusDateTime: + description: | + Last run status date and time of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastRunStatusErrorCode: + description: | + Last run status error code of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + measures: + description: | + Measures of the calculated insight. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpCalculatedInsightMeasureRepresentation" + CdpCalculatedInsightStandardActionResponseRepresentation: + title: Calculated Insight Standard Action Response Output + description: Response for a calculated insight run action. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + CdpDataActionCollectionRepresentation: + title: Data Action Collection Output + description: Represents a collection of data actions. + type: object + properties: + currentPageUrl: + description: | + URL to the current page of data actions. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataActions: + description: | + List of data actions. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/CdpDataActionOutputRepresentation" + nextPageUrl: + description: | + URL to the next page of data actions. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + CdpDataActionCRMTargetInfo: + title: Data Action Target Core Config Output + description: Represents the configuration for a CRM data action target. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetInfo" + - type: object + properties: + label: + description: | + Org label. + + **Available Version:** 62.0 + type: string + orgId: + description: | + Org ID. + + **Available Version:** 62.0 + type: string + CdpDataActionInputRepresentation: + title: Data Action Input + description: Input representation to create a data action. + type: object + properties: + actionConditionExpression: + description: | + The action's condition expression. + + **Available Version:** 62.0 + type: string + actionConditions: + description: | + The action conditions. + + **Available Version:** 62.0 + type: array + items: + type: object + dataActionEnrichmentProperties: + description: | + The data action enrichment properties. + + **Available Version:** 62.0 + type: array + items: + type: object + dataActionName: + description: | + Name of the data action. + + **Available Version:** 62.0 + type: string + dataActionProjectedFields: + description: | + Projected fields for the data action. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + type: object + dataActionSources: + description: | + Data action sources. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + type: object + dataActionTargetNames: + description: | + List of names of the data action targets. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + type: string + dataspace: + description: | + Name of the data space to use for the request. + + **Available Version:** 62.0 + type: string + description: + description: | + Data action's description. + + **Available Version:** 62.0 + type: string + developerName: + description: | + Data action developer name. + + **Available Version:** 62.0 + type: string + eventTriggerCondition: + description: | + Data action's event trigger condition. + + **Available Version:** 62.0 + type: string + externalRecordIdentifier: + description: | + Data action's external record identifier. + + **Available Version:** 62.0 + type: string + isRealTimeAction: + description: | + `true` if the data action is a real time action, otherwise `false`. + + + **Available Version:** 62.0 + type: boolean + masterLabel: + description: | + Data action's master label. + + **Available Version:** 62.0 + type: string + shouldProcessDayZero: + description: | + `true` if the data action should be processed immediately, otherwise `false`. + + **Available Version:** 62.0 + type: boolean + shouldTriggerEventOnlyFirstTime: + description: | + 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 + type: boolean + subscriberKey: + description: | + Data action subscriber key. + + **Available Version:** 62.0 + type: string + required: + - actionConditionExpression + - actionConditions + - dataActionEnrichmentProperties + - dataActionName + - dataActionProjectedFields + - dataActionSources + - dataActionTargetNames + - dataspace + - description + - developerName + - masterLabel + CdpDataActionMCTargetInfo: + title: Data Action Target Marketing Cloud Config Output + description: Represents the configuration for a Marketing Cloud data action target. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetInfo" + - type: object + properties: + contentKey: + description: | + Content key. + + **Available Version:** 62.0 + type: string + contentTemplate: + description: | + Content template. + + **Available Version:** 62.0 + type: string + type: object + CdpDataActionOutputRepresentation: + title: Data Action Output + description: The output of a create data action request. + type: object + properties: + actionConditionExpression: + description: | + The action's condition expression. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + actionConditions: + description: | + The action conditions. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionConditionOutputRepresentation" + dataActionEnrichmentProperties: + description: | + The data action enrichment properties. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionEnrichmentOutputRepresentation" + dataActionName: + description: | + Data action's name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataActionProjectedFields: + description: | + The data action's projected fields. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionProjectedFieldOutputRepresentation" + dataActionSources: + description: | + Data action sources. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionSourceOutputRepresentation" + dataActionStatus: + description: | + Data action's status. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Active + - Error + - InActive + - Processing + type: string + dataActionTargets: + description: | + Data action targets. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + type: string + dataSpaceDevName: + description: | + Developer name of the data space. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + description: + description: | + Description of the data action. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + developerName: + description: | + Developer name of the data action. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + eventTriggerCondition: + description: | + Event trigger condition for the data action. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + externalRecordIdentifier: + description: | + Data action's external record identifier. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + isRealTimeAction: + description: | + Indicates whether the data action is a real-time action (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + lastActionStatusDateTime: + description: | + Date and time that the most recent data action status was set. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + lastActionStatusErrorCode: + description: | + Status of the data action's error code. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - CreateFailed + - DeleteFailed + - ProcessingFailed + type: string + masterLabel: + description: | + Data action's master label. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + shouldTriggerEventOnlyFirstTime: + description: | + 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 + type: boolean + subscriberKey: + description: | + Data action subscriber key. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + CdpDataActionTargetCollectionRepresentation: + title: Data Action Target Collection Output + description: | + Data action target collection representation. + + **Available Version:** 62.0 + type: object + properties: + currentPageUrl: + description: | + URL to the current page of data action targets. + + **Available Version:** 62.0 + type: string + dataActionTargets: + description: | + List of data action targets. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/CdpDataActionTargetOutputRepresentation" + nextPageUrl: + description: | + URL for the next page of data action targets. + + **Available Version:** 62.0 + type: string + CdpDataActionTargetConfig: + title: Data Action Target Config Input + type: object + description: Base class for data action target config input. + properties: + apiContract: + description: | + API contract for the data action target. + + **Available Version:** 58.0 + type: string + targetEndpoint: + description: | + Target endpoint. + + **Available Version:** 58.0 + type: string + CdpDataActionTargetCRMConfig: + title: Data Action Target Core Config Input + description: Represents the config input for CRM data action targets. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetConfig" + - type: object + properties: + orgId: + description: | + ID for the target CRM org. + + **Available Version:** 58.0 + type: string + orgLabel: + description: | + Label for the target CRM org. + + **Available Version:** 58.0 + type: string + CdpDataActionTargetInfo: + title: Data Action Target Info Output + description: Representation for a data action target's configuration. Configuration parameters are case sensitive. + type: object + properties: + apiContract: + description: | + API contract. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + targetEndpoint: + description: | + Target endpoint. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + CdpDataActionTargetInputRepresentation: + title: Data Action Target Input + description: Input representation for creating a data action target. + type: object + properties: + apiName: + description: | + Data action target API name. + + **Available Version:** 62.0 + type: string + config: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/CdpDataActionTargetCRMConfig" + - $ref: "#/components/schemas/CdpDataActionTargetInternalWebConfig" + - $ref: "#/components/schemas/CdpDataActionTargetMCConfig" + - $ref: "#/components/schemas/CdpDataActionTargetWebConfig" + externalRecordIdentifier: + description: | + External record ID. + + **Available Version:** 62.0 + type: string + label: + description: | + Data action target name. + + **Available Version:** 62.0 + type: string + subType: + description: | + Data action target sub type. + + **Available Version:** 62.0 + enum: + - Grpc + - Rest + type: string + type: + description: | + Data action target type. + + **Available Version:** 62.0 + enum: + - Core + - Internal_WebHook + - MarketingCloud + - WebHook + type: string + required: + - apiName + - config + - label + - type + CdpDataActionTargetInternalWebConfig: + title: Data Action Target Internal Web Config Input + description: Represents the config input for internal web data action targets. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetConfig" + - type: object + CdpDataActionTargetInternalWebInfo: + title: Data Action Target Internal Web Config Output + description: Represents the configuration for an Internal WebHook data action target. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetInfo" + - type: object + CdpDataActionTargetMCConfig: + title: Data Action Target Marketing Cloud Config Input + description: Represents the config input for Marketing Cloud data action targets. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetConfig" + - type: object + properties: + contentKey: + description: | + Content key for Marketing Cloud. + + **Available Version:** 58.0 + type: string + contentTemplate: + description: | + Content template. + + **Available Version:** 58.0 + type: string + CdpDataActionTargetOutputRepresentation: + title: Data Action Target Output + description: Representation for a data action target. + type: object + properties: + apiName: + description: | + Developer name of the data action target. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + config: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/CdpDataActionCRMTargetInfo" + - $ref: "#/components/schemas/CdpDataActionTargetInternalWebInfo" + - $ref: "#/components/schemas/CdpDataActionMCTargetInfo" + - $ref: "#/components/schemas/CdpDataActionTargetWebInfo" + externalRecordIdentifier: + description: | + External record ID. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + label: + description: | + Data action target name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + status: + description: | + Status + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Active + - Error + - InActive + - Processing + type: string + statusErrorCode: + description: | + Status error code. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - CreateFailed + - DeleteFailed + - ProcessingFailed + type: string + subType: + description: | + Sub type + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Grpc + - Rest + type: string + type: + description: | + Data action target type. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Core + - Internal_WebHook + - MarketingCloud + - WebHook + type: string + CdpDataActionTargetSigningKeyOutputRepresentation: + title: Data Action Target Signing Key Output + description: Data Action target Signing Key representation. + type: object + properties: + signingAlgorithm: + description: | + Signing algorithm. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + signingKey: + description: | + Signing key. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + CdpDataActionTargetWebConfig: + title: Data Action Target Web Config Input + description: Represents the config input for web data hook action targets. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetConfig" + - type: object + CdpDataActionTargetWebInfo: + title: Data Action Target Web Hook Config Output + description: Represents the configuration for a web hook data action target. + allOf: + - $ref: "#/components/schemas/CdpDataActionTargetInfo" + CdpDataGraphActionResponseRepresentation: + title: Data Graph Action Response Output + description: Represents the data graph refresh output. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + CdpDataGraphActivateInputRepresentation: + title: Data Graph Activate Input + type: object + description: Represents the input for activating a data graph. + properties: + fullRefreshConfig: + description: | + Configuration of the full refresh schedule for standard data graphs. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/DataGraphFullRefreshConfigInputRepresentation" + CdpDataGraphDataRecencyInputRepresentation: + title: Data Graph Recency Input + description: Data graph recency criteria input representation. + type: object + properties: + fieldName: + description: | + API name of the field to which recency criteria is applied. + + **Available Version:** 59.0 + type: string + value: + description: | + Value of the criteria. + + **Available Version:** 59.0 + type: integer + valueType: + description: | + Type of value. Valid values are `time` and `record`. + + **Available Version:** 59.0 + type: string + valueUnit: + description: | + For time, valid value is `DAY`. For record, valid value is `RECORD`. + + **Available Version:** 59.0 + type: string + required: + - fieldName + - value + - valueType + - valueUnit + CdpDataGraphFieldInputRepresentation: + title: Data 360 Data Graph Field Input + description: Data graph field input representation. + type: object + properties: + ciFieldType: + description: | + Calculated insight field type. + + **Available Version:** 59.0 + type: string + dataType: + description: | + Data type of the field. + + **Available Version:** 59.0 + type: string + isKeyColumn: + description: | + Indicates whether the field is a primary key (`true`) or not (`false`). + + **Available Version:** 59.0 + type: boolean + isProjected: + description: | + Indicates whether this field needs to be projected in output value JSON (`true`) or not (`false`). + + **Available Version:** 59.0 + type: boolean + keyQualifierName: + description: | + Key qualifier name. + + **Available Version:** 59.0 + type: string + sourceFieldName: + description: | + API name of the field of the object. + + **Available Version:** 59.0 + type: string + usageTag: + description: | + Tag that indicates whether the field represents a key qualifier field (`KEY_QUALIFIER`) or not (`NONE`). + + **Available Version:** 59.0 + type: string + required: + - ciFieldType + - dataType + - isKeyColumn + - isProjected + - keyQualifierName + - sourceFieldName + - usageTag + CdpDataGraphFieldOutputRepresentation: + title: Data 360 Data Graph Field Output + description: Represents a data graph field. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseOutputRepresentation" + - type: object + properties: + dataType: + description: | + Data type of the data graph field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + isKeyColumn: + description: | + Indicates whether this field is the key column (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: boolean + isProjected: + description: | + Indicates whether this field is projected (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: boolean + sourceFieldLabel: + description: | + Label of the source field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + sourceFieldName: + description: | + Developer name of the source field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + usageTag: + description: | + Usage tag. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: object + CdpDataGraphInputRepresentation: + title: Data Graph Input + description: Input representation for creating a data graph. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + primaryObjectName: + description: | + API name of the primary data model object (DMO) of the data graph. + + **Available Version:** 59.0 + type: string + sourceObject: + description: | + Primary root of the data graph. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpDataGraphSourceInputRepresentation" + type: + description: | + Data graph type. Valid value is `NONE`. + + **Available Version:** 59.0 + type: string + type: object + CdpDataGraphOutputRepresentation: + title: Data Graph Output + description: Represents data graph output. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseOutputRepresentation" + - type: object + properties: + extendedProperties: + description: | + Extended properties of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + idDmoLabel: + description: | + Label of the data model object (DMO) that contains the ID table of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + idDmoName: + description: | + API name of the data model object (DMO) that contains the ID table of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + kind: + description: | + Reserved for internal use. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + lastRunStatus: + description: | + Status for the most recent run of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + primaryObjectLabel: + description: | + Label of the primary data model object (DMO) of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + primaryObjectName: + description: | + Developer name of the primary object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + sourceObject: + description: | + Source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpDataGraphSourceObjectOutputRepresentation" + status: + description: | + Status of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: + description: | + Type of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + valuesDmoLabel: + description: | + Label of the data model object (DMO) that contains the data graph JSON records. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + valuesDmoName: + description: | + API name of the DMO that contains the data graph JSON records. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + version: + description: | + Version of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: object + CdpDataGraphPathToParentInputRepresentation: + title: Data Graph Path to Parent Input + description: Data graph source object path input representation. + type: object + properties: + fieldName: + description: | + Field name of this object that joins with parentFieldName. + + **Available Version:** 59.0 + type: string + parentFieldName: + description: | + Field name of the parent object that participated in the path. + + **Available Version:** 59.0 + type: string + required: + - fieldName + - parentFieldName + CdpDataGraphPathToParentOutputRepresentation: + title: Data Graph Path to Parent Output + description: Represents data graph path-to-parent output. + type: object + properties: + fieldLabel: + description: | + Field label. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + fieldName: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + parentFieldLabel: + description: | + Parent field label. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + parentFieldName: + description: | + Parent field name. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpDataGraphRecencyCriteriaOutputRepresentation: + title: Data Graph Recency Criteria Output + description: Represents data graph recency criteria output. + type: object + properties: + fieldLabel: + description: | + Field label of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + fieldName: + description: | + Field name of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + value: + description: | + Value of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + valueType: + description: | + Value type of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + valueUnit: + description: | + Value unit of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpDataGraphSourceInputRepresentation: + title: Data Graph Source Input + description: Data graph source object input representation. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + fields: + description: | + List of fields on the source object that need to be included in the data graph. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphFieldInputRepresentation" + jsonPath: + description: | + Projected JSON path of this object in the output value JSON from root. + + **Available Version:** 59.0 + type: string + path: + description: | + Path of the source object. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphPathToParentInputRepresentation" + recencyCriteria: + description: | + Recency criteria of the source object. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphDataRecencyInputRepresentation" + relatedObjects: + description: | + List of related child objects that need to be included in the data graph. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphSourceInputRepresentation" + type: + description: | + Type of the source object. + + **Available Version:** 59.0 + enum: + - CALCULATED + - CALCULATED_STREAMING + - CALCULATED_REAL_TIME + - STANDARD + - CUSTOM + - SYSTEM + - DERIVED + - BRIDGE + - SEGMENT_MEMBERSHIP + - ML_PREDICTION + - ACTIVATION_AUDIENCE + - TRANSFORM + type: string + type: object + CdpDataGraphSourceObjectOutputRepresentation: + title: Data Graph Source Object Output + description: Represents data graph source object output. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseOutputRepresentation" + - type: object + properties: + fields: + description: | + Fields of the data graph source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphFieldOutputRepresentation" + fragmentDMOLabel: + description: | + Fragment data model object (DMO) label. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + fragmentDMOName: + description: | + Fragment data model object (DMO) name. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + jsonPath: + description: | + JSON path of the data graph source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + path: + description: | + Path of the data graph source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphPathToParentOutputRepresentation" + recencyCriteria: + description: | + Recency criteria of the data graph source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphRecencyCriteriaOutputRepresentation" + relatedObjects: + description: | + List of related child objects included in the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpDataGraphSourceObjectOutputRepresentation" + type: + description: | + Type of the data graph source object. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Activation_Audience + - Bridge + - Calculated + - Calculated_Real_Time + - Calculated_Streaming + - Custom + - Derived + - Ml_Prediction + - Segment_Membership + - Standard + - System + - Transform + type: string + type: object + CdpDataKitDeployBundleConfig: + title: Data Kit Deploy Bundle Config Input + description: | + 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 + type: object + CdpDataKitDeployBundleConfigForAccountEngagement: + title: Data Kit Deploy Bundle Config For Account Engagement Input + description: Represents the bundle configuration for an account engagement connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filer criteria. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + dataStreamType: + description: | + Type of data stream. + + **Available Version:** 63.0 + type: string + enum: + - EmailActivity + - FormActivity + - WebPageActivity + pardotTenantId: + description: | + Pardot tenant ID of the connector. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployBundleConfigForCommerce: + title: Data Kit Deploy Bundle Config For Commerce Input + description: Represents the bundle configuration for a Commerce Cloud connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + instanceId: + description: | + Instance ID of the B2C Commerce Instance + + **Available Version:** 63.0 + type: string + CdpDataKitDeployBundleConfigForConnectorsFramework: + title: Data Kit Deploy Bundle Config For Connectors Framework Input + description: Represents the bundle configuration for a connector framework connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + connectionName: + description: | + APi name of the connection. + + **Available Version:** 60.0 + type: string + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filter criteria. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + CdpDataKitDeployBundleConfigForCrm: + title: Data Kit Deploy Bundle Config For CRM Input + description: Represents a bundle configuration for a CRM connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filter criteria. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + orgId: + description: | + Org ID for the source CRM. + + **Available Version:** 57.0 + type: string + CdpDataKitDeployBundleConfigForExternal: + title: Data Kit Deploy Bundle Config For External Input + description: Represents the bundle configuration for an external connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + connectionName: + description: | + API name of the connection. + + **Available Version:** 63.0 + type: string + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filter criteria. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + CdpDataKitDeployBundleConfigForIngestApi: + title: Data Kit Deploy Bundle Config For Ingest API Input + description: Represents the bundle configuration for an ingest API connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + connectorName: + description: | + Connector API name For the ingest API connector. + + **Available Version:** 60.0 + type: string + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filter criteria. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + type: object + CdpDataKitDeployBundleConfigForStreamingApp: + title: Data Kit Deploy Bundle Config For Streaming App Input + description: Represents the bundle configuration for a streaming app connector type. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfig" + - type: object + properties: + connectorName: + description: | + API name of the streaming app connector. + + **Available Version:** 60.0 + type: string + dataSpaceFilterCriteriaApiConfig: + description: | + API configuration for the data space filter criteria. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + streamingAppDataConnectorType: + description: | + Type of streaming app connector. + + **Available Version:** 60.0 + enum: + - MobileApp + - WebApp + type: string + CdpDataKitDeployComponentConfig: + title: Data Kit Deploy Component Config Input + description: | + - 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 + type: object + CdpDataKitDeployComponentConfigCalculatedInsight: + title: Data Kit Deploy Component Config Calculated Insight Input + description: Represents the input component configuration for calculated insights. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the calculated insight in the data kit to be deployed. + + **Available Version:** 59.0 + type: string + apiNameOverride: + description: | + Name of the new calculated insight deployed using the template. + + **Available Version:** 59.0 + type: string + label: + description: | + Master label of the calculated insight. + + **Available Version:** 59.0 + type: string + publishInterval: + description: | + Publish interval for the calculated insight. + + **Available Version:** 59.0 + enum: + - ExternallyManaged + - NotScheduled + - One + - Six + - Streaming + - SystemManaged + - Twelve + - TwentyFour + type: string + publishScheduleEndDate: + description: | + Calculated insight publish schedule end date. The expected format is `yyyy-MM-dd`. + + **Available Version:** 62.0 + type: string + publishScheduleStartDateTime: + description: | + Calculated insight publish schedule start date. The expected format is `yyyy-MM-dd`. + + **Available Version:** 62.0 + type: string + CdpDataKitDeployComponentConfigForBundle: + title: Data Kit Deploy Component Config For Bundle Input + description: Represents the input component configuration for data kit bundles. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + bundleConfig: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForAccountEngagement" + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForCommerce" + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForConnectorsFramework" # used for MoreConnectors and S3 + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForCrm" + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForExternal" + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForIngestApi" + - $ref: "#/components/schemas/CdpDataKitDeployBundleConfigForStreamingApp" + bundleName: + description: | + Name of the bundle. + + **Available Version:** 57.0 + type: string + connectorType: + description: | + Connector type for the bundle. + + **Available Version:** 57.0 + enum: + - AccountEngagement + - Commerce + - Crm + - External + - IngestApi + - MoreConnectors + - S3 + - StreamingApp + type: string + forceNoRefresh: + description: | + Indicates whether to force a no refresh configuration on the data stream (`true`) or not (`false`). + + **Available Version:** 57.0 + type: boolean + kqConfig: + description: | + List of key qualifier configurations applied on data stream templates of the bundle. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitKQConfigRepresentation" + CdpDataKitDeployComponentConfigForDataAction: + title: Data Kit Deploy Component Config For Data Action Input + description: Represents the input component configuration for data actions. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + developerName: + description: | + Developer name of the data action. + + **Available Version:** 63.0 + type: string + developerNameOverride: + description: | + Developer name of the data action override. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data action object. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForDataActionTarget: + title: Data Kit Deploy Component Config For Data Action Target Input + description: Represents the input component configuration for data action targets. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the data action target. + + **Available Version:** 63.0 + type: string + apiNameOverride: + description: | + API name of the data action target override. + + **Available Version:** 63.0 + type: string + endPointUrlOverride: + description: | + API name of the data action target endpoint URL override. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data action target object. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForDataSemanticSearch: + title: Data Kit Deploy Component Config For Data Semantic Search Input + description: Represents the input component configuration for data semantic search. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the semantic search object. + + **Available Version:** 63.0 + type: string + dataKitName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the semantic search object. + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the specific semantic search instance. + + **Available Version:** 63.0 + type: string + searchIndexName: + description: | + Developer name of the underlying search index used by this component. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForDataShare: + title: Data Kit Deploy Component Config For Data Share Input + description: Represents the input component configuration for data shares. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + Definition name of the target data share. + + **Available Version:** 63.0 + type: string + cios: + description: | + Developer names of the calculated insight objects. + + **Available Version:** 63.0 + type: array + items: + type: string + dataShareDeveloperName: + description: | + Definition name of the source data share. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + description: + description: | + Description for the data share. + + **Available Version:** 63.0 + type: string + dlos: + description: | + Developer names of the DLOs. + + **Available Version:** 63.0 + type: array + items: + type: string + dmos: + description: | + Developer names of the DMOs. + + **Available Version:** 63.0 + type: array + items: + type: string + label: + description: | + Label of the data share. + + **Available Version:** 63.0 + type: string + templateDevName: + description: | + Template developer name of the data share template that's used for creating the share in the data kit. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForDLO: + title: Data Kit Deploy Component Config For DLO Input + description: Represents the input component configuration for DLOs. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the DLO. + + **Available Version:** 60.0 + type: string + dataSourceObjectDevName: + description: | + Developer name of the DLO. + + **Available Version:** 60.0 + type: string + dataSpaceFilterCriteriaApiConfig: + description: | + Data space filter criteria for adding filters while deploying a DLO. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionApiConfig" + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 60.0 + type: string + label: + description: | + Label name of the DLO. + + **Available Version:** 60.0 + type: string + CdpDataKitDeployComponentConfigForIdpConfiguration: + title: Data Kit Deploy Component Config For Idp Configuration Input + description: Represents the input component configuration for Document AI. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + templateDevName: + description: | + Developer name of the Document AI template. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForPredictionJob: + title: Data Kit Deploy Component Config For Prediction Job Input + description: Represents the input component configuration for ML prediction jobs. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the ML prediction job object. + + **Available Version:** 63.0 + type: string + dataKitName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the ML prediction job object. + + **Available Version:** 63.0 + type: string + predictionJobName: + description: | + Developer name of the specific prediction job. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigForTuaFramework: + title: Data Kit Deploy Component Config For Tua Framework Input + description: Represents the input component configuration for TUA objects. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + changeSetIdentifier: + description: | + Unique ID for the change set. + + **Available Version:** 63.0 + type: string + componentType: + description: | + Type of TUA object component. + + **Available Version:** 63.0 + type: string + enum: + - 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: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + developerName: + description: | + Developer name of the TUA object. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the TUA object. + + **Available Version:** 63.0 + type: string + CdpDataKitDeployComponentConfigMlConfiguredModel: + title: Data Kit Deploy Component Config Ml Configured Model Input + description: Represents the input component configuration for ML configured models. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the ML configured model. + + **Available Version:** 63.0 + type: string + connectorType: + description: | + Type of ML configured model connector. + + **Available Version:** 63.0 + type: string + enum: + - Anthropic + - AzureOpenAI + - Bedrock + - Databricks + - Generic + - InternalEmbedding + - OpenAI + - OpenConnector + - SageMaker + - Salesforce + - VertexAI + label: + description: | + Label of the ML configured model. + + **Available Version:** 63.0 + type: string + modelType: + description: | + Type of ML configured model. + + **Available Version:** 63.0 + type: string + enum: + - Generative + - Predictive + - SpeechSynthesis + - Summarization + - Transcribe + - Unknown + CdpDataKitDeployComponentConfigMlRetriever: + title: Data Kit Deploy Component Config Ml Retriever Input + description: Represents the input component configuration for ML retrievers. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the retriever. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the retriever. + + **Available Version:** 63.0 + type: string + retrieverQueryType: + description: | + Query type of the retriever. + + **Available Version:** 63.0 + type: string + enum: + - Ensemble + - NoCode + - ProCode + CdpDataKitDeployComponentRepresentation: + title: Data Kit Deploy Component Input + description: Represents a single component for a data kit deployment. + type: object + properties: + config: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForBundle" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForDLO" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigCalculatedInsight" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForDataAction" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForDataActionTarget" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForDataSemanticSearch" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForDataShare" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForIdpConfiguration" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForPredictionJob" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigForTuaFramework" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigMlConfiguredModel" + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfigMlRetriever" + - $ref: "#/components/schemas/DataCustomCodeInputRep" + - $ref: "#/components/schemas/DataKitDeployActivationTargetRepresentation" + - $ref: "#/components/schemas/DataKitDeployComponentConfigCopyField" + - $ref: "#/components/schemas/DataKitDeployComponentConfigForIRRelatedList" + - $ref: "#/components/schemas/DataKitDeployComponentConfigIdentityResolutionInput" + - $ref: "#/components/schemas/DataKitDeployComponentConfigSemanticModelInputRepresentation" + - $ref: "#/components/schemas/DataKitDeployDataCleanRoomMappingRepresentation" + - $ref: "#/components/schemas/DataKitDeployDataCleanRoomProviderRepresentation" + - $ref: "#/components/schemas/DataKitDeployDataConnectionRepresentation" + - $ref: "#/components/schemas/DataKitDeployDataGraphInputRepresentation" + - $ref: "#/components/schemas/DataKitDeployDataTransformRepresentation" + - $ref: "#/components/schemas/DataKitDeployMarketActivationRepresentation" + - $ref: "#/components/schemas/DataKitDeployMarketSegmentRepresentation" + - $ref: "#/components/schemas/DataKitDeployPersonalizationInputRepresentation" + - $ref: "#/components/schemas/DataKitDeployInputRepresentation" # Basic config for types not listed above + type: + description: | + Type of component. + + **Available Version:** 57.0 + enum: + - 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 + type: string + required: + - config + - type + CdpDataKitDeployInputRepresentation: + title: Data Kit Deploy Input + description: Represents input for deploying a data kit. + type: object + properties: + components: + description: | + List of components to deploy. + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpDataKitDeployComponentRepresentation" + required: + - components + CdpDataKitMembers: + title: Data Kit Members Output + type: object + description: Represents the data kit member details for one component. + properties: + developerName: + description: | + List of component developer names. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + entityName: + description: | + List of component entity names. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + id: + description: | + List of component entity IDs. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + CdpDataKitMembersList: + title: Data Kit Members Collection Output + type: object + description: Represents a list of members for one data kit. + properties: + dataKitMembers: + description: | + List of data kit members. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CdpDataKitMembers" + CdpDataKitStream: + title: Data Kit Stream Output + description: Represents a single stream in a data kit data stream bundle. + type: object + properties: + devName: + description: | + Developer name of the stream. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + label: + description: | + Label of the stream. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + required: + - devName + - label + CdpDataTransformActionResponseRepresentation: + title: Data Transform Action Response Output + description: Representation for the action response of the run action for the + data transform API. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + properties: + shouldForceFullRun: + description: | + Indicates whether to force the transform to run in full mode (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + CdpDgMetadataRepresentation: + title: Data Graph Metadata Output + description: Represents metadata from one or more data graphs. + type: object + properties: + dataGraphMetadata: + description: | + List of metadata from data graphs. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpQueryDataGraphMetadataRepresentation" + CdpErrorRepresentation: + title: Error Output + description: Represents an error response. + type: object + properties: + errorCode: + description: | + Error code. + + **Filter Group:** Big + + **Available Version:** 57.0 + type: string + errorMessage: + description: | + Message stating the reason for the error, if any. + + **Filter Group:** Big + + **Available Version:** 57.0 + type: string + CdpFieldSourceTargetMapInputRepresentation: + title: Field Source Target Map Input + description: Represents the input for creating a field source target map. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + sourceFieldDeveloperName: + description: | + Source DLO field developer name. + + **Available Version:** 61.0 + type: string + targetFieldDeveloperName: + description: | + Target DMO field developer name. + + **Available Version:** 61.0 + type: string + CdpFieldSourceTargetMapRepresentation: + title: Field Source Target Map Output + description: Represents a field source target mapping. + type: object + properties: + developerName: + description: | + Developer name of the field mapping. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + sourceFieldDeveloperName: + description: | + Developer name of the source DLO field in the mapping. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + targetFieldDeveloperName: + description: | + Developer name of the target DMO field in the mapping. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + CdpHourlyScheduleInputRepresentation: + title: Hourly Schedule Input + description: Input representation for creating an hourly schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleInputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Day of the week on which the schedule will run. + + **Available Version:** 60.0 + type: array + items: + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + type: string + interval: + description: | + Number of hours between runs. + + **Available Version:** 60.0 + type: integer + type: object + CdpHourlyScheduleRepresentation: + title: Hourly Schedule Output + description: Hourly schedule to execute a job. + allOf: + - $ref: "#/components/schemas/CdpScheduleRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule is to run. + + **Available Version:** 60.0 + type: array + items: + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + type: string + interval: + description: | + Number of hours between runs. + + **Available Version:** 60.0 + type: integer + type: object + CdpIdentityResolutionConfigInput: + title: Identity Resolution Config Input + description: Input representation for creating an identity resolution. + type: object + properties: + configurationType: + description: Source object for an identity resolution ruleset. + enum: + - Account + - Individual + type: string + description: + description: | + Description of the identity resolution ruleset. + + **Available Version:** 57.0 + type: string + doesRunAutomatically: + description: | + Specifies whether automatic job run scheduling is enabled for the ruleset (`true`) or not (`false`). If unspecified, defaults to `false`. + + **Available Version:** 57.0 + type: boolean + label: + description: | + User friendly name of the identity resolution ruleset. + + **Available Version:** 57.0 + type: string + matchRules: + description: | + List of match rules for the identity resolution ruleset. + + **Available Version:** 57.0 + type: array + items: + type: object + reconciliationRules: + description: | + List of reconciliation rules for the identity resolution ruleset. + + **Available Version:** 57.0 + type: array + items: + type: object + rulesetId: + description: | + 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 + type: string + required: + - configurationType + - label + - reconciliationRules + CdpIdentityResolutionConfigPatchInput: + title: Identity Resolution Config Patch Input + description: Input representation for updating an identity resolution. + type: object + properties: + description: + description: | + Description of the identity resolution ruleset. + + **Available Version:** 57.0 + type: string + doesRunAutomatically: + description: | + Specifies whether automatic job run scheduling is enabled for the ruleset (`true`) or not (`false`). If unspecified, defaults to `false`. + + **Available Version:** 57.0 + type: boolean + label: + description: | + User friendly name of the identity resolution ruleset. + + **Available Version:** 57.0 + type: string + matchRules: + description: | + List of match rules for the identity resolution ruleset. + + **Available Version:** 57.0 + type: array + items: + type: object + reconciliationRules: + description: | + List of reconciliation rules for the identity resolution ruleset. + + **Available Version:** 57.0 + type: array + items: + type: object + required: + - label + - reconciliationRules + CdpIdentityResolutionMatchCriterionOutput: + title: Identity Resolution Match Criterion Output + description: | + Represents a match rule criterion for an identity resolution ruleset. + type: object + properties: + caseSensitiveMatch: + description: | + 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 + type: boolean + entityName: + description: | + API name of the data model object the match rule applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + fieldName: + description: | + Name of the field the criterion applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + matchMethodType: + description: | + Match method for a match rule criterion. + + **Filter Group:** Small + + **Available Version:** 57.0 + enum: + - Exact + - ExactNormalized + - Fuzzy + - FuzzyHigh + - FuzzyLow + type: string + partyIdentificationInfo: + description: | + Party Identification information. + + **Filter Group:** Small + + **Available Version:** 57.0 + allOf: + - $ref: "#/components/schemas/CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput" + shouldMatchOnBlank: + description: | + Specifies whether blank fields can be used for matching (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 57.0 + type: boolean + CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput: + title: Identity Resolution Match Criterion Party Identification Info Output + description: Information about when party identification is used in a match rule criterion for an identity resolution ruleset. + type: object + properties: + partyName: + description: | + Party identification name. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + partyType: + description: | + Party identification type. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + CdpIdentityResolutionMatchRuleOutput: + title: Identity Resolution Match Rule Output + description: Represents match rule criteria for an identity resolution ruleset. + type: object + properties: + criteria: + description: | + Object and field the match rule applies to and the match method applied. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionMatchCriterionOutput" + label: + description: | + User friendly name for the identity resolution match rules. + + **Filter Group:** Small + + **Available Version:** 57. + type: string + CdpIdentityResolutionOutputRepresentation: + title: Identity Resolution Output + description: Represents an identity resolution. + type: object + properties: + anonymousUnifiedProfiles: + format: int64 + description: | + Count of anonymous unified profiles created by running the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + configurationType: + description: | + Source object for an identity resolution. + + **Filter Group:** Small + + **Available Version:** 57.0 + enum: + - Account + - Individual + type: string + consolidationRate: + format: double + description: | + Consolidation rate resulting from the run of an identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: number + dataSpaceName: + description: | + Data space used as source data for an identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + description: + description: | + Description of the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + doesRunAutomatically: + description: | + 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 + type: boolean + id: + description: | + Identity resolution ruleset's ID. This is not the identity resolution's extended ruleset ID (`rulesetId`). + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + knownUnifiedProfiles: + format: int64 + description: | + Count of known unified profiles created by running the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + label: + description: | + User friendly name of the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastJobCompleted: + description: | + Date and time the last job completed. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + lastJobStatus: + description: | + Last job's status. Possible values are: + - `SUCCESS` + - `IN_PROGRESS` + - `FAIL` + - `SCHEDULED` + - `SKIPPED` + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + matchRules: + description: | + List of match rules. + + **Filter Group:** Big + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionMatchRuleOutput" + matchedSourceProfiles: + format: int64 + description: | + Count of matched source profiles identified by running the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + objectApiName: + description: | + Object name of the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + reconciliationRules: + description: | + List of reconciliation rules. + + **Filter Group:** Big + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionReconciliationRuleOutput" + rulesetId: + description: | + 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 + type: string + rulesetStatus: + description: | + Status of a ruleset job. Possible values are: + - `NEW` + - `PUBLISHING` + - `PUBLISHED` + - `ERROR` + - `DELETING` + - `DELETE_FAILED` + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + sourceProfiles: + format: int64 + description: | + Count of source profiles that were processed by a ruleset job. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + totalUnifiedProfiles: + format: int64 + description: | + Count of unified profiles created by running the identity resolution ruleset. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: integer + CdpIdentityResolutionReconciliationFieldRuleOutput: + title: Identity Resolution Reconciliation Field Rule Output + description: Represents the reconciliation rule for a field of an identity resolution ruleset. + type: object + properties: + fieldName: + description: | + The field that this reconciliation rule applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + ruleType: + description: | + Default reconciliation rule applied to fields in the object the reconciliation rule applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + enum: + - LastUpdated + - MostFrequent + - SourceSequence + type: string + shouldIgnoreEmptyValue: + description: | + Specifies whether to ignore an empty value (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 57.0 + type: boolean + sources: + description: | + If `ruleType` is `SourceSequence`, a prioritized list of data sources. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionReconciliationSourceOutput" + CdpIdentityResolutionReconciliationRuleOutput: + title: Identity Resolution Reconciliation Rule Output + description: Represents a reconciliation rule for an object of an identity resolution ruleset. + type: object + properties: + entityName: + description: | + API name of the data model object the reconciliation rule applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + fields: + description: | + Field-specific reconciliation rules that override this default rule for the specified field. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionReconciliationFieldRuleOutput" + linkDmoName: + description: | + API name of the unified link object created by the identity resolution process. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + ruleType: + description: | + Default reconciliation rule applied to fields in the object the reconciliation rule applies to. + + **Filter Group:** Small + + **Available Version:** 57.0 + enum: + - LastUpdated + - MostFrequent + - SourceSequence + type: string + shouldIgnoreEmptyValue: + description: | + Specifies whether to ignore an empty value (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 57.0 + type: boolean + sources: + description: | + If `ruleType` is `SourceSequence`, a list of data sources in priority order. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionReconciliationSourceOutput" + unifiedDmoName: + description: | + API name of the unified data model object created by the identity resolution process. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + CdpIdentityResolutionReconciliationSourceOutput: + title: Identity Resolution Reconciliation Source Output + description: Source for an identity resolution default reconciliation rule or field-specific rule using the SourceSequence match method. + type: object + properties: + name: + description: | + If the `ruleType` for a reconciliation rule is `SourceSequence`, API name of a source data lake object. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + CdpIdentityResolutionRunNowInput: + title: Identity Resolution Run Now Input + description: Input representation for running an identity resolution on demand. + type: object + properties: + callingApp: + description: | + Calling application. + + **Available Version:** 57.0 + type: string + callingAppInfo: + description: | + Calling application information. + + **Available Version:** 57.0 + type: string + CdpIdentityResolutionRunNowOutputRepresentation: + title: Identity Resolution Run Now Output + description: Identity resolution ruleset run-now output. + type: object + properties: + resultCode: + description: | + Result of an identity resolution ruleset job run. + + **Filter Group:** Small + + **Available Version:** 57.0 + enum: + - ExceededMaximumNumberOfSuccessfulRunsAllowedIn24Hours + - IdentityResolutionJobIsAlreadyRunning + - NoPendingChangesJobRunSkipped + - SuccessfullySubmittedIdentityResolutionJobRunRequest + type: string + CdpIdentityResolutionsOutputRepresentation: + title: Identity Resolutions Output + description: Represents identity resolution rulesets. + type: object + properties: + identityResolutions: + description: | + List of identity resolution rulesets. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: array + items: + $ref: "#/components/schemas/CdpIdentityResolutionOutputRepresentation" + CdpMinutelyScheduleInputRepresentation: + title: Minutely Schedule Input + description: Represents the input for creating a minutely schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleInputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Day of the week on which the schedule will run. + + **Available Version:** 58.0 + type: array + items: + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + interval: + description: | + Number of minutes between runs. + + **Available Version:** 58.0 + type: integer + CdpMinutelyScheduleRepresentation: + title: Minutely Schedule Output + description: Represents the output for creating a minutely schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule will run. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: array + items: + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + interval: + description: | + Number of hours between runs. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + CdpMlAggregatePredictConditionRepresentation: + title: ML Aggregate Predict Condition Output + description: Represents an ML aggregate prediction contribution. + allOf: + - $ref: "#/components/schemas/CdpMlPredictionContributionBaseRepresentation" + - type: object + properties: + count: + description: | + Number of rows included in the aggregate condition. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + type: object + CdpMlAggregatePredictionRepresentation: + title: ML Aggregate Prediction Output + description: Represents an ML aggregate prediction. + type: object + properties: + factors: + description: | + Top factors associated with this aggregate prediction. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlAggregatePredictConditionRepresentation" + prescriptions: + description: | + Prescriptions associated with this aggregate prediction. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlAggregatePredictConditionRepresentation" + status: + description: | + Status of aggregate prediction. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Error + - Success + type: string + type: + description: | + Type of aggregate prediction. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Average + - Median + - Sum + type: string + value: + format: double + description: | + Aggregate prediction value. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: number + CdpMlCustomizableFieldRepresentation: + title: ML Customizable Field Output + description: Represents an ML customizable field. + type: object + properties: + field: + description: | + Customizable field. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpMlModelInputFieldBaseRepresentation" + type: + description: | + Customizable field type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - ActionableVariable + - TopFactor + type: string + CdpMlFieldRepresentation: + title: ML Field Output + description: Represents an ML field. + type: object + properties: + label: + description: | + Field's label. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + name: + description: | + Field's name. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + CdpMlFilterInputRepresentation: + title: Ml Filter Input + type: object + description: Represents the input for a filter expression. + properties: + conjunctiveOperator: + description: | + Operator used to join filter criteria. + + **Available Version:** 67.0 + type: string + enum: + - And + - Custom + - Or + criteria: + description: | + List of filter criteria. + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/CdpMlFilterCriterionInputRepresentation" + customBooleanExpression: + description: | + 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 + type: string + required: + - conjunctiveOperator + - criteria + CdpMlFilterCriterionInputRepresentation: + title: Ml Filter Criterion Input + type: object + description: Represents the input for a filter criterion. + properties: + field: + description: | + 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 + allOf: + - $ref: "#/components/schemas/MlFilterFieldAssetInputRepresentation" + operator: + description: | + Operator applied to the filter criterion. + + **Available Version:** 67.0 + type: string + enum: + - EqualTo + - GreaterThan + - GreaterThanOrEqualTo + - In + - LessThan + - LessThanOrEqualTo + - Like + - NotEqualTo + - NotIn + values: + description: | + List of values to apply in the filter. + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/CdpMlFilterValueInputRepresentation" + required: + - field + - operator + - values + CdpMlFilterCriterionBaseRepresentation: + title: Ml Filter Criterion Base Output + type: object + description: Represents a filter criterion. + discriminator: + propertyName: type + properties: + operator: + description: | + Operator of the filter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - EqualTo + - GreaterThan + - GreaterThanOrEqualTo + - In + - LessThan + - LessThanOrEqualTo + - Like + - NotEqualTo + - NotIn + type: + description: | + Type of filter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - CalculatedInsightObjectField + - DataModelObjectField + - ModelInputField + - SemanticSearchVectorEmbedRelatedField + values: + description: | + List of values to apply in the filter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlFilterValueRepresentation" + CdpMlFilterRepresentation: + title: Ml Filter Output + type: object + description: Represents a filter expression. + properties: + conjunctiveOperator: + description: | + Operator to join filter conditions. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - And + - Custom + - Or + criteria: + description: | + List of filter criteria. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlFilterCriterionBaseRepresentation" + customBooleanExpression: + description: | + 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 + type: string + CdpMlFilterValueInputRepresentation: + title: Ml Filter Value Input + type: object + description: Represents the input for a filter value. + properties: + type: + description: | + Type of value. + + **Available Version:** 67.0 + type: string + enum: + - Constant + - Placeholder + value: + description: | + 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 + type: string + required: + - type + - value + CdpMlFilterValueRepresentation: + title: Ml Filter Value Output + type: object + description: Represents a filter value. + properties: + type: + description: | + Type of value. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Constant + - Placeholder + value: + description: | + 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 + type: string + CdpMlFoundationalModelRepresentation: + title: ML Foundational Model Output + description: Represents an ML foundational model. + type: object + properties: + foundationalModelName: + description: | + 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 + type: string + internalVersionNumber: + description: | + Internal version number to track the minor version order. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + majorVersionName: + description: | + Major version name, for example `OpenAIGPT35Turbo`. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - 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: + description: | + 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 + type: string + modelIdentifier: + description: | + Model identifier (supported by LLM Gateway). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + modelProviderName: + description: | + Model provider (supported by LLM Gateway). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Anthropic + - AzureOpenAI + - Bedrock + - Databricks + - Generic + - InternalEmbedding + - OpenAI + - OpenConnector + - SageMaker + - Salesforce + - VertexAI + CdpMlJobBaseRepresentation: + title: Ml Job Base Output + description: Represents a machine learning job. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + description: + description: | + Description of the job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + endTime: + description: | + End time of the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + input: + description: | + 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 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + message: + description: | + Message associated with the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + startTime: + description: | + Start time of the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: + description: | + Type of job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Prediction + - Training + CdpMlJobCollectionRepresentation: + title: Ml Job Collection Output + description: Represents a list of machine learning jobs. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + jobs: + description: | + List of jobs. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlJobBaseRepresentation" + CdpMlModelArtifactBaseRepresentation: + title: ML Model Artifact Base Output + description: Represents a base ML model artifact. + discriminator: + propertyName: modelType + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + description: + description: | + Description of the artifact. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + inputFields: + description: | + Input fields for the model artifact. + + **Filter Group:** Small + + **Available Version: 61.0** + type: array + items: + $ref: "#/components/schemas/CdpMlModelInputFieldBaseRepresentation" + isBatchSupported: + description: | + Indicates whether this model supports batch (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + modelConnectorEndpoint: + description: | + Model connector endpoint definition. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlConnectorEndpointRepresentation" + modelCount: + description: | + Number of configured models from this model artifact. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + modelType: + description: | + Model type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Generative + - Predictive + - Unknown + type: string + modelDisabledReasons: + description: | + Reason(s) why the model status is disabled. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + type: string + outputFields: + description: | + Model artifact's output fields. + + **Filter Group:** Small + + **Available Version: 61.0** + type: array + items: + $ref: "#/components/schemas/CdpMlModelOutputFieldRepresentation" + parameters: + description: | + Model parameters. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelParameterDefinitionBaseRepresentation" + runtimeType: + description: | + Runtime type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - External + - Internal + type: string + setupContainer: + description: | + Setup container. + + **Filter Group:** Small + + **Available Version: 61.0** + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + source: + description: | + Information about the source of the artifact. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + sourceContainer: + description: | + Information about the artifact's source container. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + sourceType: + description: | + 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 + enum: + - EdcNoCode + - ModelConnector + - OutOfTheBox + type: string + status: + description: | + Model artifact status. + + **Available Version:** 61.0 + enum: + - Disabled + - Draft + - Enabled + type: string + syncStatus: + description: | + Sync status. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Error + - NotSynced + - Synced + - Syncing + type: string + type: object + CdpMlModelArtifactCollectionRepresentation: + title: ML Model Artifact Collection Output + description: Represents an ML model artifact collection. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + modelArtifacts: + description: | + List of model artifacts. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelArtifactBaseRepresentation" + required: + - modelArtifacts + CdpMlModelArtifactInputRepresentation: + title: ML Model Artifact Input + description: Represents ML model artifact input. + type: object + properties: + description: + description: | + The model artifact's description. + + **Available Version:** 61.0 + type: string + label: + description: | + Model artifact's label. + + **Available Version:** 61.0 + type: string + status: + description: | + Model artifact's status. + + **Available Version:** 61.0 + enum: + - Disabled + - Draft + - Enabled + type: string + required: + - description + - label + - status + CdpMlModelFieldBaseRepresentation: + title: ML Model Field Base Output + description: Represents a base ML model field. + allOf: + - $ref: "#/components/schemas/CdpMlFieldRepresentation" + - type: object + properties: + dataType: + description: | + The field's data type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Boolean + - Date + - Number + - Text + type: string + position: + description: | + Field's position. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + type: object + CdpMlModelInputFieldBaseRepresentation: + title: ML Model Input Field Base Input + description: Represents a base ML model input field. + allOf: + - $ref: "#/components/schemas/CdpMlModelFieldBaseRepresentation" + - type: object + properties: + isDisparateImpact: + description: | + Whether this field is a disparate impact field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isPartitionField: + description: | + Whether this field is used for partition. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isSensitive: + description: | + Whether this field is a sensitive field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + type: object + CdpMlModelOutputFieldRepresentation: + title: ML Model Output Field Output + description: Represents an ML model output field. + allOf: + - $ref: "#/components/schemas/CdpMlModelFieldBaseRepresentation" + CdpMlModelParameterDefinitionBaseRepresentation: + title: ML Model Parameter Definition Base Output + description: Represents a base ML model parameter. + type: object + discriminator: + propertyName: type + properties: + applicableCapabilities: + description: | + The generative model capabilities this parameter is applicable to. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + enum: + - BinaryClassification + - ChatCompletion + - Completion + - Embedding + - Generic + - MulticlassClassification + - Regression + type: string + description: + description: | + Parameter description. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + overridable: + description: | + Whether or not you can override this parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + parameterName: + description: | + Parameter name. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + type: + description: | + Parameter type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - 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. + type: string + CdpMlModelParameterOverrideBaseRepresentation: + title: ML Model Parameter Override Base Output + description: Represents a base ML model parameter override. + type: object + discriminator: + propertyName: type + properties: + parameterName: + description: | + Parameter name. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + type: + description: | + Parameter type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Continuous + - Discrete + type: string + CdpMlPredictInputBaseRepresentation: + title: ML Predict Input Representation + description: Represents prediction input. + type: object + properties: + fieldNames: + description: 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. + type: array + items: + type: string + rows: + description: 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"]]`. + type: array + items: + type: object + model: + description: | + The model's name or ID, for example: + ```json + { + "name": "titanic_simple" + } + ``` + or + + ```json + { + "id": "12lX40000000DAKIA2" + } + ``` + + **Available Version:** 60.0 + type: object + settings: + description: | + The model configuration settings used to generate the prediction. + + **Available Version:** 61.0 + type: object + properties: + aggregateFunctions: + description: | + Reserved for future use. + + **Available Version:** 61.0 + type: array + items: + type: string + maxPrescriptions: + description: | + Maximum number of recommendations. The allowed range is `-1` through `200`, and the default value is `-1` (unlimited). + + **Available Version:** 61.0 + type: integer + maxTopFactors: + description: | + Maximum top factor count. The allowed range is `0` through `3`, and the default value is `0`. + + **Available Version:** 61.0 + type: integer + prescriptionImpactPercentage: + description: | + 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: integer + type: + description: | + Type of prediction. + + **Available Version:** 61.0 + enum: + - RawData + type: string + required: + - fieldNames + - rows + - model + - type + CdpMlPredictionBaseRepresentation: + title: ML Prediction Base Output + description: Base representation for a prediction result. + type: object + properties: + status: + description: | + Prediction status. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Error + - Success + type: string + CdpMlPredictionContributionBaseRepresentation: + title: ML Prediction Contribution Base Output + description: Base representation for a prediction contribution. + type: object + properties: + fields: + description: | + List of fields and values that have the same contribution value. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlPredictionContributionFieldRepresentation" + value: + format: double + description: | + Contribution value. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: number + CdpMlPredictionContributionFieldRepresentation: + title: ML Prediction Contribution Field Output + description: Representation for an ML prediction contribution field. + allOf: + - $ref: "#/components/schemas/CdpMlFieldRepresentation" + - type: object + properties: + customText: + description: | + If the field has custom text, contains the custom text definition. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpMlPredictionFieldCustomTextRepresentation" + inputValue: + description: | + Input value used for this field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + prescribedValue: + description: | + 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 + type: string + type: object + CdpMlPredictionFieldCustomTextRepresentation: + title: ML Prediction Field Custom Text Output + description: Represents ML prediction field custom text. + type: object + properties: + isHidden: + description: | + Whether to show the default text. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + mergeFieldValues: + description: | + Placeholder for the resolved value defined in the template text. Null if there are no placeholders. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: object + properties: + type: + type: string + required: + - type + templateText: + description: | + If a custom override is defined for the column, contains the template text. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + CdpMlPredictResultRepresentation: + title: ML Predict Result Output + description: Represent an ML prediction result. + type: object + properties: + aggregatePredictions: + description: | + Aggregate result list. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlAggregatePredictionRepresentation" + model: + description: | + Model asset reference used as part of the prediction request. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + predictionType: + description: | + Prediction type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - BinaryClassification + - Generic + - Regression + type: string + predictions: + description: | + A list of prediction results. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlPredictionBaseRepresentation" + settings: + description: | + Settings used for the prediction. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpMlPredictSettingsRepresentation" + CdpMlPredictSettingsRepresentation: + title: ML Predict Settings Output + description: Represents ML prediction settings. + type: object + properties: + aggregateFunctions: + description: | + Reserved for future use. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + type: string + maxPrescriptions: + description: | + 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 + type: integer + maxTopFactors: + description: | + 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 + type: integer + prescriptionImpactPercentage: + description: | + Impact percentage of the prescription. Default is 0. + + **Available Version:** 61.0 + type: integer + CdpMlSetupBaseInputRepresentation: + title: ML Setup Base Input + description: Represents the base class for the core input fields needed to create a setup version for an ML model. + type: object + properties: + description: + description: | + Description of the setup. + + **Available Version:** 59.0 + type: string + type: + description: | + Setup type. + + **Available Version:** 59.0 + type: string + enum: + - EdcNoCode + - ModelConnector + CdpMlSetupBaseRepresentation: + title: ML Setup Base Output + description: Represents the base class for the core metadata and shared fields needed to set up a ML model. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + active: + description: | + Indicates whether the setup is active (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: boolean + description: + description: | + Description of the setup. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + numberOfPartitions: + description: | + Number of partitions in a model setup version. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + partitionsUrl: + description: | + URL for retrieving the partitions associated with a model setup version. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: + description: | + Setup type. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - EdcNoCode + - ModelConnector + version: + description: | + Setup version number. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + CdpMlSetupPartitionBaseRepresentation: + title: ML Setup Partition Base Output + description: Represents the base class for the core metadata and shared fields for a model setup partition. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + description: + description: | + Description of the model setup partition. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + type: + description: | + Setup type. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - EdcNoCode + - ModelConnector + CdpMlSetupVersionCollectionRepresentation: + title: ML Setup Version Collection Output + description: Represents a collection of model setup versions that includes metadata and configuration information for each setup version. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + versions: + description: | + List of setup versions. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlSetupBaseRepresentation" + CdpMlSetupVersionPartitionCollectionRepresentation: + title: ML Setup Version Partition Collection Output + description: Respresents a collection of model setup version partitions. + type: object + properties: + partitions: + description: | + List of partitions. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlSetupPartitionBaseRepresentation" + totalSize: + description: | + Total size of the collection. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + url: + description: | + URL of the page. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpMlTaskBase: + title: Ml Task Base Output + description: Represents a machine learning job task. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + endTime: + description: | + End time of the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + errorCode: + description: | + Error code, if any. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + message: + description: | + Message associated with the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + startTime: + description: | + Start time of the job run. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpMlTaskCollection: + title: Ml Task Collection Output + type: object + description: Represents a list of machine learning job tasks. + properties: + tasks: + description: | + List of tasks. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlTaskBase" + CdpMonthlyRelativeScheduleInputRepresentation: + title: Monthly Relative Schedule Input + description: Represents the input for creating a monthly relative schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleInputRepresentation" + - type: object + properties: + dayOfWeek: + description: | + Day of the week on which the schedule will run. + + **Available Version:** 58.0 + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + weekOfMonth: + description: | + Relative week of the month when the schedule should be run. + + **Available Version:** 58.0 + type: string + enum: + - First + - Fourth + - Last + - Second + - Third + CdpMonthlyRelativeScheduleRepresentation: + title: Monthly Relative Schedule Output + description: Represents the output for creating a monthly relative schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleRepresentation" + - type: object + properties: + dayOfWeek: + description: | + Day of the week on which the schedule is to run. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + weekOfMonth: + description: | + Week of the month on which the schedule is to run. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + enum: + - First + - Fourth + - Last + - Second + - Third + CdpNoneScheduleInputRepresentation: + title: No Schedule Input + description: Input representation when not creating a schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleInputRepresentation" + CdpNoneScheduleRepresentation: + title: No Schedule Output + description: Output representation when not creating a schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleRepresentation" + CdpObjectBaseInputRepresentation: + title: Object Base Input + description: Represents base object input. + type: object + properties: + dataSpaceName: + description: | + 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 + type: string + description: + description: | + Description of the object to create. + + **Available Version:** 59.0 + type: string + label: + description: | + Label of the object to create. This property is required for data graph resources. + + **Available Version:** 59.0 + type: string + name: + description: | + API name of the object to create. This property is required for data graph resources. + + **Available Version:** 59.0 + type: string + CdpObjectBaseOutputRepresentation: + title: Object Base Output + description: Represents base object output. + type: object + properties: + createdBy: + description: | + Who or what created the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + createdDate: + description: | + Date when the base object was created. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + dataspaceName: + description: | + Name of the data space of the base object. If unspecified, the `default` data space is used. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + description: + description: | + Description of the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + id: + description: | + ID of the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + label: + description: | + Label of the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + modifiedBy: + description: | + Who or what most recently modified the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + modifiedDate: + description: | + When the base object was most recently modified. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + name: + description: | + Name of the base object. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpObjectSourceTargetMapCollectionRepresentation: + title: Object Source Target Map Collection Output + description: Represents a collection of object source target mappings. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + objectSourceTargetMaps: + description: | + List of object source target mappings. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpObjectSourceTargetMapRepresentation" + CdpObjectSourceTargetMapInputRepresentation: + title: Object Source Target Map Input + description: Represents the input for creating an object source target map. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + fieldMapping: + description: | + Details about the fields mappings between the DLO source and the DMO target. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpFieldSourceTargetMapInputRepresentation" + sourceEntityDeveloperName: + description: | + Source DLO entity developer name. + + **Available Version:** 61.0 + type: string + targetEntityDeveloperName: + description: | + Target DMO entity developer name. + + **Available Version:** 61.0 + type: string + CdpObjectSourceTargetMapRepresentation: + title: Object Source Target Map Output + description: Represents the mappings between a data lake object (DLO) and a data model object (DMO). + type: object + properties: + developerName: + description: | + Developer name of the object source target map. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + fieldMappings: + description: | + List of field mappings from the object source target map. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpFieldSourceTargetMapRepresentation" + sourceEntityDeveloperName: + description: | + Source DLO entity developer name of the object source target map. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + status: + description: | + Status of the object source target map. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Active + - Creating + - Deleting + - Error + - Inactive + - Updating + targetEntityDeveloperName: + description: | + Target DMO entity developer name of the object source target map. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + CdpPaginatedResponseBaseRepresentation: + title: Paginated Response Base Output + description: Base paginated response representation. + type: object + properties: + currentPageUrl: + description: | + Current page URL. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + nextPageUrl: + description: | + Next page URL, if it exists. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + totalSize: + description: | + Total size of the collection. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + CdpPredictNodeInputRepresentation: + title: Predict Node Input + description: Represents the input for a predict node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpPredictParametersInputRepresentation" + required: + - parameters + CdpPredictNodeRepresentation: + title: Predict Node Output + description: Represents a prediction data node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpPredictParametersRepresentation" + CdpPredictParametersInputRepresentation: + title: Predict Parameters Input + type: object + description: Represents the input for prediction parameters. + properties: + columnMapping: + description: | + Map of column values. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + minPrescriptionImpact: + description: | + Minimum prescription impact double. + + **Available Version:** 60.0 + type: number + format: double + multiClassFields: + description: | + Multi-class fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorInputRepresentation" + predictSource: + description: | + Prediction source. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictSourceInputRepresentation" + predictionFactorFields: + description: | + List of prediction factor fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorInputRepresentation" + predictionFields: + description: | + List of prediction fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionFieldInputRepresentation" + prescriptionFields: + description: | + List of prescription fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorInputRepresentation" + CdpPredictParametersRepresentation: + title: Predict Parameters Output + type: object + description: Represents prediction node parameters. + properties: + columnMapping: + description: | + Map of columns. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + minPrescriptionImpact: + description: | + Minimum prescription impact. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: number + format: double + multiClassFields: + description: | + Multi-class fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorRepresentation" + predictSource: + description: | + List of prediction sources. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictSourceRepresentation" + predictionFactorFields: + description: | + List of prediction factor fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorRepresentation" + predictionFields: + description: | + List of prediction fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionFieldRepresentation" + prescriptionFields: + description: | + List of prescription fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PredictionContributorRepresentation" + CdpQueryDataGraphMetadataRepresentation: + title: Data Graph Query Metadata Output + description: Represents metadata for a data graph. + type: object + properties: + dataspaceName: + description: | + Name of the data space in which the data graph metadata resides. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + description: + description: | + Description of the data graph metadata. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + developerName: + description: | + Developer name of the data graph metadata. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + dgObject: + description: | + Metadata for the data object of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/DataGraphObjectDataRepresentation" + extendedProperties: + description: | + Extended properties of the data graph metadata. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: object + idDmoName: + description: | + API name of the data model object (DMO) that contains the ID table for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + idsDmo: + description: | + Data about the DMO that contains the ID table for the data graph. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/DataGraphIdsDmoRepresentation" + primaryObjectName: + description: | + Name of the primary object for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + primaryObjectType: + description: | + Data type of the primary object for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Adg + - AdgActivationAudience + - AdgExternal + - Bridge + - Calculated + - CalculatedRealTime + - CalculatedStreaming + - Curated + - Custom + - Derived + - MlPrediction + - Package + - SegmentMembership + - Standard + - System + - Transform + type: string + status: + description: | + Status of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Error + - Inprogress + - Published + - Ready + - StatusUnspecified + - Unrecognized + type: string + valuesDmo: + description: | + Data about the data model object (DMO) that contains the JSON records for the data graph. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/DataGraphValuesDmoRepresentation" + valuesDmoName: + description: | + API name of the DMO that contains the JSON records for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + version: + description: | + Version of the data graph metadata. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + CdpQueryDataOutputRepresentation: + title: Query Data Output + description: Represents query data output. + type: object + properties: + data: + description: | + Result data set. + + **Filter Group:** Small + + **Available Version:** 54.0 + type: array + items: + type: object + CdpQueryInputRepresentation: + title: Query Input + description: Input representation for creating a query. + type: object + properties: + sql: + description: | + ANSI-standard SQL query. + + **Available Version:** 52.0 + type: string + required: + - sql + CdpQueryMetadataEntitiesOutputRepresentation: + title: Query Metadata Entities Output + type: object + description: Represents a list of metadata entities. + properties: + done: + description: | + Indicates whether all metadata entities have been retrieved (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + metadata: + description: | + List of metadata entities. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/CdpQueryMetadataEntityOutputRepresentation" + nextBatchId: + description: | + 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 + type: string + CdpQueryMetadataEntityOutputRepresentation: + title: Query Metadata Entity Output + type: object + description: Represents a metadata entity. + properties: + category: + description: | + 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 + type: string + displayName: + description: | + Display name of the entity. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + name: + description: | + Name of the entity. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + type: + description: | + Type of metadata entity. Supported values are: + - `CalculatedInsight` + - `DataLakeObject` + - `DataModelObject` + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + CdpQueryMetadataItemRepresentation: + title: Query Metadata Item + description: Represents a query metadata item. + type: object + properties: + placeInOrder: + description: Attribute place order in the result + type: integer + type: + description: Metadata Type for Column + type: string + typeCode: + description: Metadata Type Code + type: integer + CdpQueryMetadataOutputRepresentation: + title: Query Metadata Output + description: Represents query metadata. + type: object + properties: + metadata: + description: | + Result metadata set. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: array + items: + type: object + CdpQueryOutputRepresentation: + title: Query Output + description: Represents query output. + type: object + properties: + data: + description: | + Result data set. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: array + items: + type: object + done: + description: | + Specifies whether the query is done (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 52.0 + type: boolean + endTime: + description: | + Query end time. Not returned for data graphs. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: string + metadata: + description: | + Result metadata set. Not returned for data graphs. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: object + additionalProperties: + type: object + queryId: + description: | + Query ID. Not returned for data graphs. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: string + rowCount: + description: | + Number of rows in the result data set. Not returned for data graphs. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: integer + startTime: + description: | + Query start time. Not returned for data graphs. + + **Filter Group:** Small + + **Available Version:** 52.0 + type: string + CdpQueryOutputV2Representation: + title: Query Output V2 + description: Represents query output for the V2 API. + type: object + properties: + data: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/CdpQueryV2RowRepresentation" + done: + description: | + Specifies whether the query is done (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 54.0 + type: boolean + endTime: + description: | + Query end time. + + **Filter Group:** Small + + **Available Version:** 54.0 + type: string + metadata: + description: | + 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 + type: object + additionalProperties: + $ref: "#/components/schemas/CdpQueryMetadataItemRepresentation" + nextBatchId: + description: | + 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 + type: string + queryId: + description: | + Query ID. + + **Filter Group:** Small + + **Available Version:** 54.0 + type: string + rowCount: + description: | + Number of rows in the result data set. + + **Filter Group:** Small + + **Available Version:** 54.0 + type: integer + startTime: + description: | + Query start time. + + **Filter Group:** Small + + **Available Version:** 54.0 + type: string + CdpQueryV2RowRepresentation: + title: Query V2 Row + description: Represents a row in the result of the V2 query API. + type: object + properties: + rowData: + description: | + Row values. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: array + items: + type: object + CdpScheduleBaseRepresentation: + title: Schedule Base Output + type: object + description: Base output class for a schedule. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/DailyScheduleRepresentation" + - $ref: "#/components/schemas/CdpHourlyScheduleRepresentation" + - $ref: "#/components/schemas/CdpNoneScheduleRepresentation" + properties: + type: + description: | + 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 + type: string + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + - Transform + CdpScheduleInputRepresentation: + title: Data 360 Schedule Input + description: Base schedule input representation. + type: object + properties: + definitionName: + description: | + Name of the schedule definition. + + **Available Version:** 63.0 + type: string + frequency: + description: | + Frequency on which the schedule is run. `None` removes the schedule and is the default. + + **Available Version:** 58.0 + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + - Transform + type: string + shouldForceSpecifiedMinutes: + description: | + 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 + type: boolean + time: + description: | + When to run the schedule. + + **Available Version:** 58.0 + allOf: + - $ref: "#/components/schemas/CdpTimeInputRepresentation" + required: + - frequency + - time + CdpScheduleRepresentation: + title: Schedule Output + description: Represents a schedule. + allOf: + - $ref: "#/components/schemas/CdpScheduleBaseRepresentation" + - type: object + properties: + frequency: + description: | + Frequency on which this schedule is run. Only `None` and `Hourly` are valid for Data Transforms. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Hourly + - None + type: string + nextScheduledDate: + description: | + Next scheduled date (in UTC) for this schedule. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + time: + description: | + Time when the schedule starts. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpTimeRepresentation" + required: + - frequency + - nextScheduledDate + - time + CdpSegmentActionInputRepresentation: + title: Segment Action Input + description: Represents segment action input for a count request. + type: object + properties: + preferApproxCount: + description: | + 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 + type: boolean + required: + - preferApproxCount + CdpSegmentActionOutputRepresentation: + title: Segment Action Output + description: Represents segment action output. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + properties: + jobId: + description: | + Job ID for the publish job. Returned only for publishSegment resource. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + partitionId: + description: | + ID of the partition. Returned only for publishSegment resource. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + publishStatus: + description: | + Publish status of the segment. Returned only for publishSegment resource. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + segmentApiName: + description: | + API name of the segment. Returned only for deactivateSegmentByName and deactivateSegmentById resources. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + segmentId: + description: | + ID of the segment. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + required: + - segmentId + CdpSegmentContainerOutputRepresentation: + title: Segment Container Output + description: Represents a segment container. + type: object + properties: + batchSize: + description: | + Number of items returned. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: integer + offset: + description: | + Number of rows skipped before returning results. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: integer + orderByExpression: + description: | + Expression indicating how results are ordered. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + segments: + description: | + List of segments. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: array + items: + $ref: "#/components/schemas/CdpSegmentOutputRepresentation" + CdpSegmentDbtInputRepresentation: + title: Segment Dbt Input + type: object + description: Represents the input for a DBT segment. + properties: + models: + description: | + List of models for the DBT segment. + + **Available Version:** 58.0 + type: array + items: + $ref: "#/components/schemas/CdpSegmentDbtModelInputRepresentation" + CdpSegmentDbtModelInputRepresentation: + title: Segment Dbt Model Input + type: object + description: Represents the input for a single DBT model. + properties: + name: + description: | + Name of the DBT model. + + **Available Version:** 55.0 + type: string + sql: + description: | + SQL for the DBT model. + + **Available Version:** 55.0 + type: string + CdpSegmentDbtModelOutputRepresentation: + title: Segment DBT Model Output + description: Represents segment DBT model output. + type: object + properties: + name: + description: | + DBT Model Name + type: string + sql: + description: | + DBT Model SQL + type: string + CdpSegmentDbtPipelineOutputRepresentation: + title: Segment DBT Pipeline Output + description: Represents segment DBT pipeline output. + type: object + properties: + models: + description: | + List of DBT models. + + type: array + items: + $ref: "#/components/schemas/CdpSegmentDbtModelOutputRepresentation" + CdpSegmentEinsteinGptSegmentsUIInputRepresentation: + title: Segment Einstein Gpt Segments UI Input + type: object + description: Represents the input for an Einstein Gpt Segments UI segment. + properties: + includeCriteria: + description: | + Inlcude criteria for an Einstein Gpt Segments UI segment. + + **Available Version:** 58.0 + type: string + CdpSegmentInputRepresentation: + title: Segment Input + description: Input representation for creating a segment. + type: object + properties: + additionalMetadata: + description: | + Map of additional metadata. Optional for POST. Not supported for PATCH. + + **Available Version:** 55.0 + type: object + additionalProperties: + type: string + componentTemplateName: + description: | + Component template mame for the segment. + + **Available Version:** 63.0 + type: string + dataKitDevName: + description: | + Data kit name for the segment. + + **Available Version:** 63.0 + type: string + dataSpace: + description: | + 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 + type: string + description: + description: | + Segment description. + + **Available Version:** 55.0 + type: string + developerName: + description: | + Segment developer name. Required for POST. Not supported for PATCH. + + **Available Version:** 55.0 + type: string + displayName: + description: | + Segment display name. + + **Available Version:** 57.0 + type: string + einsteinGptSegmentsUICriteria: + description: | + Einstein Gpt Segments UI segment criteria. + + **Available Version:** 58.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentEinsteinGptSegmentsUIInputRepresentation" + excludeCriteria: + description: | + Exclude criteria for the segment. + + **Available Version:** 60.0 + type: string + groupSortLimitFilterCriteria: + description: | + Group sort limit criteria. + + **Available Version:** 64.0 + type: string + includeCriteria: + description: | + Include criteria for the segment. + + **Available Version:** 60.0 + type: string + includeDbt: + description: | + Segment data build tool (DBT). + + **Available Version:** 55.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentDbtInputRepresentation" + lookalikeCriteria: + description: | + Lookalike criteria for the segment. + + **Available Version:** 56.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentLookalikeInputRepresentation" + lookbackPeriod: + description: | + Lookback period for the segment. + + **Available Version:** 62.0 + type: string + publishSchedule: + description: | + Publish refresh schedule (in hours). `One` and `Four` are used to rapidly publish UI and DBT-based segments. + + **Available Version:** 55.0 + enum: + - NoRefresh + - One + - Two + - Four + - Six + - Twelve + - TwentyFour + type: string + publishScheduleEndDate: + description: | + Date indicating the end of the publish schedule. Optional if `publishSchedule` is unspecified. + + **Available Version:** 55.0 + type: string + publishScheduleEndDateTime: + description: | + Datetime indicating the end of the publish schedule. + + **Availble Version:** 55.0 + type: string + publishScheduleInfo: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DailyScheduleInputRepresentation" + - $ref: "#/components/schemas/CdpHourlyScheduleInputRepresentation" + - $ref: "#/components/schemas/CdpMinutelyScheduleInputRepresentation" + - $ref: "#/components/schemas/MonthlySpecificScheduleInputRepresentation" + - $ref: "#/components/schemas/CdpMonthlyRelativeScheduleInputRepresentation" + - $ref: "#/components/schemas/WeeklyScheduleInputRepresentation" + - $ref: "#/components/schemas/CdpNoneScheduleInputRepresentation" + publishScheduleStartDateTime: + description: | + Datetime indicating the start of the publish schedule. Optional if `publishSchedule` is unspecified. + + **Available Version:** 55.0 + type: string + segmentCreationFlow: + description: | + Creation flow for the segment. + + **Available Version:** 61.0 + type: string + enum: + - Datakit + - EinsteinGpt + - Visual + segmentOnApiName: + description: | + API name of the SegmentOn entity. + + **Available Version:** 57.0 + type: string + segmentOnDataGraph: + description: | + Data graph of the SegmentOn entity for real-time segments. + + **Available Version:** 60.0 + type: string + segmentType: + description: | + 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 + enum: + - Dbt + - Dynamic + - EinsteinGptSegmentsUI + - Lookalike + - Realtimez + - Waterfall + type: string + required: + - description + - displayName + - segmentOnApiName + - segmentType + CdpSegmentLookalikeInputRepresentation: + title: Segment Lookalike Input + type: object + description: Represents the input for segment lookalike criteria. + properties: + additionalPopulation: + description: | + Additional lookalike population criteria. + + **Available Version:** 56.0 + type: integer + format: int64 + seedSegmentName: + description: | + Name of the seed segment. + + **Available Version:** 56.0 + type: string + CdpSegmentLookalikeOutputRepresentation: + title: Segment Lookalike Output + description: Represents a segment output lookalike. + type: object + properties: + additionalPopulation: + format: int64 + description: | + Additional lookalike population criteria. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: integer + seedSegmentId: + description: | + Seed segment ID for the lookalike. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + CdpSegmentMemberOutputRepresentation: + title: Segment Member Output + description: Represents segment member output. + type: object + properties: + data: + description: | + Result data set. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: array + items: + $ref: "#/components/schemas/CdpSegmentMemberRowOutputRepresentation" + endTime: + description: | + Query end time. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + filter: + description: | + Filter information for the query. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + limit: + description: | + Batch size information. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + nextPageUrl: + description: | + URL for the next page. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + offSet: + description: | + Offset information. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + orderBy: + description: | + Order by information. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + rowCount: + description: | + Total row count. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + startTime: + description: | + Query start time. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + totalCount: + description: | + Total count of records. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + CdpSegmentMemberRowOutputRepresentation: + title: Segment Member Row Output + description: Represents segment member row output. + type: object + properties: + deltaType: + description: | + Delta type, for example, `new`, `existing`, or `removed`. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + id: + description: | + Segment member ID. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + kqId: + description: | + Fully qualified key ID. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + snapshotType: + description: | + Type of snapshot. Valid value: `full`. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + timestamp: + description: | + Timestamp. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + versionStamp: + description: | + Version timestamp. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + CdpSegmentMembershipTableOutputRepresentation: + title: Segment Membership Table Output + description: Represents a segment membership table. + type: object + properties: + historyTable: + description: | + Segment membership history table. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + latestTable: + description: | + Segment membership latest table. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + profileTable: + description: | + Segment membership profile table. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + CdpSegmentOutputRepresentation: + title: Segment Output + description: Represents segment output. + type: object + properties: + apiName: + description: | + API name of the segment. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + dataSpace: + description: | + 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 + type: string + description: + description: | + Segment description. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + developerName: + description: | + Segment developer name. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + displayName: + description: | + Segment display name. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + excludeCriteria: + description: | + Segment exclude criteria. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + includeCriteria: + description: | + Segment include criteria. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + includeDbt: + description: | + Segment DBT pipeline. + + **Filter Group:** Small + + **Available Version:** 55.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentDbtPipelineOutputRepresentation" + lastPublishedEndDateTime: + description: | + Segment last published end-date time. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + lastSegmentMemberCount: + description: | + Last segment member count. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + format: int64 + lookalikeCriteria: + description: | + Lookalike criteria for the segment. + + **Filter Group:** Small + + **Available Version:** 56.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentLookalikeOutputRepresentation" + lookbackPeriod: + description: | + Lookback period of the segment. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + marketSegmentDefinitionId: + description: | + ID of the market segment definition. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + marketSegmentId: + description: | + ID of the market segment. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + nextPublishDateTime: + description: | + Date and time of the next segment publish. + + **Filter Group:** Small + + **Available Version:** 57.0 + type: string + parameters: + description: | + Metadata for dynamic segment parameters. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ParameterRepresentation" + publishInterval: + description: | + Segment publish interval. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + publishScheduleEndDate: + description: | + Publish schedule end date. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + publishScheduleEndDateTime: + description: | + Publish schedule end-date time. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + publishScheduleInfo: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DailyScheduleRepresentation" + - $ref: "#/components/schemas/CdpHourlyScheduleRepresentation" + - $ref: "#/components/schemas/CdpMinutelyScheduleRepresentation" + - $ref: "#/components/schemas/MonthlySpecificScheduleRepresentation" + - $ref: "#/components/schemas/CdpMonthlyRelativeScheduleRepresentation" + - $ref: "#/components/schemas/WeeklyScheduleRepresentation" + - $ref: "#/components/schemas/CdpNoneScheduleRepresentation" + publishScheduleStartDateTime: + description: | + Publish schedule start date time. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + publishStatus: + description: | + Segment publish status. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + segmentMembershipDmo: + description: | + Segment membership tables. + + **Filter Group:** Small + + **Available Version:** 58.0 + allOf: + - $ref: "#/components/schemas/CdpSegmentMembershipTableOutputRepresentation" + segmentMembershipTable: + description: | + Name of the segment membership table. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + segmentOnApiName: + description: | + API name of the SegmentOn entity. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + segmentOnDataGraph: + description: | + Data graph ID of the SegmentOn entity. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + segmentOnId: + description: | + ID of the DMO segment. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + segmentStatus: + description: | + Segment status. + + **Filter Group:** Small + + **Available Version:** 55.0 + type: string + segmentType: + description: | + Type of segment. + + **Filter Group:** Small + + **Available Version:** 56.0 + type: string + CdpTimeInputRepresentation: + title: Time Input + description: Time input source for when to run the schedule. + type: object + properties: + hour: + description: | + Hour when the schedule should run. + + **Available Version:** 60.0 + type: integer + minute: + description: | + Minute in the hour when the schedule should run. + + **Available Version:** 60.0 + type: integer + timeZone: + description: | + Time zone of the schedule. + + **Available Version:** 60.0 + type: string + required: + - hour + - minute + - timeZone + CdpTimeRepresentation: + title: Time Output + description: Represents a time source. + type: object + properties: + hour: + description: | + Hour at which this schedule is run (from `0` through `23`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + minute: + description: | + Minute at which this schedule is run (from `0` through `59`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + timezone: + description: | + Information about the time zone. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpTimeZoneRepresentation" + CdpTimeZoneRepresentation: + title: Time Zone Output + description: Represents a time zone. + type: object + properties: + gmtOffset: + format: double + description: | + Signed offset in hours from GMT. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: number + name: + description: | + Display name of the time zone. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + zoneId: + description: | + Zone ID of the time zone. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + CdpUserRepresentation: + title: User Output + description: Represents a user. + type: object + properties: + id: + description: | + 18-character user ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the user. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + profilePhotoUrl: + description: | + Profile photo of the user to show in the UI. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ChunkingConfigInputRepresentation: + title: Chunking Config Input + description: Represents the input for chunking structured/unstructured configurations. + type: object + properties: + fieldLevelConfigurations: + description: | + The field level configurations used in structured flows. + + **Available Version:** 65.0 + type: array + items: + $ref: "#/components/schemas/FieldLevelConfigurationInputRepresentation" + fileLevelConfiguration: + description: | + The file level configurations used in unstructured flows. + + **Available Version:** 65.0 + type: object #says FileLevelConfigurationInputRepresentation, which does not exist + ChunkingConfigurationRepresentation: + title: Chunking Configuration Output + description: Represents the output for a chunking configuration. + type: object + properties: + fieldLevelConfigurations: + description: | + Field level configurations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FieldLevelChunkingConfigurationRepresentation" + perFileExtension: + description: | + Per-file extension list. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/PerFileExtensionRepresentation" + ChunkingConfigUserValuesRepresentation: + title: Chunking Config User Values Output + description: Represents the user values for a chunking configuration. + type: object + properties: + id: + description: | + ID of the chunking configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + value: + description: | + User value for the chunking configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + CleanroomTestConnectionInputRepresentation: + title: Cleanroom Test Connection Input + type: object + description: Represents the input for testing a clean room connection. + properties: + connectionAttributes: + description: | + Map of connection attributes. + + **Available Version:** 66.0 + type: object + additionalProperties: + type: string + connectorType: + description: | + Type of connector. + + **Available Version:** 66.0 + type: string + enum: + - CleanroomAwsS3 + - CleanroomSnowflake + consumerOrgId: + description: | + 18-character org ID of the target consumer. + + **Available Version:** 66.0 + type: string + CleanRoomTestConnectionRepresentation: + title: Clean Room Test Connection Output + type: object + description: Represents the result of a clean room connection test. + properties: + details: + description: | + Additional information including error details passed by the DCF service's test connection. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: object + additionalProperties: + type: string + errorCode: + description: | + Error code, if any. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + message: + description: | + Message that provides additional context about the connection test result. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + success: + description: | + Indicates whether the connection test was successful (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + CloudProviderDetailsInputRepresentation: + title: Cloud Provider Details Input + type: object + description: Input representation for the cloud provider of a Private Network Route. + properties: + type: + description: | + Cloud provider that hosts the connector type for the Private Network Route. + + **Available Version:** 65.0 + type: string + enum: + - AmazonWebServices + CloudProviderDetailsRepresentation: + title: Cloud Provider Details Output + description: Represents details about the cloud provider for a Private Network Route. + type: object + properties: + dataCloudDnsName: + description: | + Domain Name System (DNS) name of Data 360. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + dataCloudVpceId: + description: | + Virtual Private Cloud (VPC) endpoint ID of Data 360. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + status: + description: | + Status of the Private Network Route. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + enum: + - Allocating + - DeletedRemotely + - PendingAcceptance + - PendingActivation + - Ready + - RejectedRemotely + - TeardownInProgress + - Unprovisioned + type: + description: | + Cloud provider that hosts the connector type for the Private Network Route. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + enum: + - AmazonWebServices + ComputeRelativeNodeInputRepresentation: + title: Compute Relative Node Input + description: Representation to compare a row to another row. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ComputeRelativeParametersInputRepresentation" + required: + - parameters + ComputeRelativeNodeRepresentation: + title: Compute Relative Node Output + description: Compute relative node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ComputeRelativeParametersRepresentation" + ComputeRelativeParametersInputRepresentation: + title: Compute Relative Parameters Input + description: Compute relative node parameters. + type: object + properties: + expressionType: + description: | + Type of formula expression. + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + fields: + description: | + List of fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SqlFormulaFieldInputRepresentation" + orderBy: + description: | + Sort fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ComputeRelativeSortParametersInputRepresentation" + partitionBy: + description: | + Partition by. + + **Available Version:** 60.0 + type: array + items: + type: string + required: + - fields + - orderBy + - partitionBy + ComputeRelativeParametersRepresentation: + title: Compute Relative Parameters Output + description: Compute relative node parameters. + type: object + properties: + expressionType: + description: | + Type of formula expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + fields: + description: | + Lis of fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SqlFormulaFieldRepresentation" + orderBy: + description: | + Sort fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ComputeRelativeSortParametersRepresentation" + partitionBy: + description: | + Partition by. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + ComputeRelativeSortParametersInputRepresentation: + title: Compute Relative Sort Parameters Input + description: Compute relative sort direction parameter. + type: object + properties: + direction: + description: | + Sort direction. + + **Available Version:** 60.0 + enum: + - Ascending + - Descending + type: string + fieldName: + description: | + Field name. + + **Available Version:** 60.0 + type: string + required: + - direction + - fieldName + ComputeRelativeSortParametersRepresentation: + title: Compute Relative Sort Parameters Output + description: Compute relative sort direction parameter. + type: object + properties: + direction: + description: | + Sort direction. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Ascending + - Descending + type: string + fieldName: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ConfigInputRepresentation: + title: Config Input + description: Represents the input for the general configuration shared across + chunking and vector configurations. + type: object + properties: + id: + description: | + ID of the configuration. + + **Available Version:** 60.0 + type: string + userValues: + description: | + User input values. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/UserValueInputRepresentation" + ConfigRepresentation: + title: Config Output + description: Configuration Representation + type: object + properties: + id: + description: | + ID, for example `passage_extraction`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + userValues: + description: | + List of user values. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/UserValuesRepresentation" + ConnectionCollectionRepresentation: + title: Connection Collection Output + description: Information about the collection of connections in an org. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + connections: + description: | + List of information about the connections in the org. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ConnectionRepresentation" + required: + - connections + ConnectionCommandActionInputRepresentation: + title: Connection Command Action Input + description: Input representation for running a command on a connection without creating the connection. + type: object + properties: + commandAttributes: + description: | + Map of key-value pairs for command attributes in the form `Map`. + + **Available Version:** 64.0 + type: object + additionalProperties: + type: object + connectorType: + description: | + Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. + + **Available Version:** 64.0 + type: string + method: + description: | + Type of the data connection. + + **Available Version:** 64.0 + type: string + enum: + - Egress + - Ingress + required: + - connectorType + - method + ConnectionCommandActionRepresentation: + title: Connection Command Action Output + description: Representation for the result of testing a command action on a connection. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + ConnectionCommandExistingActionInputRepresentation: + title: Connection Command Existing Action Input + description: Input representation for running a command on an existing connection. + type: object + properties: + commandAttributes: + description: | + Map of key-value pairs for command attributes in the form `Map`. + + **Available Version:** 64.0 + type: object + additionalProperties: + type: object + ConnectionDatabaseCollectionRepresentation: + title: Connection Database Collection Output + type: object + description: Representation for a collection of database names for a connection. + properties: + databases: + description: | + List of database names for the connection. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + ConnectionDbSchemaCollectionInputRepresentation: + title: Connection DB Schema Collection Input + description: Input representation for a collection of database schemas for a connection. + type: object + properties: + advancedAttributes: + description: | + 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 + type: object + additionalProperties: + type: string + ConnectionDbSchemaCollectionRepresentation: + title: Connection DB Schema Collection Output + description: Representation for a collection of database schemas for a connection. + type: object + properties: + databaseSchemas: + description: | + List of database schemas for the connection. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + ConnectionFieldCollectionInputRepresentation: + title: Connection Field Collection Input + description: Input representation for a collection of fields in a connection object. + type: object + properties: + advancedAttributes: + description: | + 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 + type: object + additionalProperties: + type: string + filters: + description: | + Criteria that filter and retrieve fields based on a subset of fields and values. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/ResourceFiltersInputRepresentation" + required: + - advancedAttributes + ConnectionFieldCollectionRepresentation: + title: Connection Field Collection Output + description: Represents a collection of fields for a connection. + type: object + properties: + advancedAttributes: + description: | + Advanced attributes of the connection, which can include extract attributes and parser settings where applicable. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: object + additionalProperties: + type: string + fields: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/BaseConnectionFieldRepresentation" + incrementalExtractAttributes: + description: | + List of incremental fields and delete fields for the connection. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: object + primaryKeys: + description: | + List of primary keys for the connection. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + type: string + ConnectionInputRepresentation: + title: Connection Input + description: Abstract superclass for all connection input types. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/IngestApiConnectionInputRepresentation" + - $ref: "#/components/schemas/CrmConnectionInputRepresentation" + - $ref: "#/components/schemas/MarketingCloudConnectionInputRepresentation" + - $ref: "#/components/schemas/StreamingAppConnectionInputRepresentation" + - $ref: "#/components/schemas/DataConnectionInputRepresentation" + - $ref: "#/components/schemas/MarketingCloudConnectionPatchInputRepresentation" + - $ref: "#/components/schemas/StreamingAppConnectionPatchInputRepresentation" + properties: + connectorType: + description: | + 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 + type: string + label: + description: | + Label of the connector. + + **Available Version:** 60.0 + type: string + name: + description: | + Developer name of the connector. + + **Available Version:** 60.0 + type: string + required: + - connectorType + ConnectionModuleConfigInputRepresentation: + title: Connection Module Config Input + description: Input representation for Streaming App module configuration for a patch request. + type: object + properties: + configuration: + description: | + Stringified JSON object for the custom configuration of the Streaming App module. The default is `null`. + + **Available Version:** 63.0 + type: string + isEnabled: + description: | + Indicates whether the Streaming App module is enabled (`true`) or not (`false`). The default value is `false`. + + **Available Version:** 63.0 + type: boolean + name: + description: | + Name of the Streaming App module. + + **Available Version:** 63.0 + type: string + path: + description: | + 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 + type: string + required: + - name + ConnectionModuleConfigRepresentation: + title: Connection Module Config Output + description: Represents the configuration of a Streaming App module. + type: object + properties: + configuration: + description: | + Stringified JSON object for the custom configuration of the Streaming App module. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + isEnabled: + description: | + Indicates whether the Streaming App module is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + name: + description: | + Name of the Streaming App module. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + path: + description: | + URL of the Amazon S3 location where the Streaming App module's minified JavaScript file is hosted. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + ConnectionObjectCollectionInputRepresentation: + title: Connection Object Collection Input + description: Input representation for a collection of source objects for a connection. + type: object + properties: + advancedAttributes: + description: | + Comma-separated list of additional parameters to fetch the objects for a connector. Specify additional parameters in the form `"key": "value"`, where the key, for example, is `databaseName` or `schemaName`. 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 + type: object + additionalProperties: + type: string + filters: + description: | + Criteria that filter and retrieve objects based on a subset of fields and values. + + **Available Version:** 62.0 + allOf: + - $ref: "#/components/schemas/ResourceFiltersInputRepresentation" + ConnectionObjectCollectionRepresentation: + title: Connection Object Collection Output + description: Represents a collection of source objects for a connection. + type: object + properties: + objects: + description: | + 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 + type: array + items: + oneOf: + - $ref: "#/components/schemas/CrmConnectionObjectRepresentation" + - $ref: "#/components/schemas/SalesforceMarketingCloudStandardConnectionObjectRepresentation" + - $ref: "#/components/schemas/SalesforceMarketingCloudDataExtensionConnectionObjectRepresentation" + - $ref: "#/components/schemas/ConnectionObjectRepresentation" + ConnectionObjectRepresentation: + title: Connection Object Output + description: Represents a source object for a connection. + allOf: + - $ref: "#/components/schemas/BaseConnectionObjectRepresentation" + - type: object + properties: + attributes: + description: | + Attributes of the source object. Attributes are returned in the form `Map`. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: object + objectType: + description: | + Type of the source object. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Activity + - Comment + - Group + - Permission + - StructuredData + - UnstructuredData + - User + required: + - attributes + - objectType + ConnectionPatchInputRepresentation: + title: Connection Patch Input + description: 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. + type: object + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + ConnectionPreviewInputRepresentation: + title: Connection Preview Input + description: Input representation for a connection preview. + type: object + properties: + advancedAttributes: + description: | + 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 + type: object + additionalProperties: + type: string + fields: + description: | + List of fields to return in the preview. + + **Available Version:** 62.0 + type: array + items: + type: string + limit: + description: | + Maximum number of records to return in the preview. The default is `100`. + + **Available Version:** 62.0 + type: integer + required: + - advancedAttributes + - fields + ConnectionPreviewRecordRepresentation: + title: Connection Preview Record Output + description: Represents a common record for a connection preview. + type: object + properties: + record: + description: | + Connection preview record. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: object + ConnectionPreviewRepresentation: + title: Connection Preview Output + description: Represents a collection of previewed records for a connection. + type: object + properties: + advancedAttributes: + description: | + Advanced attributes of the connection, which can include extract attributes and parser settings where applicable. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: object + additionalProperties: + type: string + records: + description: | + List of connection preview records. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/ConnectionPreviewRecordRepresentation" + ConnectionRepresentation: + title: Connection Output + description: Abstract superclass for all connection output types. + allOf: + # - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + - oneOf: + - $ref: "#/components/schemas/AccountEngagementConnectionRepresentation" + - $ref: "#/components/schemas/IngestApiConnectionRepresentation" + - $ref: "#/components/schemas/CrmConnectionRepresentation" + - $ref: "#/components/schemas/MarketingCloudConnectionRepresentation" + - $ref: "#/components/schemas/StreamingAppConnectionRepresentation" + - $ref: "#/components/schemas/DataConnectionRepresentation" + properties: + connectorType: + description: | + 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 + type: string + required: + - connectorType + ConnectionSchemaActionResponseRepresentation: + title: Connection Schema Action Response Output + description: Representation for the result of testing a schema for an existing connection. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + ConnectionSchemaCollectionInputRepresentation: + title: Connection Schema Collection Input + description: Input representation of a collection of connection schemas. + type: object + properties: + schemas: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/ConnectionSchemaInputRepresentation" + required: + - schemas + ConnectionSchemaCollectionRepresentation: + title: Connection Schema Collection Output + description: Represents a collection of connection schemas. + type: object + properties: + schemas: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/ConnectionSchemaRepresentation" + ConnectionSchemaFieldInputRepresentation: + title: Connection Schema Field Input + type: object + description: Represents the input superclass for all schema fields. + properties: + label: + description: | + Label of the schema field. + + **Available Version:** 60.0 + type: string + name: + description: | + Developer name of the schema field. + + **Available Version:** 60.0 + type: string + ConnectionSchemaFieldRepresentation: + title: Connection Schema Field Output + type: object + description: Represents the output superclass for all schema fields. + properties: + label: + description: | + Label of the schema field. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + name: + description: | + Developer name of the schema field. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + ConnectionSchemaInputRepresentation: + title: Connection Schema Input + description: Input representation for a connection schema. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/ConnectorsFrameworkConnectionSchemaInputRepresentation" + - $ref: "#/components/schemas/IngestApiConnectionSchemaInputRepresentation" + - $ref: "#/components/schemas/StreamingAppConnectionSchemaInputRepresentation" + properties: + label: + description: | + Label of the connector. + + **Available Version:** 60.0 + type: string + name: + description: | + Developer name of the connector. + + **Available Version:** 60.0 + type: string + schemaType: + description: | + Schema of the connector. + + **Available Version:** 60.0 + enum: + - DataConnectionEvent + - IngestApi + - StreamingApp + type: string + required: + - label + - name + - schemaType + ConnectionSchemaRepresentation: + title: Connection Schema Output + description: Represents a schema for a connection. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/ConnectorsFrameworkConnectionSchemaRepresentation" + - $ref: "#/components/schemas/IngestApiConnectionSchemaRepresentation" + - $ref: "#/components/schemas/StreamingAppConnectionSchemaRepresentation" + properties: + label: + description: | + Label of the connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Developer name of the connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + schemaType: + description: | + Schema of the connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - DataConnectionEvent + - IngestApi + - StreamingApp + type: string + required: + - label + - name + - schemaType + ConnectionSitemapInputRepresentation: + title: Connection Sitemap Input + description: Input representation for the sitemap for a Streaming App connection. + type: object + properties: + sitemap: + description: | + Sitemap for the Streaming App connector. + + **Available Version:** 60.0 + type: string + required: + - sitemap + ConnectionSitemapRepresentation: + title: Connection Sitemap Output + description: Represents the sitemap for a Streaming App connection. + type: object + properties: + sitemap: + description: | + Sitemap of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sitemapPath: + description: | + Path to the sitemap of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ConnectionTestActionRepresentation: + title: Connection Test Action Output + description: Representation for the result of testing an action on a connection. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + ConnectionTestInputRepresentation: + title: Connection Test Input + description: Input representation for testing a connection without creating it. + type: object + properties: + connectorType: + description: | + Type of the connector. For example, `AwsRdsPostgres`, `AzureBlob`, `Databricks`, `Gcs`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, `Sftp`, `StreamingApp`, and so forth. + + **Available Version:** 62.0 + type: string + credentials: + description: | + List of key-value pairs that provide credentials for the data connection. Credentials values are masked. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + method: + description: | + Type of the data connection. + + **Available Version:** 62.0 + type: string + enum: + - Egress + - Ingress + parameters: + description: | + List of key-value pairs that provide parameters for the data connection. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + required: + - connectorType + ConnectorDetailsConfig: + title: Connector Details Config Output + description: Abstract representation for details about a connector's configuration. + type: object + ConnectorDetailsRepresentation: + title: Connector Details Output + description: Details for a Data 360 connector. + type: object + properties: + category: + description: | + Category of the Data 360 connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Engagement + - Other + - Profile + type: string + name: + description: | + Name of the Data 360 connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ConnectorFeatureRepresentation: + title: Connector Feature Output + description: Represents a feature for a Data 360 connector. + type: object + properties: + config: + description: | + Configuration of the feature. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: object + additionalProperties: + type: string + featureType: + description: | + Type of the feature. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + ConnectorInfoCollectionRepresentation: + title: Connector Info Collection Output + description: Represents a collection of information about Data 360 connectors. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + connectorInfoList: + description: | + List of items that provide information about the requested connectors. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/ConnectorInfoRepresentation" + required: + - connectorInfoList + ConnectorInfoRepresentation: + title: Connector Info Output + description: Represents information about a Data 360 connector. + type: object + properties: + description: + description: | + Description of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + features: + description: | + List of features of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/ConnectorFeatureRepresentation" + iconUrl: + description: | + URL for the icon of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + label: + description: | + Label of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + Name of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + releaseLevel: + description: | + Release level of the connector. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + ConnectorInputRepresentation: + title: Connector Input + description: Represents the input details for a connector. + type: object + properties: + connectorDetails: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataConnectorDetailsConfig" + - $ref: "#/components/schemas/IngestApiConnectorDetailsConfig" + - $ref: "#/components/schemas/CrmConnectorDetailsConfig" + - $ref: "#/components/schemas/SalesforceMarketingCloudConnectorDetailsConfig" + - $ref: "#/components/schemas/StreamingConnectorDetailsConfig" + connectorType: + description: | + Type of the connector. For example, `DataConnector`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, or `StreamingApp`. + + **Available Version:** 60.0 + type: string + ConnectorMetadataRepresentation: + title: Connector Metadata Output + description: Represents metadata for a Data 360 connector. + type: object + properties: + advancedAttributes: + description: | + 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 + type: array + items: + type: object + additionalProperties: + type: object + connectionAttributes: + description: | + 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 + type: array + items: + type: object + additionalProperties: + type: object + description: + description: | + Description of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + features: + description: | + List of features of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/ConnectorFeatureRepresentation" + iconUrl: + description: | + URL for the icon of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + label: + description: | + Label of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + Name of the connector. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + ConnectorPatchDetailsConfig: + title: Connector Patch Details Config Output + description: Represents the configuration details for a connector type. + type: object + ConnectorPatchInputRepresentation: + title: Connector Patch Input + type: object + description: Represents patch input for a connector. + properties: + connectorPatchDetailsConfig: + description: | + Details about the connector's configuration. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConnectorPatchDetailsConfig" + connectorType: + description: | + Type of connector used for deploying the data stream. For example, `StreamingApp`, `SalesforceDotCom`, `IngestApi`, or `DataConnector`. + + **Available Version:** 60.0 + type: string + ConnectorRepresentation: + title: Connector Output + description: Represents a Data 360 connector. + type: object + properties: + connectorDetails: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataConnectorDetailsRepresentation" + - $ref: "#/components/schemas/IngestionApiConnectorDetailsRepresentation" + - $ref: "#/components/schemas/CrmConnectorDetailsRepresentation" + - $ref: "#/components/schemas/SalesforceMarketingCloudConnectorDetailsRepresentation" + - $ref: "#/components/schemas/StreamingConnectorDetailsRepresentation" + connectorType: + description: | + Type of the connector. For example, `DataConnector`, `IngestApi`, `SalesforceDotCom`, `SalesforceMarketingCloud`, or `StreamingApp`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ConnectorsFrameworkConnectionSchemaFieldInputRepresentation: + title: Connectors Framework Connection Schema Field Input + description: Represents the input for connectors framework field types. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldInputRepresentation" + - type: object + properties: + currencyIsoCode: + description: | + Indicates whether the field is a currency ISO code (`true`) or not (`false`). + + **Available Version:** 64.0 + type: boolean + dataType: + description: | + Data type of the field. + + **Available Version:** 64.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + ConnectorsFrameworkConnectionSchemaFieldRepresentation: + title: Connectors Framework Connection Schema Field Output + description: Represents a connectors framework connection schema field. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldRepresentation" + - type: object + properties: + currencyIsoCode: + description: | + Indicates whether the field is a currency ISO code (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 64.0 + type: boolean + dataType: + description: | + Data type of the schema field. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + ConnectorsFrameworkConnectionSchemaInputRepresentation: + title: Connectors Framework Connection Schema Input + description: Represents the input for a connectors framework schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaInputRepresentation" + - type: object + properties: + fields: + description: | + List of schema fields. + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/ConnectorsFrameworkConnectionSchemaFieldInputRepresentation" + ConnectorsFrameworkConnectionSchemaRepresentation: + title: Connectors Framework Connection Schema Output + description: Represents a connectors framework connection schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaRepresentation" + - type: object + properties: + availabilityStatus: + description: | + Availability status of the event. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Available + - InUse + fields: + description: | + List of schema fields. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/ConnectorsFrameworkConnectionSchemaFieldRepresentation" + ContactPointAttributeInputRepresentation: + title: Contact Point Attribute Input + description: Represents the attribute of an activation contact point. + type: object + properties: + label: + description: | + Label of the attribute. + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the attribute. + + **Available Version:** 63.0 + type: string + preferredName: + description: | + Preferred name of the attribute. + + **Available Version:** 63.0 + type: string + required: + - label + - name + - preferredName + ContactPointAttributesConfigInputRepresentation: + title: Contact Point Attributes Config Input + description: Represents the configuration input for the attributes of an activation + contact point. + type: object + properties: + attributes: + description: | + List of attributes for the activations. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ContactPointAttributeInputRepresentation" + required: + - attributes + ContactPointConfigInputRepresentation: + title: Contact Point Config Input + description: Represents the activation contact point configuration input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + contactPoints: + description: | + List of contact points. + type: array + items: + $ref: "#/components/schemas/ActivationContactPointInputRepresentation" + ContactPointConfigRepresentation: + title: Contact Point Config Output + description: Represents the activation contact point configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + contactPointEntityId: + description: | + ID of the entity that this contact point configuration points to. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + contactPointEntityName: + description: | + Name of the entity that this contact point configuration points to. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + contactPointPath: + description: | + Path for the contact point. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + fieldConfig: + description: | + List of attributes from the contact point entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/ActivationContactPointsFieldConfigRepresentation" + filterExpression: + description: | + DMO filter expression for the contact point entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/ContactPointFilterExpressionRepresentation" + queryPathConfig: + description: | + Query path configuration to the entity from the activation subject entity. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + sourceConfig: + description: | + Source configuration for the contact point. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/ActivationContactPointsSourceConfigRepresentation" + type: + description: | + Type of contact point. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Email + - Maid + - Ott + - Phone + - Push + - SubscriberKeyEmail + - SubscriberKeyPhone + - WhatsApp + type: string + ContactPointFilterExpressionInputRepresentation: + title: Contact Point Filter Expression Input + description: Represents the input for an activation contact point filter expression. + type: object + properties: + contactPointDmoFilters: + description: | + List of contact point DMO filters. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DMOFilterInputRepresentation" + required: + - contactPointDmoFilters + ContactPointFilterExpressionRepresentation: + title: Contact Point Filter Expression Output + description: Represents the activation contact point filter expression output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + contactPointDmoFilters: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/DmoFilterRepresentation" + type: object + ContactPointsConfigRepresentation: + title: Contact Points Config Output + description: Represents the activation contact point configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + contactPoints: + description: | + Contact points of the activation. + type: array + items: + $ref: "#/components/schemas/ContactPointConfigRepresentation" + ContactPointSourceInputRepresentation: + title: Contact Point Source Input + description: Represents the contact point source input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + dataSourceId: + description: | + Record ID for the data source. + + **Available Version:** 60.0 + type: string + dataSourcePreference: + description: | + Preference for the data source. + + **Available Version:** 60.0 + type: string + enum: + - ContactPointPrefAny + - ContactPointPrefBusiness + - ContactPointPrefPersonal + - ContactPointPrefPrimary + dataSourcePriority: + description: | + Priority for the data source. + + **Available Version:** 60.0 + type: integer + id: + description: | + ID for the data source. + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the data source. + + **Available Version:** 60.0 + type: string + ContactPointSourcesConfigInputRepresentation: + title: Contact Point Sources Config Input + description: Represents the configuration input for contact point sources. + type: object + properties: + contactPointSources: + description: | + List of contact point sources. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ContactPointSourceInputRepresentation" + required: + - contactPointSources + ContextFieldConfigurationInputRepresentation: + title: Context Field Configuration Input + description: Represents the input for context field configurations. + allOf: + - $ref: "#/components/schemas/IndexFieldConfigurationInputRepresentation" + - type: object + ContextFieldConfigurationRepresentation: + title: Context Field Configuration Output + description: Represents context field configurations. + allOf: + - $ref: "#/components/schemas/IndexFieldConfigurationRepresentation" + - type: object + CrmConnectionInputRepresentation: + title: CRM Connection Input + description: Input representation for a Customer Relationship Management (CRM) connector. + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + - type: object + properties: + organizationId: + description: | + Organization ID of the CRM connecter. + + **Available Version:** 61.0 + type: string + required: + - organizationId + CrmConnectionObjectRepresentation: + title: CRM Connection Object Output + description: Represents a source object for a CRM connection. + allOf: + - $ref: "#/components/schemas/BaseConnectionObjectRepresentation" + - type: object + properties: + creationType: + description: | + Creation type of the source object. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Standard + hasChangeEvent: + description: | + Indicates whether the source object has a change event (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + label: + description: | + Label of the source object. (The object's label is not its API name.) + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + required: + - creationType + - hasChangeEvent + - label + CrmConnectionRepresentation: + title: CRM Connection Output + description: Represents a CRM connection. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + alias: + description: | + Alias of the CRM Connection + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + connectionStatus: + description: | + Status of the CRM Connection. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - Active + - Deleting + - Error + - InActive + - Processing + - SchemaRequired + dataSource: + description: | + Data source of the CRM connection. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + organizationId: + description: | + Organization ID of the CRM connection. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + CrmConnectorDetailsConfig: + title: CRM Connector Details Config Input + description: Represents the configuration details for a CRM connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsConfig" + - type: object + properties: + name: + description: | + Name of the CRM connector. + + **Available Version:** 63.0 + type: string + sourceObject: + description: | + Developer name of the source object. + + **Available Version:** 63.0 + type: string + CrmConnectorDetailsRepresentation: + title: CRM Connector Details Output + description: Represents the output for a CRM connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsRepresentation" + - type: object + properties: + sourceObject: + description: | + Developer name of the source object. + + **Available Version:** 61.0 + type: string + CuratedEntityInputRepresentation: + title: Curated Entity Input + description: Represents the input details for a curated entity. + type: object + properties: + label: + description: | + DMO label of the curated entity. + + **Available Version:** 63.0 + type: string + name: + description: | + DMO API name of the curated entity. + + **Available Version:** 63.0 + type: string + required: + - label + - name + CustomUseCaseTemplateAnalysisConfigRepresentation: + title: Custom Use Case Template Analysis Config Output + type: object + description: Represents the analysis configuration for a custom use case template for a clean room. + properties: + outputPath: + description: | + Output path for saving the query result. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateColumnRepresentation: + title: Custom Use Case Template Column Output + type: object + description: Represents a column in a clean room custom use case template table. + properties: + defaultValue: + description: | + Default value of the column in the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + description: + description: | + Description of the column in the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the column in the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + tooltip: + description: | + Helper text to show in the UI with an info icon. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + type: + description: | + Type of column value in the template table, such as `STRING`, `INTEGER`, or `BOOLEAN`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateInputRepresentation: + title: Custom Use Case Template Input + type: object + description: Represents the input for a custom use case template for a clean room. + properties: + description: + description: | + Description of the custom use case template. + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the custom use case template. + + **Available Version:** 63.0 + type: string + queries: + description: | + List of queries defined in the custom use case template. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateQueryInputRepresentation" + tables: + description: | + List of tables referenced in the template queries. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateTableInputRepresentation" + useCaseConfigs: + description: | + 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 + type: object + additionalProperties: + oneOf: + - $ref: "#/components/schemas/MatchBoostUsecaseConfigInputRepresentation" + version: + description: | + Version of the custom use case template. + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateQueryConfig: + title: Custom Use Case Template Query Config Output + type: object + description: Represents the query configuration for a custom use case template for a clean room. + properties: + analysisConfigs: + description: | + Additional configurations for the template query, such as output location. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CustomUseCaseTemplateAnalysisConfigRepresentation" + description: + description: | + Description of the template query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the template query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + queryParameters: + description: | + List of query parameters. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateQueryParamRepresentation" + referencedTables: + description: | + List of tables referenced by the template query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + source: + description: | + Name of the template query that is to be executed. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of template query, such as `SQL` or `SparkSQL`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + useCase: + description: | + Name of the use case associated with the template query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateQueryInputRepresentation: + title: Custom Use Case Template Query Input + type: object + description: Represents the input for querying a custom use case template for a clean room. + properties: + queryConfigs: + description: | + List of queries defined in the custom use case template. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateQueryConfig" + CustomUseCaseTemplateQueryParamConfig: + title: Custom Use Case Template Query Param Config Output + type: object + description: Represents the query parameter configuration for a custom use case template for a clean room. + properties: + description: + description: | + Description of the query parameter table column. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the query parameter table column. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of query parameter table value, such as `STRING`, `INTEGER`, or `BOOLEAN`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateQueryParamRepresentation: + title: Custom Use Case Template Query Param Output + type: object + description: Represents the query parameters defined for a custom use case template for a clean room. + properties: + queryParamConfigs: + description: | + List of queries defined in the template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateQueryParamConfig" + CustomUseCaseTemplateTableConfig: + title: Custom Use Case Template Table Config Output + type: object + description: Represents the configuration of a clean room custom use case template table. + properties: + columns: + description: | + List of columns in the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateColumnRepresentation" + description: + description: | + Description of the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the template table. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + role: + description: | + Role of the custom template, `Provider` or `Consumer`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + CustomUseCaseTemplateTableInputRepresentation: + title: Custom Use Case Template Table Input + type: object + description: Represents the input for a clean room custom use case template table. + properties: + tableConfigs: + description: | + List of tables referenced in the template query. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CustomUseCaseTemplateTableConfig" + DailyScheduleInputRepresentation: + title: Daily Schedule Input + description: Represents the input for creating a daily schedule. + allOf: + - $ref: "#/components/schemas/ScheduleInputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule will run. You can specify multiple days. + + **Available Version:** 61.0 + type: array + items: + type: string + interval: + description: | + Hourly interval at which segments can be published, from `1` through `24`. + + **Available Version:** 61.0 + type: integer + runFrom: + description: | + Start time for a rapid publish. + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpTimeInputRepresentation" + runTo: + description: | + End time for a rapid publish. + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpTimeInputRepresentation" + DailyScheduleRepresentation: + title: Daily Schedule Output + description: Represents a segment publication schedule that runs every day. + allOf: + - $ref: "#/components/schemas/ScheduleOutputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule will run. You can specify multiple days. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + interval: + description: | + Hourly interval at which segments can be published, from `1` through `24`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + runFrom: + description: | + Start time for a rapid publish. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/TimeOutputRepresentation" + runTo: + description: | + End time for a rapid publish. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/TimeOutputRepresentation" + DataActionConditionOutputRepresentation: + title: Data Action Condition Output + description: Represents DataActionCondition output. + type: object + properties: + conditionSourceType: + description: | + Source type of the data action's condition. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + conditionType: + description: | + Type of the data action's condition. This type differentiates between regular and additional conditions. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataGraphName: + description: | + Name of the data action's graph. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + fieldName: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectDataGraphName: + description: | + Object data graph name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectName: + description: | + Object name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + operator: + description: | + Data action operator. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + order: + description: | + Data action order. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + value: + description: | + Value + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataActionEnrichmentOutputRepresentation: + title: Data Action Enrichment Output + description: Represents data action enrichment output. + type: object + properties: + dataActionProjectedFields: + description: | + Data action projected fields. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionProjectedFieldOutputRepresentation" + dataActionRelationshipEdges: + description: | + Data action relationship edges. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataActionRelationshipEdgeOutputRepresentation" + dataGraphApiName: + description: | + API name of the Data graph. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enrichmentName: + description: | + Name of the enrichment. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataActionProjectedFieldOutputRepresentation: + title: Data Action Projected Field Output + description: Represents the projected field output for a create data action request. + type: object + properties: + fieldAliasName: + description: | + Field's alias name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + fieldApiName: + description: | + Field's API name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectApiName: + description: | + Object's API Name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectDataGraphName: + description: | + Object's data graph name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataActionRelationshipEdgeOutputRepresentation: + title: Data Action Relationship Edge Output + description: Represents the DataActionRelationshipEdgeOutput + type: object + properties: + sourceFieldApiName: + description: | + Source field's API name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + sourceObjectApiName: + description: | + Source object's API Name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + targetFieldApiName: + description: | + Target field's API name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + targetObjectApiName: + description: | + Target object's API name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + targetObjectDataGraphName: + description: | + Target object's data graph name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataActionSourceOutputRepresentation: + title: Data Action Source Output + description: Represents the data action source output. + type: object + properties: + actionsSourceObject: + description: | + Data action's source output. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + actionsSourceObjectPath: + description: | + Path of the data action's source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + actionsSourceObjectType: + description: | + Type of the data action's source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + developerName: + description: | + Developer name of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectDevName: + description: | + Developer name for the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectId: + description: | + ID of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectLinkedUiRecordId: + description: | + Linked UI record ID of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectLinkedUiRecordName: + description: | + Linked UI record name for the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectMasterLabel: + description: | + Label of the data action's source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectName: + description: | + Name of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + objectType: + description: | + Type of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + subscriptionModes: + description: | + Subscription modes of the data action source object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + enum: + - Create + - Delete + - Update + type: string + DataCleanRoomAcceptInvitationInputRepresentation: + title: Data Clean Room Accept Invitation Input + type: object + description: Represents the input for accepting an invitation to a clean room collaboration. + properties: + dataSpaceName: + description: | + Name of the data space in which to accept the invitation. + + **Available Version:** 66.0 + type: string + invitationId: + description: | + Record ID of of the collaboration invitation. + + **Available Version:** 63.0 + type: string + outputConfiguration: + description: | + Configuration details for the output. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomOutputConfigurationRepresentation" + specificationId: + description: | + Record ID of the clean room specification. + + **Available Version:** 63.0 + type: string + required: + - invitationId + - specificationId + DataCleanRoomAwsS3ConnectionAttributesRepresentation: + title: Data Clean Room AWS S3 Connection Attributes Input + description: Represents the attributes for an AWS S3 connection. + allOf: + - $ref: "#/components/schemas/DataCleanRoomConnectionAttributesRepresentation" + - type: object + properties: + roleArn: + description: | + IAM role used to connect to the provided S3 URL. + + **Available Version:** 66.0 + type: string + s3Url: + description: | + Full path of the S3 bucket with folders where the user wants the data to be shared. + + **Available Version:** 66.0 + type: string + DataCleanRoomAwsS3OutputDestinationConfigRepresentation: + title: Data Clean Room Aws S3 Output Destination Config Output + description: AWS S3 output destination configuration for Data Clean Room + allOf: + - $ref: "#/components/schemas/DataCleanRoomOutputDestinationConfigRepresentation" + - type: object + properties: + roleArn: + description: | + IAM role ARN for S3 access. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + s3Url: + description: | + S3 bucket URL with full path. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomAWSSourceConfigInputRepresentation: + title: Data Clean Room AWS Source Config Input + description: Represents the source type configuration input for a clean room AWS provider. + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigInputRepresentation" + - type: object + properties: + accountId: + description: | + Account ID of the AWS provider. + + **Available Version:** 63.0 + type: string + supportedRegions: + description: | + Supported AWS regions for the clean room. + + **Available Version:** 63.0 + type: array + items: + type: string + DataCleanRoomAWSSourceConfigRepresentation: + title: Data Clean Room AWS Source Config Output + description: Represents the source type configuration for a clean room AWS provider. + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigRepresentation" + - type: object + properties: + accountId: + description: | + Account ID of the AWS provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + supportedRegions: + description: | + Supported AWS regions for the clean room. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + DataCleanRoomCollaborationCollectionForUseCaseTypeRepresentation: + title: Data Clean Room Collaboration Collection For Use Case Type Output + description: Represents a list of collaborations for a given use case template. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + collaborations: + description: | + List of collaborations. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomCollaborationForUseCaseTypeRepresentation" + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + offset: + description: | + Number of records to skip for the next request. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + DataCleanRoomCollaborationCollectionRepresentation: + title: Data Clean Room Collaboration Collection Output + description: Represents a collection of clean room collaborations. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + collaborations: + description: | + List of clean room collaborations. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomCollaborationRepresentation" + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + offset: + description: | + Number of records to skip. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + DataCleanRoomCollaborationForUseCaseTypeRepresentation: + title: Data Clean Room Collaboration For Use Case Type Output + description: Represents a collaboration for a given use case template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataSpace: + description: | + Name of the data space. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataSpaceRepresentation" + description: + description: | + Description of the clean room. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + members: + description: | + List of collaboration members. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMemberForUseCaseTypeRepresentation" + outputObjectToDevName: #include this property? + description: | + Map of output object names to their developer names. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: object + additionalProperties: + type: string + status: + description: | + Status of the clean room. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Active + - Disabled + - Error + - Inactive + templateVersion: + description: | + Version information of the template from which the clean room was created. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomTemplateRepresentation" + DataCleanRoomCollaborationInputRepresentation: + title: Data Clean Room Collaboration Input + description: Represents the input for a clean room collaboration. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + apiKey: + description: | + API key of the clean room. + + **Available Version:** 63.0 + type: string + dataCloudOrgId: + description: | + Core org ID where the Data 360 clean room is enabled. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space where the collaboration is to be created. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the clean room. + + **Available Version:** 63.0 + type: string + providerDevName: + description: | + Developer name of the provider definition for the clean room. + + **Available Version:** 63.0 + type: string + specificationDevName: + description: | + Developer Name of the clean room specification. + + **Available Version:** 63.0 + type: string + templateName: + description: | + Developer name of the use case template that the collaboration is to support. + + **Available Version:** 63.0 + type: string + templateVersionId: + description: | + Template version ID that the collaboration is to support. + + **Available Version:** 63.0 + type: string + required: + - dataCloudOrgId + - label + - providerDevName + - specificationDevName + - templateName + DataCleanRoomCollaborationRepresentation: + title: Data Clean Room Collaboration Output + description: Represents a clean room collaboration. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + apiKey: + description: | + API key of the clean room. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + dataSpace: + description: | + Data space details for the clean room. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataSpaceRepresentation" + description: + description: | + Description of the collaboration. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + members: + description: | + List of the collaboration members. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMemberRepresentation" + status: + description: | + Status of the collaboration. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Active + - Disabled + - Error + - Inactive + templateVersion: + description: | + Information about the template version that the collaboration supports. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomTemplateRepresentation" + DataCleanRoomCollaborationResultDataObjectCollectionRepresentation: + title: Data Clean Room Collaboration Result Data Object Collection Output + type: object + description: Represents a list of data objects created by a clean room collaboration. + properties: + collaborationResultDataObjects: + description: | + List of DMOs created by the collaboration. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomCollaborationResultDataObjectRepresentation" + DataCleanRoomCollaborationResultDataObjectRepresentation: + title: Data Clean Room Collaboration Result Data Object Output + description: Represents a data object created by a clean room collaboration. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + status: + description: | + Status of the DMO. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Active + - Error + - Inactive + - Processing + DataCleanRoomConnectionAttributesRepresentation: + title: Data Clean Room Connection Attributes Input + type: object + description: | + Base class for clean room connection attributes. Abstract parent of: + - DataCleanRoomAwsS3ConnectionAttributesRepresentation + - DataCleanRoomSnowflakeConnectionAttributesRepresentation + properties: + connectorType: + description: | + Type of metadata connector. + + **Available Version:** 66.0 + type: string + enum: + - CleanroomAwsS3 + - CleanroomSnowflake + DataCleanRoomDataSpecificationInputRepresentation: + title: Data Clean Room Data Specification Input + description: Represents the input for a clean room specification. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + dataMapping: + description: | + Data mapping details for a clean room member. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/UseCaseTemplateMappingRepresentation" + dataSpaceName: + description: | + Name of the data space where the specification is to be created. + + **Available Version:** 63.0 + type: string + description: + description: | + Description of the mapping. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the clean room specification. + + **Available Version:** 63.0 + type: string + memberType: + description: | + Type of clean room member, `Provider` or `Consumer`. + + **Available Version:** 63.0 + type: string + ownerOrgId: + description: | + Data 360 org ID where the mapping is to be created. + + **Available Version:** 63.0 + type: string + templateName: + description: | + Name of the use case template for which the mapping is provided. + + **Available Version:** 63.0 + type: string + templateType: + description: | + Type of template. + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Salesforce + templateVersionId: + description: | + Template version ID that is to be used for mapping. + + **Available Version:** 63.0 + type: string + useCaseType: + description: | + Type of use case template. + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Overlap + required: + - dataMapping + - label + - memberType + - ownerOrgId + - templateName + - templateType + - templateVersionId + - useCaseType + DataCleanRoomDataSpecificationRepresentation: + title: Data Clean Room Data Specification Output + description: Represents a clean room specification. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataMapping: + description: | + Data mapping details for a clean room member in JSON format. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateMappingRepresentation" + dataSpace: + description: | + Data space details for the clean room. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataSpaceRepresentation" + description: + description: | + Description of the specification. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + memberType: + description: | + Type of clean room member. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Consumer + - Provider + ownerOrgId: + description: | + Data 360 org ID where the mapping is created. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + status: + description: | + Status of the specification. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Active + - Error + - Inactive + - Processing + templateVersion: + description: | + Details of the use case template version for which the mapping is provided. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomTemplateRepresentation" + DataCleanRoomDCSourceConfigInputRepresentation: + title: Data Clean Room DC Source Config Input + description: Represents the source type configuration input for a clean room DATA_CLOUD (DC) provider. + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigInputRepresentation" + - type: object + properties: + dataCloudOrgId: + description: | + Core org ID where Data 360 clean room is enabled. + + **Available Version:** 63.0 + type: string + domainUrl: + description: | + Domain URL of the provider. + + **Available Version:** 63.0 + type: string + offCoreTenantId: + description: | + Off-core tenant ID of the provider. + + **Available Version:** 63.0 + type: string + DataCleanRoomDCSourceConfigRepresentation: + title: Data Clean Room DC Source Config Output + description: Represents the source type configuration for a clean room DATA_CLOUD (DC) provider. + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigRepresentation" + - type: object + properties: + dataCloudOrgId: + description: | + Core org ID where Data 360 clean room is enabled. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + domainUrl: + description: | + Domain URL of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + offCoreTenantId: + description: | + Off-core tenant ID of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataCleanRoomGenericResponseRepresentation: + title: Data Clean Room Generic Response Output + description: Generic response representation for clean room APIs. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation: + title: Data Clean Room Match Boost Output Bridge Table Path Attribute Output + type: object + description: Represents the bridge table path attribute for a match boost use case template object. + properties: + fieldName: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + objectName: + description: | + Name of the object. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation: + title: Data Clean Room Match Boost Output Bridge Table Path Output + type: object + description: Represents the bridge table path for a match boost use case template object. + properties: + sourceAttribute: + description: | + Source attribute of the path. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation" + targetAttribute: + description: | + Target attribute of the path. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation" + DataCleanRoomMatchBoostOutputBridgeTableRepresentation: + title: Data Clean Room Match Boost Output Bridge Table Output + type: object + description: Represents the bridge table for a match boost use case template object. + properties: + sourceIdFieldName: + description: | + Column name corresponding to the equivalent column in the shared data. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomMatchBoostOutputObjectConfigRepresentation: + title: Data Clean Room Match Boost Output Object Config Output + type: object + description: Represents the configuration for a match boost use case template object. + properties: + bridgeTable: + description: | + Details about the object bridge table. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputBridgeTableRepresentation" + objectName: + description: | + Name of the object. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + relatedTable: + description: | + Details about the related table. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputRelatedTableRepresentation" + DataCleanRoomMatchBoostOutputObjectRepresentation: + title: Data Clean Room Match Boost Output Object Output + type: object + description: Represents the configuration for match boost use case template objects. + properties: + outputObjectConfigs: + description: | + Configuration of the output objects. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputObjectConfigRepresentation" + DataCleanRoomMatchBoostOutputRelatedTableRepresentation: + title: Data Clean Room Match Boost Output Related Table Output + type: object + description: Represents the related table for a match boost use case template object. + properties: + pathFromBridgeTable: + description: | + Path details that identify the relationship between the bridge table and the object. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation" + sourceObjectName: + description: | + Name of the source object. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomMatchBoostUsecaseConfigRepresentation: + title: Data Clean Room Match Boost Usecase Config Output + description: Represents the configuration for a match boost use case template. + allOf: + - $ref: "#/components/schemas/DataCleanRoomUsecaseConfigRepresentation" + - type: object + properties: + outputObjects: + description: | + List of output objects for the use case template. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostOutputObjectRepresentation" + supportedContactPoints: + description: | + List of contact points supported by the provider. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + type: string + enum: + - Email + - PhoneNumber + DataCleanRoomMemberConfigRepresentation: + title: Data Clean Room Member Config Output + type: object + description: Represents the member configuration for a clean room collaboration. + properties: + externalId: + description: | + ID of the output destination connection. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + id: + description: | + ID of the member configuration. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + outputDestinationConfig: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataCleanRoomAwsS3OutputDestinationConfigRepresentation" + - $ref: "#/components/schemas/DataCleanRoomSnowflakeOutputDestinationConfigRepresentation" + outputDestinationId: + description: | + ID or reference key of the output destination. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + outputDestinationType: + description: | + Type of output destination. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - ExternalConnector + - Lakehouse + templateVersionId: + description: | + ID or reference key to the template version. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomMemberForUseCaseTypeRepresentation: + title: Data Clean Room Member For Use Case Type Output + description: Represents a collaboration member for a given use case template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + collaborationEntity: + description: | + Developer name of the collaboration entity. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + memberId: + description: | + ID of the member. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + memberOrgId: + description: | + ID of the member org. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + memberStatus: + description: | + Status of the member. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Active + - Inactive + - Mapping_Incomplete + memberType: + description: | + Type of member. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Consumer + - Provider + providerId: + description: | + ID or reference key to provider record. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + providerName: + description: | + Name of the provider. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + specificationId: + description: | + ID or reference key to specification record. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomMemberRepresentation: + title: Data Clean Room Member Output + description: Represents a member of a clean room collaboration. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + invitationId: + description: | + ID of the invitation that enabled the member to join the collaboration. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + invitationStatus: + description: | + Status of the invitation. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Accept_Error + - Accept_Initiated + - Accepted + - Pending + - Received + - Reject_Error + - Reject_Initiated + - Rejected + - Send_Error + - Sent + memberConfigs: + description: | + List of member configurations. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMemberConfigRepresentation" + memberDataCloudRegion: + description: | + Region of the member org. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + memberDomainUrl: + description: | + Domain URL of the member org. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + memberId: + description: | + ID of the collaboration member. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + memberOrgId: + description: | + ID of the collaboration member's org. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + memberStatus: + description: | + Status of the collaboration member. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Active + - Inactive + - Mapping_Incomplete + memberType: + description: | + Type of collaboration member. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Consumer + - Provider + providerId: + description: | + Reference key of the provider record of the clean room. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + specificationId: + description: | + Reference key of the data specification record of the clean room. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataCleanRoomMetadataConfigurationRepresentation: + title: Data Clean Room Metadata Configuration Output + type: object + description: Represents the metadata configuration for a clean room. + properties: + memberConfig: + description: | + List of member-specific metadata configurations. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomMetadataMemberConfigRepresentation" + usecaseConfig: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataCleanRoomMatchBoostUsecaseConfigRepresentation" + DataCleanRoomMetadataMemberConfigRepresentation: + title: Data Clean Room Metadata Member Config Output + type: object + description: Represents the metadata member configuration for a clean room. + properties: + canReceiveResult: + description: | + Indicates whether the member can receive results (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + canTriggerQuery: + description: | + Indicates whether the member can trigger queries (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + contributesData: + description: | + Indicates whether the member contributes data (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + outputConfig: + description: | + Output configuration for query results. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMetadataOutputConfigRepresentation" + paysForQueries: + description: | + Indicates whether the member pays for queries (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 66.0 + type: boolean + type: + description: | + Type of member. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Consumer + - Provider + DataCleanRoomMetadataOutputConfigRepresentation: + title: Data Clean Room Metadata Output Config + type: object + description: Represents the metadata member output configuration for a clean room. + properties: + connectorType: + description: | + Type of connector. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - CleanroomAwsS3 + - CleanroomSnowflake + destinationType: + description: | + Type of output destination. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - ExternalConnector + - Lakehouse + DataCleanRoomOutputConfigurationRepresentation: + title: Data Clean Room Output Configuration Input + type: object + description: Represents the input for clean room output configurations. + properties: + connectionAttributes: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataCleanRoomAwsS3ConnectionAttributesRepresentation" + - $ref: "#/components/schemas/DataCleanRoomSnowflakeConnectionAttributesRepresentation" + externalId: + description: | + Specification ID for the mapping details. + + **Available Version:** 66.0 + type: string + outputDestinationType: + description: | + Type of output destination. + + **Available Version:** 66.0 + type: string + enum: + - ExternalConnector + - Lakehouse + required: + - outputDestinationType + DataCleanRoomOutputDestinationConfigRepresentation: + title: Data Clean Room Output Destination Config Output + type: object + description: | + Base class representing the clean room output destination configuration. Abstract parent of: + - DataCleanRoomAwsS3OutputDestinationConfigRepresentation + - DataCleanRoomSnowflakeOutputDestinationConfigRepresentation + properties: + connectorType: + description: | + Connector type of the output destination. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - CleanroomAwsS3 + - CleanroomSnowflake + DataCleanRoomProviderCollectionRepresentation: + title: Data Clean Room Provider Collection Output + description: Represents a collection of clean room providers. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + offset: + description: | + Number of records skipped. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + providers: + description: | + List of provider definitions. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomProviderRepresentation" + DataCleanRoomProviderInputRepresentation: + title: Data Clean Room Provider Input + description: Represents the input for a clean room provider. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + dataCloudOrgId: + description: | + Core org ID where the Data 360 clean room is enabled. + + **Available Version:** 63.0 + type: string + domainUrl: + description: | + Domain URL of the provider. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the provider definition. + + **Available Version:** 63.0 + type: string + logoUrl: + description: | + URL path to the provider logo. + + **Available Version:** 63.0 + type: string + offCoreTenantId: + description: | + Off core tenant ID of the provider. + + **Available Version:** 63.0 + type: string + packageType: + description: | + Type of provider package. + + **Available Version:** 66.0 + type: string + enum: + - DataCollaboration + - IdEnrichment + providerDataSource: + description: | + Source of the provider data. + + **Available Version:** 66.0 + type: string + enum: + - Snowflake + providerName: + description: | + Name of the provider. + + **Available Version:** 63.0 + type: string + source: + description: | + Source of the provider. + + **Available Version:** 63.0 + type: string + enum: + - AWS + - DATA_CLOUD + sourceConfiguration: + description: | + 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 + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigInputRepresentation" + templateJson: + description: | + Custom JSON template configuration for extensible template flow. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CustomUseCaseTemplateInputRepresentation" + templateNames: + description: | + List of use case templates that the provider supports. + + **Available Version:** 63.0 + type: array + items: + type: string + templateType: + description: | + Type of use case template. + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Salesforce + useCaseTypeConfig: + description: | + Configuration for the type of use case template. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomUseCaseTypeInputRepresentation" + required: + - label + DataCleanRoomProviderRepresentation: + title: Data Clean Room Provider Output + description: Represents a clean room provider. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + creationType: + description: | + Type of provider creation. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - Packaged + - Peer + dataCloudOrgId: + description: | + Core org ID where Data 360 clean room is enabled. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + description: + description: | + Description of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + domainUrl: + description: | + Domain URL of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + logoUrl: + description: | + URL of the provider logo. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + offCoreTenantId: + description: | + Off-core tenant ID of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + packageType: + description: | + Type of package. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - DataCollaboration + - IdEnrichment + providerDataSource: + description: | + Source of the provider's data. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Snowflake + providerName: + description: | + Name of the provider. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + source: + description: | + Source type of the provider. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - AWS + - DATA_CLOUD + sourceConfiguration: + description: | + 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 + allOf: + - $ref: "#/components/schemas/DataCleanRoomProviderSourceConfigRepresentation" + templateNames: + description: | + List of template names. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + useCaseTypeConfig: + description: | + Configuration for the type of use case template. + + **Filter Group:** Small + + **Available Version:** 65.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomUseCaseTypeRepresentation" + DataCleanRoomProviderSourceConfigInputRepresentation: + title: Data Clean Room Provider Source Config Input + description: Represents the source type configuration input for a clean room provider. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/DataCleanRoomAWSSourceConfigInputRepresentation" + - $ref: "#/components/schemas/DataCleanRoomDCSourceConfigInputRepresentation" + properties: + type: + description: | + Source type of the provider. + + **Available Version:** 63.0 + type: string + enum: + - AWS + - DATA_CLOUD + DataCleanRoomProviderSourceConfigRepresentation: + title: Data Clean Room Provider Source Config Output + description: Represents the source configuration for a clean room provider. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/DataCleanRoomAWSSourceConfigRepresentation" + - $ref: "#/components/schemas/DataCleanRoomDCSourceConfigRepresentation" + properties: + type: + description: | + Source type of the provider. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - AWS + - DATA_CLOUD + DataCleanRoomQueryJobCollectionRepresentation: + title: Data Clean Room Query Job Collection Output + description: Represents a collection of query jobs for a clean room. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + offset: + description: | + Number of records skipped. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + queryJobs: + description: | + List of query jobs for a clean room. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomQueryJobRepresentation" + DataCleanRoomQueryJobInputRepresentation: + title: Data Clean Room Query Job Input + type: object + description: Represents the input for a query job for a clean room. + properties: + queryExecutionName: + description: | + Name of the query that is to be executed. + + **Available Version:** 63.0 + type: string + queryParameters: + description: | + Map of query parameters and their values. + + **Available Version:** 63.0 + type: object + additionalProperties: + type: string + segmentIds: + description: | + Segment IDs on which the query is to be executed. + + **Available Version:** 63.0 + type: array + items: + type: string + required: + - queryExecutionName + DataCleanRoomQueryJobRepresentation: + title: Data Clean Room Query Job Output + description: Represents a query job for a clean room. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + completedDate: + description: | + Date and time the query run job was completed. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + errorCode: + description: | + Error code (if any) caused by a query failure. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + errorMessage: + description: | + Error message (if any) that specifies the query failure reason. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + executedBy: + description: | + Name of the user who executed the query job. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + outputDMOName: + description: | + 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 + type: string + queryParam: + description: | + Map of query parameters and their values. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + additionalProperties: + type: string + reportId: + description: | + ID of the report associated with the output DMO. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + reportName: + description: | + Name of the report associated with the output DMO. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + segmentNames: + description: | + List of segment names. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + status: + description: | + Status of the query job. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Created + - Failed + - Running + - Success + triggeredDate: + description: | + Date and time the query run job was started. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataCleanRoomRejectInvitationInputRepresentation: + title: Data Clean Room Reject Invitation Input + type: object + description: Represents the input for rejecting an invitation to a clean room collaboration. + properties: + invitationId: + description: | + Record ID of the collaboration invitation. + + **Available Version:** 63.0 + type: string + required: + - invitationId + DataCleanRoomSnowflakeConnectionAttributesRepresentation: + title: Data Clean Room Snowflake Connection Attributes Input + description: Represents the attributes for a Snowflake connection. + allOf: + - $ref: "#/components/schemas/DataCleanRoomConnectionAttributesRepresentation" + - type: object + properties: + accountUrl: + description: | + URL of the provider's Snowflake account. + + **Available Version:** 66.0 + type: string + databaseName: + description: | + Name of the database containing the provider's final dataset. + + **Available Version:** 66.0 + type: string + schemaName: + description: | + Name of the schema containing the provider's final dataset. + + **Available Version:** 66.0 + type: string + serviceUser: + description: | + Name of the user authorized to access the shared database and schema. + + **Available Version:** 66.0 + type: string + warehouseName: + description: | + Name of the warehouse used to host or process the provider's final dataset. + + **Available Version:** 66.0 + type: string + DataCleanRoomSnowflakeOutputDestinationConfigRepresentation: + title: Data Clean Room Snowflake Output Destination Config Output + description: Snowflake output destination configuration for Data Clean + Room + allOf: + - $ref: "#/components/schemas/DataCleanRoomOutputDestinationConfigRepresentation" + - type: object + properties: + accountUrl: + description: | + Snowflake account URL. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + databaseName: + description: | + Snowflake database name. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + schemaName: + description: | + Snowflake schema name. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + serviceUser: + description: | + Snowflake service user. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + warehouseName: + description: | + Snowflake warehouse name. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + DataCleanRoomSpecificationCollectionRepresentation: + title: Data Clean Room Specification Collection Output + description: Represents a collection of clean room specifications. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + cleanroomSpecifications: + description: | + List of clean room specifications. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomDataSpecificationRepresentation" + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + offset: + description: | + Number of records skipped. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + DataCleanRoomTemplateCollectionRepresentation: + title: Data Clean Room Template Collection Output + description: Represents a collection of use case templates for a clean room. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + limit: + description: | + Number of records returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + offset: + description: | + Number of records skipped. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + templates: + description: | + List of use case templates. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataCleanRoomTemplateRepresentation" + DataCleanRoomTemplateRepresentation: + title: Data Clean Room Template Output + description: Represents a use case template for a clean room. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + configuration: + description: | + Configuration of the use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateConfigRepresentation" + description: + description: | + Description of the use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + metadataConfiguration: + description: | + Configuration metadata containing member-specific settings and use-case-dependent operational parameters. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/DataCleanRoomMetadataConfigurationRepresentation" + providerId: + description: | + Provider ID that the template is associated with. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + queryTemplate: + description: | + Defined query template for the use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + templateType: + description: | + Type of use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Salesforce + templateVersion: + description: | + Version of the use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + useCaseType: + description: | + Type of use case for the template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Custom + - Overlap + DataCleanRoomUsecaseConfigInputRepresentation: + title: Data Clean Room Usecase Config Input + type: object + description: | + Base class for a use case configuration. Abstract parent of: + - MatchBoostUsecaseConfigInputRepresentation + properties: + useCaseType: + description: | + Type of use case template. + + **Available Version:** 66.0 + type: string + enum: + - Activation + - Custom + - MatchBoost + - Overlap + DataCleanRoomUsecaseConfigRepresentation: + title: Data Clean Room Usecase Config Output + type: object + description: | + Base class for the use case metadata configuration for a clean room. Abstract parent of: + - DataCleanRoomMatchBoostUsecaseConfigRepresentation + properties: + useCaseType: + description: | + Type of use case template. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Activation + - Custom + - MatchBoost + - Overlap + DataCleanRoomUseCaseTypeInputRepresentation: + title: Data Clean Room Use Case Type Input + type: object + description: Represents the input for a type of clean room use case. + properties: + useCaseTypes: + description: | + List of queries defined in the template. + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - Custom + - Overlap + DataCleanRoomUseCaseTypeRepresentation: + title: Data Clean Room Use Case Type Output + description: Represents the type of clean room use case. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + useCaseTypes: + description: | + List of supported use case types. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - Custom + - Overlap + DataConnectionInputRepresentation: + title: Data Connection Input + description: Input representation for a data connector. + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + - type: object + properties: + credentials: + description: | + List of key-value pairs that provide credentials for the data connection. Credentials values are masked. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + method: + description: | + Type of the data connection. + + **Available Version:** 61.0 + type: string + enum: + - Egress + - Ingress + parameters: + description: | + List of key-value pairs that provide parameters for the data connection. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + required: + - credentials + - method + - parameters + DataConnectionParameterInputRepresentation: + title: Data Connection Parameter Input + description: Key-value pair for credentials and parameters of a data connection. + type: object + allOf: + - type: object + properties: + paramName: + description: | + Name of the parameter. Each attribute of the connector metadata is a possible parameter name that you provide. + + **Available Version:** 61.0 + type: string + value: + description: | + Value of the parameter. + + **Available Version:** 61.0 + type: string + required: + - paramName + - value + DataConnectionParameterRepresentation: + title: Data Connection Parameter Output + description: Represents a key-value pair for credentials and parameters of a data connection. + type: object + properties: + paramName: + description: | + 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 + type: string + value: + description: | + Value of the parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + DataConnectionRepresentation: + title: Data Connection Output + description: Represents a data connector. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + connectorLabel: + description: | + Label of the connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + credentials: + description: | + List of key-value pairs that provide credentials for the data connector. Credentials values are masked. + + **Filter Group:** Big + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterRepresentation" + deletable: + description: | + Indicates whether the data connector is deletable (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + editable: + description: | + Indicates whether the data connector is editable (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + iconUrl: + description: | + URL for the data connector icon. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + lastDataChangeErrorCode: + description: | + Error code for the last change to the data connector. + + **Filter Group:** Medium + + **Available Version:** 61.0 + type: string + lastSyncDate: + description: | + Date of the last sync of the data connector. + + **Filter Group:** Medium + + **Available Version:** 61.0 + type: string + method: + description: | + Type of connection method for the data connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Egress + - Ingress + params: + description: | + List of key-value pairs that provide parameters for the data connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterRepresentation" + status: + description: | + Status of the data connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Connected + - Disconnected + - Failed + - NeedsReAuth + syncStatus: + description: | + Sync status of the data connector. + + **Filter Group:** Medium + + **Available Version:** 61.0 + type: string + enum: + - Failure + - InProgress + - InvalidCredentials + - None + - Pending + - Success + DataConnectorDetailsConfig: + title: Data Connector Details Config Input + description: Represents the configuration details for a data connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsConfig" + - type: object + properties: + name: + description: | + Name of the data connector. + + **Available Version:** 62.0 + type: string + DataConnectorDetailsRepresentation: + title: Data Connector Details Output + description: Represents the output for a data connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsRepresentation" + - type: object + DataConnectorInputRepresentation: + title: Data Connector Input + description: Represents the data connector details input. + type: object + properties: + name: + description: | + Name of the activation target. + + **Available Version:** 60.0 + type: string + outputFormat: + description: | + Output format for the activation target. + + **Available Version:** 60.0 + type: string + DataConnectorRepresentation: + title: Data Connector Output + description: Represents base class connector details. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + outputFormat: + description: | + Output format of the activation target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + DataCustomCodeInputRep: + title: Data Kit Deploy Data Custom Code Input + description: Represents the input component configuration for data custom code. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + templateDevName: + description: | + Developer name of the custom code template. + + **Available Version:** 63.0 + type: string + DataGraphFieldRepresentation: + title: Data Graph Field Output + description: Represents a field of a data graph. + type: object + properties: + ciFieldType: + description: | + Type of the calculated insight field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Dimension + - Measure + - ObjectTypeUnspecified + dataGraphFieldDevName: + description: | + Developer name of the field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + dataType: + description: | + Data type of the field. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Boolean + - Date + - DateOnly + - DateTime + - Text + type: string + developerName: + description: | + Developer name of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + isProjected: + description: | + Indicates whether the field needs to be projected in output JSON (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + keyCol: + description: | + Indicates whether the field is a primary key (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + keyQualifierName: + description: | + Qualifier name of the key for the field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + length: + description: | + Length of the field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + lookupCol: + description: | + Lookup column of the field. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + usageTag: + description: | + Indicates whether the field represents a key qualifier field (`KEY_QUALIFIER`) or not (`NONE`). + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + DataGraphFullRefreshConfigInputRepresentation: + title: Data Graph Full Refresh Config Input + type: object + description: Represents the input for a full refresh data graph. + properties: + schedule: + description: | + Details about the full refresh schedule. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/DataGraphScheduleInputRepresentation" + DataGraphIdsDmoFieldRepresentation: + title: Data Graph IDs DMO Field Output + description: Represents the fields of the data model object (DMO) that contains the ID table for the data graph. + type: object + properties: + capabilities: + description: | + List of capabilities for the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + type: integer + dataType: + description: | + Data type of the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + developerName: + description: | + Developer name of the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + DataGraphIdsDmoRepresentation: + title: Data Graph IDs DMO Output + description: Represents data about the data model object (DMO) that contains the ID table for the data graph. + type: object + properties: + developerName: + description: | + Developer name of the DMO. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + fields: + description: | + List of fields for the DMO. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/DataGraphIdsDmoFieldRepresentation" + DataGraphObjectDataRepresentation: + title: Data Graph Object Data Output + description: Represents object data for a data graph. + type: object + properties: + dataGraphSourceDevName: + description: | + Developer name of the source data graph for the data object. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + developerName: + description: | + Developer name of the data object for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + fields: + description: | + List of fields for the data object of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/DataGraphFieldRepresentation" + filterCriteria: + description: | + Filter criteria for the data object of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + memberDmoName: + description: | + Name of the member data model object (DMO) for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + paths: + description: | + List of data path relationships for the object data of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/DataGraphRelationshipRepresentation" + recencyCriteria: + description: | + List of recency criteria for the object data of the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/RecencyCriteriaRepresentation" + relatedObjects: + description: | + Recursive list of related data objects for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/DataGraphObjectDataRepresentation" + type: + description: | + Data type of the data object for the data graph. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Adg + - AdgActivationAudience + - AdgExternal + - Bridge + - Calculated + - CalculatedRealTime + - CalculatedStreaming + - Curated + - Custom + - Derived + - MlPrediction + - ObjectTypeUnspecified + - Package + - SegmentMembership + - Standard + - System + - Transform + type: string + DataGraphRelationshipRepresentation: + title: Data Graph Relationship Output + description: Represents a data graph relationship. + type: object + properties: + cardinality: + description: | + Cardinality of the data graph relationship. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - CardinalityUnspecified + - ManyToOne + - OneToMany + - OneToOne + - Unrecognized + type: string + fieldName: + description: | + Field name of the data graph relationship. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + parentFieldName: + description: | + Parent field name of the data graph relationship. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + DataGraphScheduleInputRepresentation: + title: Data Graph Schedule Input + type: object + description: Represents the input for a data graph schedule. + properties: + frequency: + description: | + Frequency of the schedule refresh. + + **Available Version:** 67.0 + type: integer + timeGranularity: + description: | + Type of time granularity. + + **Available Version:** 67.0 + type: string + DataGraphValuesDmoFieldRepresentation: + title: Data Graph Values DMO Field Representation + description: Represents the fields of the data model object (DMO) that contains the JSON records for the data graph. + type: object + properties: + capabilities: + description: | + List of capabilities for the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + type: integer + dataType: + description: | + Data type of the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + developerName: + description: | + Developer name of the DMO field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + DataGraphValuesDmoRepresentation: + title: Data Graph Values DMO Output + description: Represents data about the data model object (DMO) that contains the JSON records for the data graph. + type: object + properties: + developerName: + description: | + Developer name of the DMO. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + fields: + description: | + List of fields for the DMO. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: '#/components/schemas/DataGraphValuesDmoFieldRepresentation' + DataKitAsyncRepresentation: + title: Data Kit Async Output + description: Represents a data kit un-deployment output. + type: object + properties: + jobId: + description: | + The queued job ID. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitComponentCollectionRepresentation: + title: Data Kit Component Collection Output + description: Represents a list of data kit components. + type: object + properties: + components: + description: | + List of data kit components. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentRepresentation" + externalRecordIdentifier: + description: | + External record ID for `DataStreamBundle` component types. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataKitComponentDependencyCollectionRepresentation: + title: Data Kit Component Dependency Collection Output + description: Represents a collection of component dependency details. + type: object + properties: + componentDependencies: + description: | + List of component dependencies. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentDependencyRepresentation" + DataKitComponentDependencyRepresentation: + title: Data Kit Component Dependency Output + description: Represents component dependency details. + type: object + properties: + id: + description: | + ID of the dependent object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + API name of the dependent object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + type: + description: | + Type of the dependent object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataKitComponentDeploymentStatus: + title: Data Kit Component Deployment Status + description: Represents the status of a component's single click deployment. + type: object + properties: + code: + description: | + Status code of the deployment job. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + message: + description: | + Response message of the deployment job. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + DataKitComponentDeploymentStatusRepresentation: + title: Data Kit Component Deployment Status Output + description: Represents the status of a component deployed from a data kit. + type: object + properties: + componentDetails: + description: | + List of components and their status. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DatakitComponentDetails" + status: + description: | + Current status of the component. + + **Filter Group:** Small + + **Available Version:** 62.0 + allOf: + - $ref: "#/components/schemas/DataKitComponentDeploymentStatus" + DatakitComponentDetails: + title: Data Kit Component Details Output + description: Represents the component details of a data kit. + type: object + properties: + componentId: + description: | + ID of the data kit component. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + dataKitName: + description: | + Developer name of the data kit. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + status: + description: | + Status of the data kit component. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Active + - Deleting + - Error + - Processing + type: string + DataKitComponentInfo: + title: Data Kit Component Info Output + type: object + description: Represents a component of a data kit. + properties: + componentType: + description: | + Type of data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - 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: + description: | + Developer name of the data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitComponentInfoBaseInputRepresentation: + title: Data Kit Component Info Base Input + description: Represents the input for data kit component information. + allOf: + - $ref: "#/components/schemas/DataKitComponentInfoInputRepresentation" + - type: object + properties: + label: + description: | + Label of the data kit component. + + **Available Version:** 63.0 + type: string + DataKitComponentInfoBaseRepresentation: + title: Data Kit Component Info Base Output + description: Represents information about a data kit component. + allOf: + - $ref: "#/components/schemas/DataKitComponentInfoRepresentation" + - type: object + properties: + label: + description: | + Label of the data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitComponentInfoBundleInputRepresentation: + title: Data Kit Component Info Bundle Input + description: Represents the input for bundle-specific component information. + allOf: + - $ref: "#/components/schemas/DataKitComponentInfoInputRepresentation" + - type: object + properties: + connectorType: + description: | + Type of data kit bundle connector. + + **Available Version:** 63.0 + type: string + enum: + - AccountEngagement + - Commerce + - Crm + - External + - IngestApi + - Mc + - MoreConnectors + - S3 + - StreamingApp + streams: + description: | + List of data streams. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/CdpDataKitStream" + DataKitComponentInfoBundleRepresentation: + title: Data Kit Component Info Bundle Output + description: Represents bundle-specific component information. + allOf: + - $ref: "#/components/schemas/DataKitComponentInfoRepresentation" + - type: object + properties: + connectorType: + description: | + Type of data kit bundle connector. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - AccountEngagement + - Commerce + - Crm + - External + - IngestApi + - Mc + - MoreConnectors + - S3 + - StreamingApp + streams: + description: | + List of data streams. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitStreamRepresentation" + DataKitComponentInfoInputRepresentation: + title: Data Kit Component Info Input + type: object + description: Represents the abstract base class for data kit component information. + properties: + name: + description: | + Name of the data kit component. + + **Available Version:** 63.0 + type: string + DataKitComponentInfoRepresentation: + title: Data Kit Component Info Output + type: object + description: Represents information about a data kit component. + properties: + name: + description: | + Name of the data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitComponentInputRepresentation: + title: Data Kit Component Input + type: object + description: Represents the input for a data kit component. + properties: + info: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataKitComponentInfoBundleInputRepresentation" # Use this for DataStreamBundle types + - $ref: "#/components/schemas/DataKitComponentInfoBaseInputRepresentation" # Use this as the fallback for all other types + type: + description: | + Type of the data kit component. + + **Available Version:** 63.0 + type: string + enum: + - 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: + title: Data Kit Component Output + type: object + description: Represents a data kit component. + properties: + info: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DataKitComponentInfoBundleRepresentation" # Use this for DataStreamBundle types + - $ref: "#/components/schemas/DataKitComponentInfoBaseRepresentation" # Use this as the fallback for all other types + type: + description: | + Type of data kit component. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - 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 + DataKitDefaultComponentInfo: + title: Data Kit Default Component Info Output + description: Represents information about the default data kit component. + allOf: + - $ref: "#/components/schemas/DataKitComponentInfo" + - type: object + DataKitDeployActivationTargetRepresentation: + title: Data Kit Deploy Activation Target Input + description: Represents the input component configuration for activation targets. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + componentName: + description: | + Developer name of the activation target. + + **Available Version:** 63.0 + type: string + targetDisplayName: + description: | + Label of the activation target. + + **Available Version:** 63.0 + type: string + DataKitDeployComponentConfigCopyField: + title: Data Kit Deploy Component Config Copy Field Input + description: Represents the input component configuration for copy field enrichments. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + templateDevName: + description: | + Developer name of the copy field enrichment template. + + **Available Version:** 63.0 + type: string + DataKitDeployComponentConfigForIRRelatedList: + title: Data Kit Deploy Component Config For IR Related List Input + description: Represents the input component configuration for IR-related lists. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + developerName: + description: | + Developer name of the IR-related list. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the IR-related list. + + **Available Version:** 63.0 + type: string + DataKitDeployComponentConfigIdentityResolutionInput: + title: Data Kit Deploy Component Config Identity Resolution Input + description: Represents the input component configuration for identity resolutions. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + dataKitDevName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + identityResolutionDevName: + description: | + Developer name of the identity resolution. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the identity resolution. + + **Available Version:** 63.0 + type: string + DataKitDeployComponentConfigSemanticModelInputRepresentation: + title: Data Kit Deploy Component Config Semantic Model Input + description: Represents the input component configuration for semantic search models. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the semantic search model. + + **Available Version:** 63.0 + type: string + baseSDMs: + description: | + Base SDM API names of the semantic search model. + + **Available Version:** 63.0 + type: array + items: + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + displayName: + description: | + Label of the semantic search model. + + **Available Version:** 63.0 + type: string + DataKitDeployDataCleanRoomMappingRepresentation: + title: Data Kit Deploy Data Clean Room Mapping Input + description: Represents the input component configuration for clean room specification mapping. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + componentName: + description: | + Name of the data kit component. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + DataKitDeployDataCleanRoomProviderRepresentation: + title: Data Kit Deploy Data Clean Room Provider Input + description: Represents the input component configuration for clean room providers. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + componentName: + description: | + Developer name of the clean room provider. + + **Available Version:** 63.0 + type: string + packageName: + description: | + Label of the clean room provider. + + **Available Version:** 63.0 + type: string + DataKitDeployDataConnectionRepresentation: + title: Data Kit Deploy Data Connection Input + description: Represents the input component configuration for data connections. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + name: + description: | + Developer name of the connection. + + **Available Version:** 63.0 + type: string + newCredentials: + description: | + Connection credentials to use in the target org. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + overrideLabel: + description: | + Override label to use in the target org. + + **Available Version:** 63.0 + type: string + overrideParameters: + description: | + Connection parameters to override in the target org. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataConnectionParameterInputRepresentation" + DataKitDeployDataGraphInputRepresentation: + title: Data Kit Deploy Data Graph Input + description: Represents the input component configuration for data graphs. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data graph. + + **Available Version:** 63.0 + type: string + name: + description: | + Developer name of the data graph. + + **Available Version:** 63.0 + type: string + primaryDMO: + description: | + Developer name of the primary DMO. + + **Available Version:** 63.0 + type: string + templateDevName: + description: | + Developer name of the data graph template. + + **Available Version:** 63.0 + type: string + DataKitDeployDataTransformRepresentation: + title: Data Kit Deploy Data Transform Input + description: Represents the input component configuration for data transforms. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API Name of the data transform. + + **Available Version:** 63.0 + type: string + componentProperties: + description: | + Component properties for different data transform types. + + **Available Version:** 63.0 + type: object + additionalProperties: + type: string + connection: + description: | + Specific connection utilized for DLO-based transforms. + + **Available Version:** 63.0 + type: string + currencyIsoCode: + description: | + Currency ISO code for data transform creation. + + **Available Version:** 63.0 + type: string + dataObjectOverrides: + description: | + Overrides for specific input and output data object names defined in the transform. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataTransformDataObjectOverride" + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + dataTransformDevName: + description: | + Developer name of the data transform. + + **Available Version:** 63.0 + type: string + dataTransformType: + description: | + Type of data transform. + + **Available Version:** 63.0 + type: string + definitionOverrides: + description: | + Specific name or label overrides for data definitions sourced from the origin organization. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataTransformDefinitionOverride" + label: + description: | + Label of the data transform. + + **Available Version:** 63.0 + type: string + DataKitDeployInputRepresentation: + title: Data Kit Deploy Input + description: Represents the basic input component configuration for data kit objects. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data kit component. + + **Available Version:** 63.0 + type: string + name: + description: | + API name of the data kit component. + + **Available Version:** 63.0 + type: string + templateName: + description: | + Developer name of the template. + + **Available Version:** 63.0 + type: string + DataKitDeployMarketActivationRepresentation: + title: Data Kit Deploy Market Activation Input + description: Represents the input component configuration for market activations. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + componentName: + description: | + Developer name of the activation. + + **Available Version:** 63.0 + type: string + dataKitName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + targetDisplayName: + description: | + Label of the activation. + + **Available Version:** 63.0 + type: string + DataKitDeployMarketSegmentRepresentation: + title: Data Kit Deploy Market Segment Input + description: Represents the input component configuration for market segments. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + dataKitName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the market segment. + + **Available Version:** 63.0 + type: string + name: + description: | + Developer name of the market segment. + + **Available Version:** 63.0 + type: string + targetDisplayName: + description: | + Target label for the market segment. + + **Available Version:** 63.0 + type: string + targetSegmentDeveloperName: + description: | + Target developer name for the market segment. + + **Available Version:** 63.0 + type: string + DataKitDeployPersonalizationInputRepresentation: + title: Data Kit Deploy Personalization Input + description: Represents the input component configuration for personalization objects. + allOf: + - $ref: "#/components/schemas/CdpDataKitDeployComponentConfig" + - type: object + properties: + apiName: + description: | + API name of the personalization object. + + **Available Version:** 63.0 + type: string + dataSpaceName: + description: | + Name of the data space to deploy the data kit component in. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the personalization object. + + **Available Version:** 63.0 + type: string + templateDeveloperName: + description: | + Developer name of the personalization object template. + + **Available Version:** 63.0 + type: string + DataKitDetails: + title: Data Kit Details Output + type: object + description: Represents the details of a data kit. + properties: + components: + description: | + List of data kit components. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentInfo" + developerName: + description: | + Developer name of the data kit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data kit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + publishingSequence: + description: | + Publishing sequence for the data kit components. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitDefaultComponentInfo" + DataKitInputRepresentation: + title: Data Kit Input + type: object + description: Represents the input for creating a new data kit. + properties: + components: + description: | + List of components to be included in the data kit. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentInputRepresentation" + dataKitDevName: + description: | + Developer name of the data kit. + + **Available Version:** 63.0 + type: string + dataKitType: + description: | + Type of data kit. + + **Available Version:** 63.0 + type: string + enum: + - None + - Sandbox + dataSpaceName: + description: | + Name of the data space for the data kit creation. + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data kit. + + **Available Version:** 63.0 + type: string + required: + - dataKitDevName + - DataKitType + - label + - components + DataKitKQConfigRepresentation: + title: Data Kit KQ Config Input + type: object + description: Represents the input for key qualifier (KQ) configurations. + properties: + dataSourceField: + description: | + Name of the data source object field on which the KQ field is defined. + + **Available Version:** 63.0 + type: string + dataSourceObject: + description: | + Name of the data source object on which the KQ field is defined. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + value: + description: | + Value of the KQ field. + + **Available Version:** 63.0 + type: string + DataKitOutputRepresentation: + title: Data Kit Collection Output + type: object + description: Represents a list of data kits. + properties: + dataKitDetails: + description: | + List of data kits. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitDetails" + DataKitPatchInputRepresentation: + title: Data Kit Patch Input + type: object + description: Represents the input for updating a data kit. + properties: + components: + description: | + List of data kit components. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentInputRepresentation" + required: + - components + DataKitRepresentation: + title: Data Kit Output + type: object + description: Represents data kit details. + properties: + components: + description: | + List of components in the data kit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitComponentRepresentation" + devName: + description: | + Developer name of the data kit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the data kit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitStreamRepresentation: + title: Data Kit Stream Output + type: object + description: Represents a single stream in a data kit's data stream bundle. + properties: + devName: + description: | + Developer name of the data kit stream. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + externalRecordIdentifier: + description: | + External record ID. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + fieldApiNames: + description: | + List of field API names. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + label: + description: | + Label of the data kit stream. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + DataKitUnDeployComponentDetails: + title: Data Kit UnDeploy Component Details Input + description: The details of a component to be un-deployed from a data kit. + type: object + properties: + name: + description: | + Name of the component to un-deploy. + + **Available Version:** 63.0 + type: string + type: + description: | + Data kit component type. + + **Available Version:** 63.0 + enum: + - ActivationTarget + - CalculatedInsight + - DataAction + - DataActionTarget + - DataConnection + - DataGraph + - DataLakeObject + - DataSemanticSearch + - DataShare + - DataStreamBundle + - DataTransform + - IdentityResolution + - MarketSegment + - MarketSegmentActivation + - MlConfiguredModel + - MlPredictionJob + - MlRetriever + - SemanticModel + type: string + required: + - name + - type + DataKitUnDeployInputRepresentation: + title: Data Kit UnDeploy Input + description: Input representation for undeploying the components in a DataKit + type: object + properties: + components: + description: | + Components from the data kit. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataKitUnDeployComponentDetails" + required: + - components + DataLakeFieldInputRepresentation: + title: Data Lake Field Input + description: Represents the input for a data lake object (DLO) field. + type: object + properties: + dataType: + description: | + Data type of the field. + + **Available Version:** 62.0 + enum: + - Boolean + - Currency + - Date + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Unsupported + - Url + type: string + isPrimaryKey: + description: | + Indicates whether the field is a primary key field (`true`) or not (`false`). + + **Available Version:** 62.0 + type: boolean + label: + description: | + Label of the field. + + **Available Version:** 60.0 + type: string + name: + description: | + API name of the field. + + **Available Version:** 60.0 + type: string + required: + - dataType + - isPrimaryKey + - label + - name + DataLakeFieldRepresentation: + title: Data Lake Field Output + description: Represents the output for a data lake object (DLO) field. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataType: + description: | + Data type of the DLO field. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - Currency + - Date + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Unsupported + - Url + type: string + isPrimaryKey: + description: | + Indicates whether this is the data lake field primary key (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + DataLakeObjectCollectionRepresentation: + title: Data Lake Object Collection Output + description: Represents an output collection of data lake objects (DLOs). + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + dataLakeObjects: + description: | + List of DLOs. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataLakeObjectRepresentation" + required: + - dataLakeObjects + DataLakeObjectInputRepresentation: + title: Data Lake Object Input + description: Represents the input for a data lake object (DLO). + allOf: + - $ref: "#/components/schemas/DataObjectInputRepresentation" + - type: object + properties: + category: + description: | + Category of the DLO. + + **Available Version:** 60.0 + enum: + - Directory_Table + - Engagement + - Insights + - Other + - Profile + type: string + dataLakeFieldInputRepresentations: + description: | + Information about DLO fields. For Ingestion API data streams, include only the primary key field. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataLakeFieldInputRepresentation" + dataspaceInfo: + description: | + Information about the data space. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceInputRepresentation" + eventDateTimeFieldName: + description: | + 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 + type: string + label: + description: | + Label of the DLO. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the DLO. + + **Available Version:** 60.0 + type: string + orgUnitIdentifierFieldName: + description: | + Name of the org unit identifier field. + + **Available Version:** 60.0 + type: string + recordModifiedFieldName: + description: | + Name of the record modified field. + + **Available Version:** 60.0 + type: string + required: + - category + - dataspaceInfo + - label + - name + DataLakeObjectPatchInputRepresentation: + title: Data Lake Object Patch Input + type: object + description: Represents the input for updating a DLO. + properties: + fields: + description: | + Fields of the DLO. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataLakeFieldInputRepresentation" + label: + description: | + Label of the DLO. + + **Available Version:** 60.0 + type: string + required: + - label + DataLakeObjectRepresentation: + title: Data Lake Object Output + description: Represents the output for a data lake object (DLO). + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + category: + description: | + Category of the DLO. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Directory_Table + - Engagement + - Other + - Profile + type: string + dataLakeFieldInfoRepresentation: + description: | + Information about the `DataLake` field of the DLO. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataLakeFieldRepresentation" + dataSpaceInfo: + description: | + Information about the data space. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceRepresentation" + eventDateTimeFieldName: + description: | + 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 + type: string + orgUnitIdentifierFieldName: + description: | + Name of the org unity identifier field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + recordModifiedFieldName: + description: | + Name of the record modified field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + status: + description: | + Status of the DLO. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Deleting + - Error + - Inactive + - Processing + type: string + required: + - category + - dataLakeFieldInfoRepresentation + - dataSpaceInfo + - status + DataModelObjectCollectionRepresentation: + title: Data Model Object Collection Output + description: Represents a collection of data model objects (DMOs). + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + dataModelObject: + description: | + List of DMOs. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataModelObjectRepresentation" + DataModelObjectInputRepresentation: + title: Data Model Object Input + description: Input representation for a DMO. + allOf: + - $ref: "#/components/schemas/DataObjectInputRepresentation" + - type: object + properties: + status: + description: | + Status of DMO. + + **Available Version:** 60.0 + enum: + - Active + - Error + - Inactive + - Processing + type: string + DataModelObjectRepresentation: + title: Data Model Object Output + description: DMO Definition + allOf: + - $ref: "#/components/schemas/DataObjectRepresentation" + - type: object + properties: + status: + description: | + Status of the DMO. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Error + - Inactive + - Processing + type: string + DataObjectFieldInputRepresentation: + title: Data Object Field Input + description: Represents the input fields in the data object. + type: object + properties: + isPrimaryKey: + description: | + Indicates whether this field is a primary key (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + keyQualifierFieldName: + description: | + Key qualifier field name. + + **Available Version:** 60.0 + type: string + label: + description: | + Label of the field. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field. + + **Available Version:** 60.0 + type: string + type: + description: | + Data type of the field. + + **Available Version:** 60.0 + enum: + - Boolean + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + type: string + required: + - isPrimaryKey + - label + - name + DataObjectFieldRepresentation: + title: Data Object Field Output + description: Represents a data object field. + type: object + properties: + isPrimaryKey: + description: | + Indicates whether this is the primary key (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + keyQualifierField: + description: | + Key qualifier field's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + label: + description: | + Field's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Field's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + type: string + DataObjectInputRepresentation: + title: Data Object Input + description: Input representation for a data object in Data 360. + allOf: + - $ref: "#/components/schemas/CdpObjectBaseInputRepresentation" + - type: object + properties: + category: + description: | + Category of the data object. + + **Available Version:** 60.0 + enum: + - Engagement + - Other + - Profile + type: string + eventDateTimeFieldName: + description: | + 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 + type: string + fields: + description: | + Fields in the data object. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataObjectFieldInputRepresentation" + recordModifiedFieldName: + description: | + Record modified field name. + + **Available Version:** 60.0 + type: string + type: + description: | + Type of data object. + + **Available Version:** 60.0 + enum: + - DataLakeObject + - DataModelObject + type: string + DataObjectRepresentation: + title: Data Object Output + description: Data object representation. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + category: + description: | + Category. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Engagement + - Other + - Profile + type: string + eventDateTimeFieldName: + description: | + 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 + type: string + fields: + description: | + List of fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataObjectFieldRepresentation" + recordModifiedFieldName: + description: | + Record modified field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type of data object. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - DataLakeObject + - DataModelObject + type: string + DataSourceNameConfigInputRepresentation: + title: Data Source Name Config Input + description: Represents the data source name configuration input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + dataSourceName: + description: | + Data source API name for the activation. + + **Available Version:** 60.0 + type: string + required: + - dataSourceName + DataSpaceCollectionRepresentation: + title: Data Space Collection Output + description: Represents a collection of data spaces. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + dataSpaces: + description: | + List of all data spaces. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceInfoRepresentation" + required: + - dataSpaces + DataSpaceFilterConditionApiConfig: + title: Data Space Filter Condition API Config Input + description: Represents the component configuration for a data lake object (DLO). + type: object + properties: + fieldName: + description: | + Field name for the filter condition . + + **Available Version: 61.0** + type: string + filterValue: + description: | + Filter value for the filter condition. + + **Available Version: 61.0** + type: string + operator: + description: | + Operator for the filter condition. + + **Available Version: 61.0** + type: string + targetObjectName: + description: | + Target object name for the filter condition. + + **Available Version: 61.0** + type: string + required: + - fieldName + - filterValue + - operator + - targetObjectName + DataSpaceFilterConditionCollectionRepresentation: + title: Data Space Filter Condition Collection Input + description: Represents a data space input filter on a data lake object (DLO). + type: object + properties: + conditions: + description: | + Conditions for the filter. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionInputRepresentation" + required: + - conditions + DataSpaceFilterConditionInputRepresentation: + title: Data Space Filter Condition Input + description: Represents the input for a data space filter condition. + type: object + properties: + fieldName: + description: | + Name of the field. + + **Available Version:** 62.0 + type: string + filterValue: + description: | + Value of the filter. + + **Available Version:** 62.0 + type: string + operator: + description: | + 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 + enum: + - ContainsAny + - Equals + - GreaterThan + - In + - LastNumberOfDays + - LessThan + - NotEquals + - NotIn + type: string + tableName: + description: | + Name of the table to apply the filter. + + **Available Version:** 62.0 + type: string + required: + - fieldName + - filterValue + - operator + - tableName + DataSpaceFilterConditionRepresentation: + title: Data Space Filter Condition Output + description: Represents the data space filter condition. + type: object + properties: + fieldName: + description: | + Field name to apply the filter condition. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + filterValue: + description: | + Value of the filter condition. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + operator: + description: | + Operator of the filter condition. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - ContainsAnyOperator + - EqualsOperator + - GreaterThanOperator + - InOperator + - IsEmptyStringOperator + - IsNotEmptyStringOperator + - IsNotNullOperator + - IsNullOperator + - LastNumberOfDaysOperator + - LessThanOperator + - NotEqualsOperator + - NotInOperator + type: string + tableName: + description: | + Name of the table to apply the filter condition. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + DataSpaceFilterInputRepresentation: + title: Data Space Filter Input + description: Represents the input filter for a data space on a data lake object + (DLO). + type: object + properties: + conditions: + description: | + Conditions for the filter. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionCollectionRepresentation" + conjunctiveOperator: + description: | + Operator of the filter. + + **Available Version:** 62.0 + enum: + - AndOperator + - NoneOperator + - OrOperator + type: string + required: + - conditions + - conjunctiveOperator + DataSpaceFilterRepresentation: + title: Data Space Filter Output + description: Represents the data space filter on an object. + type: object + properties: + conditions: + description: | + List of conditions in the filter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterConditionRepresentation" + conjunctiveOperator: + description: | + Operator of the filter. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - AndOperator + - NoneOperator + - OrOperator + type: string + DataSpaceInfoRepresentation: + title: Data Space Info Output + description: Represents the details of a data space. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + description: + description: | + Description of the data space. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + prefix: + description: | + Three-character prefix of the data space. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + status: + description: | + Status of the data space. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Active + - Error + - Processing + type: string + required: + - description + - status + DataSpaceInputRepresentation: + title: Data Space Input + description: Represents the input for a data space. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + filter: + description: | + Filter for the data space. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FilterExpressionDatSpaceInputRepresentation" + name: + description: | + Name of the data space. + + **Available Version:** 60.0 + type: string + DataSpaceMemberCollectionInputRepresentation: + title: Data Space Member Collection Input + description: Represents the input for creating and updating the members of a data + space. + type: object + properties: + members: + description: | + A list of members to either create or update in the data space. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceMemberInputListRepresentation" + required: + - members + DataSpaceMemberCollectionRepresentation: + title: Data Space Member Collection Output + description: Represents a collection of data space members. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + members: + description: | + List of all data space members and filters. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceMemberRepresentation" + required: + - members + DataSpaceMemberErrorRepresentation: + title: Data Space Member Error Output + description: Represents the error state of data space members. + type: object + properties: + error: + description: | + Error code and details. + + **Filter Group:** Small + + **Available Version:** 62.0 + allOf: + - $ref: "#/components/schemas/CdpErrorRepresentation" + name: + description: | + Name of the data space member. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataSpaceMemberInputListRepresentation: + title: Data Space Member Input List + description: Represents a list of data space members. + type: object + properties: + members: + description: | + Members of a data space. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceMemberInputRepresentation" + required: + - members + DataSpaceMemberInputRepresentation: + title: Data Space Member Input + description: Represents the member details for updating a data space. + type: object + properties: + filter: + description: | + Filter applied on the data space member. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceFilterInputRepresentation" + memberName: + description: | + Developer name of the data space member. + + **Available Version:** 62.0 + type: string + required: + - filter + - memberName + DataSpaceMemberPutCollectionRepresentation: + title: Data Space Member Put Collection Output + description: Represents the output for creating and updating data space members. + type: object + properties: + dataSpaceMembers: + description: | + Details of the data space members that have been successfully created or updated. + + **Filter Group:** Small + + **Available Version:** 62.0 + allOf: + - $ref: "#/components/schemas/DataSpaceMemberCollectionRepresentation" + errors: + description: | + Details of the data space members that have been ignored or failed during the operation. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataSpaceMemberErrorRepresentation" + success: + description: | + 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 + type: string + DataSpaceMemberRepresentation: + title: Data Space Member Output + description: Represents the details of a data space member. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + filter: + description: | + Filter on the object used for creating the data space member. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/DataSpaceFilterRepresentation" + memberName: + description: | + Developer name of the data space member. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + status: + description: | + Status of the off-core sync of the data space member. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Active + - Error + - Processing + type: string + required: + - status + - memberName + DataSpacePatchInputRepresentation: + title: Data Space Patch Input + description: Represents the details for updating a data space. + type: object + properties: + description: + description: | + Description of the data space. + + **Available Version:** 62.0 + type: string + label: + description: | + Label of the data space. + + **Available Version:** 62.0 + type: string + required: + - description + - label + DataSpaceRepresentation: + title: Data Space Output + description: Represents a data space. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + filter: + description: | + Data space filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataSpaceFilterRepresentation" + DataStreamActionResponseRepresentation: + title: Data Stream Action Response Output + description: Represents the output for an action job on a data stream. + allOf: + - $ref: "#/components/schemas/CdpActionResponseBaseRepresentation" + - type: object + properties: + jobId: + description: | + Job ID of the data stream run. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + DataStreamCollectionRepresentation: + title: Data Stream Collection Output + description: Represents a Data 360 data stream collection. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + dataStreams: + description: | + List of data streams. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamDetailedRepresentation" + required: + - dataStreams + DataStreamDetailedRepresentation: + title: Data Stream Detailed Output + description: Represents the details of a Data 360 data stream. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + advancedAttributes: + description: | + 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 + type: object + additionalProperties: + type: string + connectorInfo: + description: | + Data stream connector information. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConnectorRepresentation" + dataAccessMode: + description: | + Data access mode used to create the data stream. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - Direct_Access + - Ingest + dataLakeObjectInfo: + description: | + Information about the data stream's data lake. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataLakeObjectRepresentation" + dataSource: + description: | + Information about the data source to categorize the data being ingested. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + dataStreamType: + description: | + Type of data stream. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - 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: + description: | + Number of rows added in the most recent ingestion run. + + **Filter Group:** Small + + **Available Version:** 62.0 + format: int64 + type: integer + lastProcessedRecords: + format: int64 + description: | + Number of last processed data stream records. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + lastRefreshDate: + description: | + Data and time of the most recent refresh for the data stream. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + lastRunStatus: + description: | + Status of the most recent run. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Cancelled + - Extracting + - Failure + - In Progress + - None + - Pending + - Success + type: string + mappings: + description: | + Data stream mappings. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamFieldMappingRepresentation" + recordId: + description: | + Record ID of the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + refreshConfig: + description: | + Data stream refresh configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/RefreshConfigRepresentation" + sourceFields: + description: | + List of data stream source field information. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamSourceFieldRepresentation" + status: + description: | + Status of the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Deleting + - Error + - Processing + type: string + totalRecords: + format: int64 + description: | + Total records in the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + type: object + DataStreamFieldMappingInputRepresentation: + title: Data Stream Field Mapping Input + description: Represents the input for data stream field mapping. + type: object + properties: + sourceFieldLabel: + description: | + Label of the source formula field. + + **Available Version:** 60.0 + type: string + targetFieldName: + description: | + Name of the target formula field. + + **Available Version:** 60.0 + type: string + targetFieldReturntype: + description: | + Return type of the target formula field. + + **Available Version:** 60.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + transformationFormula: + description: | + Transformation formula for the formula field + + **Available Version:** 60.0 + type: string + DataStreamFieldMappingRepresentation: + title: Data Stream Field Mapping Output + description: Represents the field mapping for a data stream. + type: object + properties: + formula: + description: | + Field mapping formula for the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceFieldName: + description: | + Field name of the data stream mapping source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetFieldName: + description: | + Field name of the data stream mapping target. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + DataStreamFrequencyInputRepresentation: + title: Data Stream Frequency Input + description: Represents the input for a data stream refresh frequency. + type: object + properties: + frequencyType: + description: | + Type of frequency. + + **Available Version:** 60.0 + type: string + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + - Transform + hours: + description: | + Hours in the frequency. + + **Available Version:** 60.0 + type: array + items: + type: integer + refreshDayOfMonth: + description: | + Refresh day of the month. + + **Available Version:** 60.0 + type: array + items: + type: integer + refreshDayOfWeek: + description: | + Refresh day of the week. + + **Available Version:** 60.0 + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + DataStreamFrequencyRepresentation: + title: Data Stream Frequency Output + description: Information about when a data stream is refreshed. + type: object + properties: + frequencyType: + description: | + How often the data stream is refreshed. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + type: string + hours: + description: | + List of the hours at which the data stream is refreshed. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: integer + refreshDayOfMonth: + description: | + Which day of the month the data stream is refreshed. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: integer + refreshDayOfWeek: + description: | + Which day of the week the data stream is refreshed. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + type: string + DataStreamInputRepresentation: + title: Data Stream Input + description: Represents a data stream. + type: object + properties: + advancedAttributes: + description: | + Additional attributes for a data stream, such as a directory, file name, or file parser options. BYOL data stream creations use this property for inputs, usch as `database`, `schema`, and `object`. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + connectorInfo: + description: | + Details about the connector used for the data stream. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConnectorInputRepresentation" + currencyIsoCodeInfo: + description: | + Currency ISO code configured in the org. If unspecified, the org default is used. + + **Available Version:** 63.0 + type: object + dataAccessMode: + description: | + Data access mode used to create the data stream. + + **Available Version:** 62.0 + type: string + enum: + - Direct_Access + - Ingest + dataLakeObjectInfo: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/DataLakeObjectInputRepresentation" + datasource: + description: | + Data source of the data stream. + + **Available Version:** 60.0 + type: string + datastreamType: + description: | + 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 + type: string + existingDataLakeObjectInfo: + description: | + Information about a DLO that you want to reuse for the deployment. Either `dataLakeObjectInfo` or `existingDataLakeObjectInfo` can be present. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExistingDataLakeObjectInputRepresentation" + label: + description: | + Label of the data stream. + + **Available Version:** 60.0 + type: string + mappings: + description: | + Formula fields or mappings. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamFieldMappingInputRepresentation" + name: + description: | + Unique identifier of the data stream. + + **Available Version:** 60.0 + type: string + refreshConfig: + description: | + Refresh information for the data stream. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/RefreshConfigInputRepresentation" + sourceFields: + description: | + Source fields for the data stream. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamSourceFieldInputRepresentation" + required: + - connectorInfo + - label + - mappings + - name + - refreshConfig + - sourceFields + DataStreamPatchInputRepresentation: + title: Data Stream Patch Input + description: Represents the data stream to update. + type: object + properties: + connectorPatchInfo: + description: | + Information about the connector for the data stream. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConnectorPatchInputRepresentation" + dataLakeObjectInfo: + description: | + Input data lake object used by the data stream. + + **Available Version:** 60.0 + type: array + items: + type: object + datastreamType: + description: | + 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 + type: string + label: + description: | + Label of the data stream. + + **Available Version:** 60.0 + type: string + mappings: + description: | + Mapping representations between formula fields and data lake object (DLO) fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamFieldMappingInputRepresentation" + refreshConfig: + description: | + Description of the refresh config input representation. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/RefreshConfigInputRepresentation" + sourceFields: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/DataStreamSourceFieldInputRepresentation" + DataStreamRepresentation: + title: Data Stream Output + description: Information about a data stream. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataLakeObjectInfo: + description: | + Information about the data lake object (DLO) related to the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataLakeObjectRepresentation" + recordId: + description: | + Record ID of the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + status: + description: | + Status of the data stream. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Deleting + - Error + - Processing + type: string + required: + - status + - dataLakeObjectInfo + - recordId + DataStreamSourceFieldInputRepresentation: + title: Data Stream Source Field Input + description: Represents the input for a data stream source field. + type: object + properties: + dataType: + description: | + Data type of the data source field. + + **Available Version:** 60.0 + type: string + format: + description: | + Format of the data source field. + + **Available Version:** 60.0 + type: string + name: + description: | + 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 + type: string + DataStreamSourceFieldRepresentation: + title: Data Stream Source Field Output + description: Represents a data stream source field. + type: object + properties: + datatype: + description: | + Data type of the data stream source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Date + - DateTime + - Number + - Text + type: string + format: + description: | + Format of the data stream source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the data stream source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + DataTransformCollectionRepresentation: + title: Data Transform Collection Output + description: Represents a collection of data transforms. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + dataTransforms: + description: | + List of data transforms returned for the current page. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataTransformRepresentation" + errors: + description: | + Error collection of resources that failed to be retrieved. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FailedResourceCollectionRepresentation" + required: + - dataTransforms + DataTransformDataObjectOverride: + title: Data Transform Data Object Override Input + type: object + description: Represents the input for data transform object overrides. + properties: + nameOfObjInPublishingOrg: + description: | + Name of the data transform object in the publishing org. + + **Available Version:** 63.0 + type: string + nameOfObjInSubscriberOrg: + description: | + Name of the data transform object in the subscriber org. + + **Available Version:** 63.0 + type: string + DataTransformDefinitionInputRepresentation: + title: Data Transform Definition Input + type: object + properties: + outputDataObjects: + description: | + Information about the objects into which the data transform writes the transformed data. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataObjectInputRepresentation" + type: + description: | + Type of definition. + + **Available Version:** 60.0 + type: string + enum: + - DbtHidden + - DcSql + - Sql + - SqlHidden + - Stl + - StlHidden + version: + description: | + Version of the transform. + + **Available Version:** 60.0 + type: string + required: + - type + - version + DataTransformDefinitionOverride: + title: Data Transform Definition Override Input + type: object + description: Represents the input for data transform definition overrides. + properties: + devName: + description: | + Updated or replaced definition developer name. + + **Available Version:** 63.0 + type: string + label: + description: | + Updated or replaced definition label. + + **Available Version:** 63.0 + type: string + templateDevName: + description: | + Definition developer name in the data kit template. + + **Available Version:** 63.0 + type: string + DataTransformDefinitionRepresentation: + title: Base Data Transform Output + description: Represents a data transform node. + type: object + properties: + label: + description: | + Label of the data transform definition. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the data transform definition. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + outputDataObjects: + description: | + Information about the objects into which the data transform writes the transformed data. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataObjectRepresentation" + type: + description: | + Type of the data transform definition. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - DbtHidden + - DcSql + - Sql + - SqlHidden + - Stl + - StlHidden + type: string + version: + description: | + Version of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + DataTransformInputRepresentation: + title: Data Transform Input + type: object + properties: + currencyIsoCode: + description: | + Currency ISO code of the data transform. + + **Available Version:** 62.0 + type: string + dataSpaceName: + description: | + Data space that the data transform belongs to. Required for DMO-based data transforms. + + **Available Version:** 60.0 + type: string + definition: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DcSqlDataTransformDefinitionInputRepresentation" + - $ref: "#/components/schemas/StlDataTransformDefinitionInputRepresentation" + - $ref: "#/components/schemas/SqlDataTransformDefinitionInputRepresentation" + definitions: + description: | + List of definitions for batch transforms. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DataTransformDefinitionInputRepresentation" + description: + description: | + Description of the data transform. + + **Available Version:** 60.0 + type: string + fullRunFrequency: + description: | + Full run frequency of the data transform. + + **Available Version:** 60.0 + type: string + enum: + - Daily + - Monthly + - Weekly + label: + description: | + Label of the data transform. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the data transform. + + **Available Version:** 60.0 + type: string + primarySource: + description: | + In cases where the transformation contains table joins, describes the primary source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type of data transform. + + **Available Version:** 60.0 + enum: + - BATCH + - STREAMING + type: string + required: + - definition + - label + - name + - type + DataTransformNodeInputRepresentation: + title: Data Transform Node Input + description: Represents a single node in a series of nodes that make up a batch data transform. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/AggregateNodeInputRepresentation" + - $ref: "#/components/schemas/AppendV2NodeInputRepresentation" + - $ref: "#/components/schemas/BucketNodeInputRepresentation" + - $ref: "#/components/schemas/CdpPredictNodeInputRepresentation" + - $ref: "#/components/schemas/ComputeRelativeNodeInputRepresentation" + - $ref: "#/components/schemas/ExtensionFunctionNodeInputRepresentation" + - $ref: "#/components/schemas/ExtensionNodeInputRepresentation" + - $ref: "#/components/schemas/ExtractGrainNodeInputRepresentation" + - $ref: "#/components/schemas/ExtractTableNodeInputRepresentation" + - $ref: "#/components/schemas/FilterNodeInputRepresentation" + - $ref: "#/components/schemas/FlattenJsonNodeInputRepresentation" + - $ref: "#/components/schemas/FlattenNodeInputRepresentation" + - $ref: "#/components/schemas/FormatDateNodeInputRepresentation" + - $ref: "#/components/schemas/FormulaNodeInputRepresentation" + - $ref: "#/components/schemas/JoinNodeInputRepresentation" + - $ref: "#/components/schemas/LoadNodeInputRepresentation" + - $ref: "#/components/schemas/OutputD360NodeInputRepresentation" + - $ref: "#/components/schemas/SchemaNodeInputRepresentation" + - $ref: "#/components/schemas/SplitNodeInputRepresentation" + - $ref: "#/components/schemas/SqlFilterNodeInputRepresentation" + - $ref: "#/components/schemas/TypecastNodeInputRepresentation" + - $ref: "#/components/schemas/UpdateNodeInputRepresentation" + properties: + action: + description: | + 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 + enum: + - Aggregate + - Append_V2 + - Bucket + - ComputeRelative + - DateFormatConversion + - Extension + - Extract + - Filter + - Formula + - Join + - Load + - OutputD360 + - Recommendation + - Save + - Schema + - Split + - SqlFilter + - TypeCast + - Update + type: string + schema: + description: | + Schema changes for the node. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaParametersInputRepresentation" + sources: + description: | + Source node IDs. + + **Available Version:** 60.0 + type: array + items: + type: string + required: + - action + - sources + DataTransformNodeRepresentation: + title: Data Transform Node Output + description: Represents a batch data transform node. + type: object + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/AggregateNodeRepresentation" + - $ref: "#/components/schemas/AppendV2NodeRepresentation" + - $ref: "#/components/schemas/BucketNodeRepresentation" + - $ref: "#/components/schemas/CdpPredictNodeRepresentation" + - $ref: "#/components/schemas/ComputeRelativeNodeRepresentation" + - $ref: "#/components/schemas/ExtensionFunctionNodeRepresentation" + - $ref: "#/components/schemas/ExtensionNodeRepresentation" + - $ref: "#/components/schemas/ExtractTableNodeRepresentation" + - $ref: "#/components/schemas/ExtractNodeRepresentation" + - $ref: "#/components/schemas/FilterNodeRepresentation" + - $ref: "#/components/schemas/FlattenJsonNodeRepresentation" + - $ref: "#/components/schemas/FlattenNodeRepresentation" + - $ref: "#/components/schemas/FormatDateNodeRepresentation" + - $ref: "#/components/schemas/FormulaNodeRepresentation" + - $ref: "#/components/schemas/JoinNodeRepresentation" + - $ref: "#/components/schemas/LoadNodeRepresentation" + - $ref: "#/components/schemas/OutputD360NodeRepresentation" + - $ref: "#/components/schemas/SchemaNodeRepresentation" + - $ref: "#/components/schemas/SplitNodeRepresentation" + - $ref: "#/components/schemas/SqlFilterNodeRepresentation" + - $ref: "#/components/schemas/TypeCastNodeRepresentation" + - $ref: "#/components/schemas/UpdateNodeRepresentation" + properties: + action: + description: | + 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 + enum: + - Aggregate + - Append_V2 + - Bucket + - ComputeRelative + - DateFormatConversion + - Extension + - Extract + - Filter + - Formula + - Join + - Load + - OutputD360 + - Recommendation + - Save + - Schema + - Split + - SqlFilter + - TypeCast + - Update + type: string + schema: + description: | + Schema changes to output. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaParametersRepresentation" + sources: + description: | + Input nodes. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + required: + - action + - sources + DataTransformRepresentation: + title: Data Transform Output + description: Represents a data transform. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + actionUrls: + description: | + Actions available for the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BatchActionRepresentation" + creationType: + description: | + Creation type of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Custom + - System + dataSpaceName: + description: | + Data space for the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + definition: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/DcSqlDataTransformDefinitionRepresentation" + - $ref: "#/components/schemas/StlDataTransformDefinitionRepresentation" + - $ref: "#/components/schemas/SqlDataTransformDefinitionRepresentation" + definitions: + description: | + List of definitions for batch data transforms. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: '#/components/schemas/DataTransformDefinitionRepresentation' + description: + description: | + Description of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + fullRunFrequency: + description: | + Full run frequency of the data transform. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Daily + - Monthly + - Weekly + lastRunDate: + description: | + Last date the data transform was run. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + lastRunErrorCode: + description: | + Error code of the last run. + + **Filter Group:** Big + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/CdpErrorRepresentation" + lastRunStatus: + description: | + Status of the last run. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Canceled + - Failure + - InProgress + - None + - PartialFailure + - PartiallyCanceled + - Pending + - Success + type: string + schedule: + description: | + The schedule for the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ScheduleRepresentation" + status: + description: | + The status of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Active + - Deleting + - Error + - Processing + type: string + type: + description: | + Type of data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - BATCH + - STREAMING + type: string + version: + format: int64 + description: | + Version of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + DataTransformRunHistoryBaseRepresentation: + title: Data Transform Run History Base Output + description: | + 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. + type: object + properties: + outputStatus: + description: | + For a batch data transform, contains information about the output node that the transformed data is written to. + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/RunHistoryOutputProgressRepresentation" + runMode: + description: | + For a batch data transform, indicates whether the data transform ran in [incremental or full mode](https://help.salesforce.com/s/articleView?id=data.c360_a_batch_transform_run_types.htm&type=5). + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Full + - Incremental + type: string + runModeParameters: + description: | + For a batch data transform, contains more information about the run mode. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + type: string + runModeReason: + description: | + For a batch data transform, indicates the why the data transform is in the current run mode. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - BtDefinitionChanged + - DmoMappingsChanged + - EvaluationError + - FullSyncInSrcObject + - FunctionsRequireFullRun + - IncrementalModeDisabled + - IrregularDmoPk + - MaxRetriesFailed + - NoRecentFullRun + - NodesRequireFullRun + - NotAScheduledRun + - RetryAfterPartialFailure + - RunAfterPartialResult + - TooManyChangesInSrcObject + - UnsupportedObjectType + type: string + addedRows: + format: int64 + description: | + For a streaming data transfer, indicates the number of rows that the data transform added. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + deletedRows: + format: int64 + description: | + For a streaming data transform, indicates the number of rows that the data transform deleted. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + failedRows: + format: int64 + description: | + For a streaming data transform, indicates the number of rows that failed during the transform. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + updatedRows: + format: int64 + description: | + For a streaming data transform, indicates the number of rows that the data transform updated. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + duration: + format: int64 + description: | + Duration of the data transform run in seconds. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + endTime: + description: | + End date and time of the data transform run. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + errorMessage: + description: | + 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 + type: string + isVersionChanged: + description: | + Indicates whether the data transform version changed since the last job (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + processedRows: + format: int64 + description: | + Either the number of input or output rows processed, whichever is larger. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + startTime: + description: | + Start time of the data transform job. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + status: + description: | + Status of the data transform run. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Canceled + - Failure + - InProgress + - None + - PartialFailure + - PartiallyCanceled + - Pending + - RebuildFailure + - RebuildPending + - RebuildSuccess + - Rebuilding + - Success + type: string + DataTransformRunHistoryCollectionRepresentation: + title: Data Transform Run History Collection Output + description: Represents a data transform run history collection. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + histories: + description: | + List of information about the jobs that the data transform has run. Each data transform run is one entry in the array. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataTransformRunHistoryBaseRepresentation" + required: + - histories + DataTransformValidationRepresentation: + title: Data Transform Validation Output + description: Data transform validations and output data object representation. + type: object + properties: + issues: + description: | + List of validation issues, if any. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/TransformValidationIssueRepresentation" + outputDataObjects: + description: | + Output representation of the target object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/DataObjectRepresentation" + DcSqlDataTransformDefinitionInputRepresentation: + title: Dc Sql Data Transform Definition Input + description: Represents the input definition for Dc Sql data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionInputRepresentation" + - type: object + properties: + manifest: + description: | + Manifest of the DC SQL data transform. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DcSqlDataTransformManifestInputRepresentation" + DcSqlDataTransformDefinitionRepresentation: + title: Dc Sql Data Transform Definition Output + description: Represents the definition of a DC SQL data transform. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionRepresentation" + - type: object + properties: + manifest: + description: | + Manifest of the DC SQL data transform. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DcSqlDataTransformManifestRepresentation" + DcSqlDataTransformDependsOnRepresentation: + title: Dc Sql Data Transform Depends On Output + type: object + description: Represents manifest node dependencies. + properties: + nodes: + description: | + List of dependencies. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + DcSqlDataTransformMacroArgumentRepresentation: + title: Dc Sql Data Transform Macro Argument Output + type: object + description: Represents a manifest macro argument. + properties: + name: + description: | + Name of the macro argument. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of macro argument. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - BYOC_SCRIPT + DcSqlDataTransformManifestInputRepresentation: + title: Dc Sql Data Transform Manifest Input + type: object + description: Input representation of the DCSQL transform manifest format + properties: + macros: + description: | + Map of DC SQL manifest macros. + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + nodes: + description: | + Map of DC SQL manifest nodes. + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + sources: + description: | + Map of DC SQL manifest sources. + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + DcSqlDataTransformManifestRepresentation: + title: Dc Sql Data Transform Manifest Output + type: object + description: Represents the manifest format of a DC SQL transform. + properties: + macros: + additionalProperties: + type: object + description: | + Map of manifest macros. + + **Filter Group:** Small + + **Available Version:** 63.0 + properties: + arguments: + description: | + List of arguments. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/DcSqlDataTransformMacroArgumentRepresentation" + name: + description: | + Name of the macro. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + resource_type: + description: | + Type of node resource. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - macro + - model + - source + description: | + Description of the manifest. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + nodes: + description: | + Map of nodes. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + description: | + Properties of the manifest node. + + **Filter Group:** Small + + **Available Version:** 63.0 + properties: + compiled_code: + description: | + Compiled code. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + config: + description: |- + Configuration of the manifest node. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DcSqlDataTransformNodeConfigurationRepresentation" + depends_on: + description: |- + Node dependencies. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/DcSqlDataTransformDependsOnRepresentation" + name: + description: | + Name of the node. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + relation_name: + description: | + Name of the table that this node writes to. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + resource_type: + description: | + Type of node resource. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - macro + - model + - source + sources: + description: | + Map of manifest sources. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + additionalProperties: + type: object + description: | + Properties of the manifest sources. + + **Filter Group:** Small + + **Available Version:** 63.0 + properties: + relation_name: + description: | + Name of the table this transform reads from. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + resource_type: + description: | + Type of node resource. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - macro + - model + - source + DcSqlDataTransformNodeConfigurationRepresentation: + title: Dc Sql Data Transform Node Configuration Output + type: object + description: Represents a manifest node configuration. + properties: + materialized: + description: | + Materialization type of node. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - ephemeral + - table + writeMode: + description: | + Write mode for the node. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Append + - DeleteOnly + - Merge + - MergeUpsertDelete + - Overwrite + DecoratorInputRepresentation: + title: Decorator Input + description: Represents the input for the field-level chunking decorator. + type: object + properties: + decoratorId: + description: | + Decorator ID. + + **Available Version:** 61.0 + type: string + dmoDeveloperName: + description: | + DMO developer name. + + **Available Version:** 61.0 + type: string + dmoFieldDeveloperName: + description: | + DMO field developer name. + + **Available Version:** 61.0 + type: string + DecoratorRepresentation: + title: Decorator Output + description: Represents the field-level chunking decorator. + type: object + properties: + decoratorId: + description: | + Decorator ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dmoDeveloperName: + description: | + DMO developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dmoFieldDeveloperName: + description: | + DMO field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dmoFieldName: + description: | + DMO field label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + dmoName: + description: | + DMO label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + DMOFilterConfigInputRepresentation: + title: DMO Filter Config Input + description: Represents DMO filter configuration input. + $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + properties: + filters: + description: | + Filters for the DMO filter configuration. + type: array + items: + $ref: "#/components/schemas/DMOFilterInputRepresentation" + DMOFilterInputRepresentation: + title: DMO Filter Input + description: Represents the DMO filter input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + entityFilter: + description: | + Entity filter. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BaseComparisonInputRepresentation" + entityFilterType: + description: | + Type of the entity filter. + + **Available Version:** 60.0 + type: string + entityName: + description: | + Name of the entity. + + **Available Version:** 60.0 + type: string + filterLimit: + description: | + Filter limit. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DmoFilterLimitInputRepresentation" + inheritedFilter: + description: | + Inherited filter. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BaseComparisonInputRepresentation" + inheritedFilterType: + description: | + Type of the inherited filter. + + **Available Version:** 60.0 + type: string + queryPathConfigForActivateOnToContainer: + description: | + Path from the activation to the container. + + *Type:** Query Config List Input + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + queryPathConfigFromContainerToEntity: + description: | + Path from the container to the entity. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathConfigListInputRepresentation" + DmoFilterLimitInputRepresentation: + title: DMO Filter Limit Input + description: Represents the DMO filter limit input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + attributeName: + description: | + Name of the attribute. + + **Available Version:** 60.0 + type: string + maxNumberOfValues: + description: | + Max number of values. + + **Available Version:** 60.0 + type: integer + order: + description: | + Filter sort order. + + **Available Version:** 60.0 + type: string + enum: + - Asc + - Desc + DmoFilterLimitRepresentation: + title: DMO Filter Limit Output + description: Represents the DMO filter limit. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeName: + description: | + Name of the attribute in the DMO filter limit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + maxNumberOfValues: + description: | + Max number of values in the DMO filter limit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + order: + description: | + Sort order for the DMO filter limit. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - FilterSortOrderAsc + - FilterSortOrderDesc + type: string + type: object + DmoFilterRepresentation: + title: DMO Filter Input + description: Represents the DMO filter output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + entityFilter: + description: | + Entity filter for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BaseComparisonRepresentation" + entityFilterType: + description: | + Type of entity filter for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + entityName: + description: | + Entity name for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + filterLimit: + description: | + Limit for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DmoFilterLimitRepresentation" + inheritedFilter: + description: | + Inherited filter for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BaseComparisonRepresentation" + inheritedFilterType: + description: | + Type of inherited filter for the DMO filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + queryPathConfigForActivateOnToContainer: + description: | + Query path from the activation to the container. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + queryPathConfigFromContainerToEntity: + description: | + Query path from the container to the entity. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/QueryPathConfigListRepresentation" + DmoFiltersConfigRepresentation: + title: DMO Filters Config Output + description: Represents the configuration of DMO filters. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + filters: + description: | + DMO filters for the activation. + type: array + items: + $ref: "#/components/schemas/DmoFilterRepresentation" + EgressPropertiesInputRepresentation: + title: Egress Properties Input + description: Represents the input details for egress properties of the activation target. + type: object + properties: + childFolder: + description: | + Path of the child folder. The child folder is created in the parent directory for copying activation files. + + **Available Version:** 63.0 + type: string + customFilename: + description: | + Custom name of the output file. Either `customFilename` or `predeterminedFilename` must be present. + + **Available Version:** 63.0 + type: string + filenameDateSuffixFormat: + description: | + 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 + type: string + isSubfolderCreationEnabled: + description: | + 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 + type: boolean + outputCompressionFormat: + description: | + Compression format for the output file. + + **Available Version:** 63.0 + enum: + - Bzip2 + - Gzip + - None + type: string + outputDelimiter: + description: | + Field delimiter to use in output files. + + **Available Version:** 63.0 + enum: + - BrokenPipe + - Caret + - Colon + - Comma + - Hash + - Pipe + - Semicolon + - Slash + - Tab + - Tilde + - Underscore + type: string + outputFormat: + description: | + Output format for the activation target. + + **Available Version:** 63.0 + type: string + outputMaxFileSizeMegaBytes: + format: int64 + description: | + Maximum size of the output file in megabytes from `1` through `500`. + + **Available Version:** 63.0 + type: integer + outputMaxRecordsPerFile: + format: int64 + description: | + Maximum number of records in the output file from `1` through `100000`. + + **Available Version:** 63.0 + type: integer + predeterminedFilename: + description: | + Predetermined name of the output file. Either `customFilename` or `predeterminedFilename` must be present. + + **Available Version:** 63.0 + enum: + - Activation + - Segment + - SegmentActivation + type: string + required: + - filenameDateSuffixFormat + - outputCompressionFormat + - outputDelimiter + - outputFormat + - outputMaxFileSizeMegaBytes + EgressPropertiesRepresentation: + title: Egress Properties Output + description: Represents the details for egress properties of the activation target. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + childFolder: + description: | + Path of the child folder. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + customFilename: + description: | + Custom name of the output file. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + filenameDateSuffixFormat: + description: | + Date suffix format for the output file name. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + isSubfolderCreationEnabled: + description: | + Indicates whether subfolder creation is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + outputCompressionFormat: + description: | + Compression format for the output file. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Bzip2 + - Gzip + - None + type: string + outputDelimiter: + description: | + Field delimiter for the output file. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - BrokenPipe + - Caret + - Colon + - Comma + - Hash + - Pipe + - Semicolon + - Slash + - Tab + - Tilde + - Underscore + type: string + outputFormat: + description: | + Output format of the activation target. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + outputMaxFileSizeMegaBytes: + format: int64 + description: | + Maximum size of the output file in megabytes. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + outputMaxRecordsPerFile: + format: int64 + description: | + Maximum number of records in the output file. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + predeterminedFilename: + description: | + Predetermined name of the output file. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Activation + - Segment + - SegmentActivation + type: string + ExistingDataLakeObjectInputRepresentation: + title: Existing Data Lake Object Input + description: Represents the input for a data stream's existing target data lake object (DLO). + type: object + properties: + name: + description: | + Developer name of the existing target DLO. The DLO cannot be used by another data stream. + + **Available Version:** 62.0 + type: string + ExtensionFunctionNodeInputRepresentation: + title: Extension Function Node Input + description: Represents the input for an extension function node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node specific parameters + + **Available Version:** 65.0 + allOf: + - $ref: "#/components/schemas/ExtensionFunctionParametersInputRepresentation" + required: + - parameters + ExtensionFunctionNodeRepresentation: + title: Extension Function Node Output + description: Represents an extension function node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtensionFunctionParametersRepresentation" + ExtensionFunctionParametersInputRepresentation: + title: Extension Function Parameters Input + type: object + description: Represents the input for extension function parameters. + properties: + functionName: + description: | + Name of the extension function. + + **Available Version:** 65.0 + type: string + outputFields: + description: | + Map of output fields, including label and name. + + **Available Version:** 65.0 + type: object + additionalProperties: + type: object + ownerParameters: + description: | + Map of owner parameters. + + **Available Version:** 65.0 + type: object + additionalProperties: + type: object + sourceInputFields: + description: | + List of source fields to the extension function from the dataset. + + **Available Version:** 65.0 + type: array + items: + type: string + userParameters: + description: | + Map of user parameters. + + **Available Version:** 66.0 + type: object + additionalProperties: + type: object + version: + description: | + Version of the extension function. + + **Available Version:** 65.0 + type: string + ExtensionFunctionParametersRepresentation: + title: Extension Function Parameters Output + type: object + description: Represents extension function parameters. + properties: + functionName: + description: | + Name of the function. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + outputFields: + additionalProperties: + type: object + description: | + Output field of the function. + + **Filter Group:** Small + + **Available Version:** 60.0 + properties: + label: + description: | + Label of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + description: | + Output fields produced by the function. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + ownerParameters: + description: | + Map of owner parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + sourceInputFields: + description: | + List of input fields from the source dataset. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + userParameters: + description: | + Map of user parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + version: + description: | + Version of the function. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ExtensionNodeInputRepresentation: + title: Extension Node Input + description: Represents the input for an extension node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/ExtensionParametersInputRepresentation" + required: + - parameters + ExtensionNodeRepresentation: + title: Extension Node Output + description: Representation of Extension Node + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtensionParametersRepresentation" + ExtensionParametersInputRepresentation: + title: Extension Parameters Input + type: object + description: Represents the input for extension parameters. + properties: + args: + description: | + Map of extension arguments. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + name: + description: | + Name of the extension. + + **Available Version:** 60.0 + type: string + namespace: + description: | + Namespace of the extension. + + **Available Version:** 60.0 + type: string + version: + description: | + Version of the extension. + + **Available Version:** 60.0 + type: number + format: double + ExtensionParametersRepresentation: + title: Extension Parameters Output + type: object + description: Represens extension node parameters. + properties: + args: + description: | + Map of extension arguments, which are keys defined by the extension definition. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + name: + description: | + Name of the extension. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + namespace: + description: | + Namespace of the extension. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + version: + description: | + Version of the extension. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: number + format: double + ExtractFieldRepresentation: + title: Extract Field Output + type: object + description: Represents an extract grain field. + properties: + grainType: + description: | + Type of extract grain. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Day + - DayEpoch + - FiscalMonth + - FiscalQuarter + - FiscalWeek + - FiscalYear + - Hour + - Minute + - Month + - Quarter + - Second + - SecondEpoch + - Week + - Year + label: + description: | + Label of the extract field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the extract field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ExtractGrainFieldInputRepresentation: + title: Extract Grain Field Input + description: Representation to extract part of a date, such as year, month, etc. + type: object + properties: + grainType: + description: | + Extract grain type. + + **Available Version:** 60.0 + enum: + - Day + - DayEpoch + - FiscalMonth + - FiscalQuarter + - FiscalWeek + - FiscalYear + - Hour + - Minute + - Month + - Quarter + - Second + - SecondEpoch + - Week + - Year + type: string + label: + description: | + Extract field label. + + **Available Version:** 60.0 + type: string + name: + description: | + Extract field name. + + **Available Version:** 60.0 + type: string + required: + - grainType + - label + - name + ExtractGrainNodeInputRepresentation: + title: Extract Grain Node Input + description: Represents extract date grain node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtractGrainParametersInputRepresentation" + required: + - parameters + ExtractGrainParameterInputRepresentation: + title: Extract Grain Parameter Input + description: Represents extract grain parameter. + type: object + properties: + source: + description: | + Source field. + + **Available Version:** 60.0 + type: string + targets: + description: | + Grain fields. + type: array + items: + $ref: "#/components/schemas/ExtractGrainFieldInputRepresentation" + required: + - source + - targets + ExtractGrainParametersInputRepresentation: + title: Extract Grain Parameters Input + description: Extract node. + type: object + properties: + dateConfigurationName: + description: | + Date configuration name. + + **Available Version:** 60.0 + type: string + grainExtractions: + description: | + Date fields to extract grains. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ExtractGrainParameterInputRepresentation" + required: + - dateConfigurationName + - grainExtractions + ExtractNodeRepresentation: + title: Extract Node Output + description: Represents an extract node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtractParametersRepresentation" + ExtractParameterRepresentation: + title: Extract Parameter Output + type: object + description: Represents an extract node parameter. + properties: + source: + description: | + Name of the source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targets: + description: | + List of grain fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ExtractFieldRepresentation" + ExtractParametersRepresentation: + title: Extract Parameters Output + type: object + description: Represents extract node parameters. + properties: + dateConfigurationName: + description: | + Name of the date configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + grainExtractions: + description: | + List of date fields to extract grains. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/ExtractParameterRepresentation" + ExtractTableNodeInputRepresentation: + title: Extract Table Node Input + description: Represents the input for an extract table node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtractTableParametersInputRepresentation" + required: + - parameters + ExtractTableNodeRepresentation: + title: Extract Table Node Output + description: Represents an extract table node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ExtractTableParametersRepresentation" + ExtractTableParametersInputRepresentation: + title: Extract Table Parameters Input + type: object + description: Represents the input for extract table parameters. + properties: + source: + description: | + Name of the source. + + **Available Version:** 60.0 + type: string + ExtractTableParametersRepresentation: + title: Extract Table Parameters Output + type: object + description: Represetns extract table parameters. + properties: + source: + description: | + Table identifier to be extracted from the flatten node. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FailedResourceCollectionRepresentation: + title: Failed Resource Collection Output + type: object + description: Represents a collection of failed resources. + properties: + error: + description: | + Error details for the resource. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/CdpErrorRepresentation" + id: + description: | + ID of the resource. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + name: + description: | + Name of the resource. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + FieldLevelChunkingConfigurationRepresentation: + title: Field Level Chunking Configuration Output + description: Represents the field level chunking configuration details. + type: object + properties: + config: + description: | + Configuration for the field level chunking. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FieldLevelConfigurationRepresentation" + decorators: + description: | + The decorators. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DecoratorRepresentation" + sourceDmoDeveloperName: + description: | + Source DMO developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoFieldDeveloperName: + description: | + Source DMO field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoFieldName: + description: | + Source DMO field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoName: + description: | + Source DMO name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FieldLevelConfigurationInputRepresentation: + title: Field Level Configuration Input + description: Represents the input for field-level configurations. + type: object + properties: + config: + description: | + Field-level configuration. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConfigInputRepresentation" + decorators: + description: | + Chunking decorators. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DecoratorInputRepresentation" + sourceDmoDeveloperName: + description: | + Source DMO developer name. + + **Available Version:** 60.0 + type: string + sourceDmoFieldDeveloperName: + description: | + Source DMO field developer name. + + **Available Version:** 60.0 + type: string + sourceDmoFieldName: + description: | + Source DMO field name. + + **Available Version:** 61.0 + type: string + sourceDmoName: + description: | + Source DMO name. + + **Available Version:** 61.0 + type: string + version: + description: | + Version of the chunking configuration. + + **Available Version:** 60.0 + type: string + FieldLevelConfigurationRepresentation: + title: Field Level Configuration Output + description: Represents the field level configuration. + type: object + properties: + id: + description: | + The ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + userValues: + description: | + User values. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/ChunkingConfigUserValuesRepresentation" + FieldRelationshipsPathRepresentation: + title: Field Relationships Path Output + description: Field relationships path representation + type: object + properties: + apiName: + description: | + API name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + parentRelationshipId: + description: | + Parent relationship ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoDeveloperName: + description: | + Source DMO developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoLabel: + description: | + Source DMO Label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceFieldId: + description: | + Source field's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceFieldLabel: + description: | + The source field's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceFieldName: + description: | + Source field's name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetDmoDeveloperName: + description: | + Target DMO's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetDmoLabel: + description: | + Target DMO's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetFieldId: + description: | + Target field's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetFieldLabel: + description: | + Target field's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetFieldName: + description: | + Target field's name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FieldRepresentation: + title: Field Output + type: object + description: Represents a field in a JSON schema. + properties: + attributePath: + description: | + Attribute path. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + index: + description: | + Index. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + isUniqueIdentifierField: + description: | + Indicates whether this field will be used to do de-duplication (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + label: + description: | + Label of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FieldSrcTrgtRelationshipCollectionInputRepresentation: + title: Field Source Target Relationship Collection Input + description: Represents the input to create a collection of field source target relationships between data model objects (DMOs). + type: object + properties: + relationships: + description: | + List of relationships to be created. + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/FieldSrcTrgtRelationshipInputRepresentation" + required: + - relationships + FieldSrcTrgtRelationshipCollectionRepresentation: + title: Field Source Target Relationship Collection Output + description: Represents a collection of field source target relationships between data model objects (DMOs). + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + relationships: + description: | + List of relationships. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/FieldSrcTrgtRelationshipRepresentation" + required: + - relationships + FieldSrcTrgtRelationshipInputRepresentation: + title: Field Source Target Relationship Input + description: Represents the input to create a field source target relationship between data model objects (DMOs). + type: object + properties: + cardinality: + description: | + Cardinality between the fields involved in the relationship. + + **Available Version:** 64.0 + enum: + - ManyToOne + - OneToOne + type: string + dataSpaceName: + description: | + Name of the data space for the relationship creation. + + **Available Version:** 64.0 + type: string + relationshipOwner: + description: | + Owner of the relationship. + + **Available Version:** 64.0 + enum: + - DataCloud + - Sobject + type: string + sourceFieldName: + description: | + Developer name of the source field in the relationship. + + **Available Version:** 64.0 + type: string + sourceObjectName: + description: | + Developer name of the source object in the relationship. + + **Available Version:** 64.0 + type: string + targetFieldName: + description: | + Developer name of the target field in the relationship. + + **Available Version:** 64.0 + type: string + targetObjectName: + description: | + Developer name of target object in the relationship. + + **Available Version:** 64.0 + type: string + required: + - cardinality + - sourceFieldName + - targetFieldName + FieldSrcTrgtRelationshipRepresentation: + title: Field Source Target Relationship Output + description: Represents a field source target relationship between data model objects (DMOs). + type: object + properties: + cardinality: + description: | + Cardinality between the fields involved in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + enum: + - ManyToOne + - OneToOne + type: string + creationType: + description: | + Creation type of the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + enum: + - CalculatedInsight + - Curated + - Custom + - SegmentMembership + - Standard + - System + type: string + id: + description: | + ID of the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + name: + description: | + Developer name of the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + owner: + description: | + Owner of the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + enum: + - DataCloud + - Sobject + type: string + sourceField: + description: | + Details about the source field involved in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/RelationshipFieldRepresentation" + sourceObject: + description: | + Details about the source object involved in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/RelationshipObjectRepresentation" + status: + description: | + Status of the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + enum: + - Active + - Creating + - DeactivateByUser + - Deleting + - Error + - Inactive + - Updating + type: string + targetField: + description: | + Details about the target field involved in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/RelationshipFieldRepresentation" + targetObject: + description: | + Details about the target object involved in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/RelationshipObjectRepresentation" + FilterDatSpaceInputRepresentation: + title: Filter Data Space Input + description: Represents the input for a data space filter. + type: object + properties: + fieldName: + description: | + Name of the field. + + **Available Version:** 60.0 + type: string + filterType: + description: | + Type of filter. + + **Available Version:** 60.0 + type: string + enum: + - Condition + filterValue: + description: | + Value of the filter. + + **Available Version:** 60.0 + type: string + operator: + description: | + Operator of the filter. + + **Available Version:** 60.0 + type: string + enum: + - Equals + - In_Operator + relationshipName: + description: | + Name of the relationship. + + **Available Version:** 60.0 + type: string + tableName: + description: | + Name of the table. + + **Available Version:** 60.0 + type: string + FilterExpressionDatSpaceInputRepresentation: + title: Filter Expression Data Space Input + description: Represents the input for a data space filter expression. + type: object + properties: + filterOperator: + description: | + Operator for the filter. + + **Available Version:** 63.0 + type: string + enum: + - And_Operator + - Or_Operator + filterType: + description: | + Type of filter. + + **Available Version:** 63.0 + type: string + enum: + - Condition + filters: + description: | + Filters in the filter expression. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/FilterDatSpaceInputRepresentation" + FilterExpressionInputRepresentation: + title: Filter Expression Input + description: Represents filter expression for filters. + type: object + properties: + field: + description: | + Field to filter on. + + **Available Version:** 60.0 + type: string + operands: + description: | + List of filter expression operands. + + **Available Version:** 60.0 + type: array + items: + type: object + operator: + description: | + Operator use in filter. + + **Available Version:** 60.0 + type: string + type: + description: | + Data type of field to filter. + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + required: + - field + - operands + - operator + - type + FilterExpressionRepresentation: + title: Filter Expression Output + description: Represents a filter expression. + type: object + properties: + field: + description: | + The field to filter on. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + operands: + description: | + Filter expression operands. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: object + operator: + description: | + Operator used in the filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Data type of the filtered field. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + FilterNodeInputRepresentation: + title: Filter Node Input + description: Represents filter node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + allOf: + - $ref: "#/components/schemas/FilterParametersInputRepresentation" + required: + - parameters + FilterNodeRepresentation: + title: Filter Node Output + description: Represents a filter node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FilterParametersRepresentation" + FilterParametersInputRepresentation: + title: Filter Parameters Input + description: Represents filter expression. + type: object + properties: + filterBooleanLogic: + description: | + Filter boolean logic. + + **Available Version:** 60.0 + type: string + filterExpressions: + description: | + Filter expressions. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FilterExpressionInputRepresentation" + required: + - filterBooleanLogic + - filterExpressions + FilterParametersRepresentation: + title: Filter Parameters Output + description: Represents a filter node. + type: object + properties: + filterBooleanLogic: + description: | + Filter boolean logic. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + filterExpressions: + description: | + Filter expressions. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FilterExpressionRepresentation" + FilterValuesInputRepresentation: + title: Filter Values Input + description: Represents the input for filter values. + type: object + properties: + values: + description: | + List of values. + + **Available Version:** 60.0 + type: array + items: + type: string + required: + - values + FilterValuesRepresentation: + title: Filter Values Output + description: Represents the filter values for an attribute. + type: object + properties: + values: + description: | + List of filter values. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + FlattenFieldInputRepresentation: + title: Flatten Field Input + description: Flatten node field representation. + type: object + properties: + label: + description: | + Label. + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Available Version:** 60.0 + type: string + required: + - label + - name + FlattenFieldRepresentation: + title: Flatten Field Output + type: object + description: Represents a flatten node field. + properties: + isSystemField: + description: | + Indicates whether the field is a system field (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + label: + description: | + Label of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FlattenJsonNodeInputRepresentation: + title: Flatten Json Node Input + description: Represents the input for a flatten JSON node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Parameters for the flatten node type, which contains schema and table information. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenJsonParametersInputRepresentation" + required: + - parameters + FlattenJsonNodeRepresentation: + title: Flatten Json Node Output + description: Represents a flatten JSON node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenJsonParametersRepresentation" + FlattenJsonParametersInputRepresentation: + title: Flatten Json Parameters Input + type: object + description: Represents the input for flatten JSON node parameters. + properties: + jsonSchemaDetails: + description: | + JSON schema of the data to be flatten in this node. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JsonSchemaDetailsInputRepresentation" + sourceField: + description: | + Field name that contains the JSON string to be flattened. + + **Available Version:** 60.0 + type: string + tables: + description: | + Map of table names and configurations to be produced by this node. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + FlattenJsonParametersRepresentation: + title: Flatten Json Parameters Output + type: object + description: Represents flatten JSON parameters. + properties: + jsonSchemaDetails: + description: | + JSON schema details. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JsonSchemaDetailsRepresentation" + sourceField: + description: | + Field name that contains the JSON string to be flattened. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + tables: + description: | + Mapping between the parameter and fields within the parameter. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + description: | + List of JSON schema fields for flattening. + + **Filter Group:** Small + + **Available Version:** 60.0 + properties: + fields: + description: | + JSON schema fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FieldRepresentation" + FlattenNodeInputRepresentation: + title: Flatten Node Input + description: Represents flatten node input. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenParametersInputRepresentation" + required: + - parameters + FlattenNodeRepresentation: + title: Flatten Node Output + description: Represents a flatten node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenParametersRepresentation" + FlattenParametersInputRepresentation: + title: Flatten Parameters Input + description: Flatten node. + type: object + properties: + delimiter: + description: | + Delimiter. + + **Available Version:** 60.0 + type: string + includeSelfId: + description: | + Indicates whether to include self ID (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + parentField: + description: | + Parent field. + + **Available Version:** 60.0 + type: string + pathField: + description: | + Path field. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenFieldInputRepresentation" + selfField: + description: | + Self field. + + **Available Version:** 60.0 + type: string + required: + - delimiter + - includeSelfId + - parentField + - pathField + - selfField + FlattenParametersRepresentation: + title: Flatten Parameters Output + type: object + description: Represents flatten node parameters. + properties: + delimiter: + description: | + Delimiter field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + includeSelfId: + description: | + Indicates whether to include the self ID (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + parentField: + description: | + Parent field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + pathField: + description: | + Path to the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FlattenFieldRepresentation" + selfField: + description: | + Self field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FormatDateNodeInputRepresentation: + title: Format Date Node Input + description: Represents the date format conversion node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormatDateParametersInputRepresentation" + required: + - parameters + FormatDateNodeRepresentation: + title: Format Date Node Output + description: Represents a date format conversion node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormatDateParametersRepresentation" + FormatDateParametersInputRepresentation: + title: Format Date Parameters Input + description: Format date node representation. + type: object + properties: + sourceField: + description: | + Source field to format. + + **Available Version:** 60.0 + type: string + sourceFormats: + description: | + Source date formats. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FormatDatePatternInputRepresentation" + targetField: + description: | + Target field. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/NameLabelInputRepresentation" + targetFormat: + description: | + Target date format. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormatDatePatternInputRepresentation" + required: + - sourceField + - sourceFormats + - targetField + - targetFormat + FormatDateParametersRepresentation: + title: Format Date Parameters Output + type: object + description: Represents format date node parameters. + properties: + sourceField: + description: | + Name of the source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceFormats: + description: | + List of source formats. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FormatDatePatternRepresentation" + targetField: + description: | + Source target fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/NameLabelRepresentation" + targetFormat: + description: | + Target format. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormatDatePatternRepresentation" + FormatDatePatternInputRepresentation: + title: Format Date Pattern Input + description: Format date pattern representation. + type: object + properties: + construction: + description: | + Construction. + + **Available Version:** 60.0 + type: array + items: + type: string + groups: + description: | + Groups. + + **Available Version:** 60.0 + type: array + items: + type: string + regex: + description: | + Regular expression. + + **Available Version:** 60.0 + type: string + required: + - construction + - groups + - regex + FormatDatePatternRepresentation: + title: Format Date Pattern Output + type: object + description: Reperesents a format date pattern. + properties: + construction: + description: | + Construction of the date pattern. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + groups: + description: | + List of groups in the date pattern. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + regex: + description: | + Regular expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + FormulaNodeInputRepresentation: + title: Formula Node Input + description: Represents formula node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormulaParametersInputRepresentation" + required: + - parameters + FormulaNodeRepresentation: + title: Formula Node Output + description: Represents a formula node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FormulaParametersRepresentation" + FormulaParametersInputRepresentation: + title: Formula Parameters Input + description: Represents a formula. + type: object + properties: + expressionType: + description: | + Type of formula expression. + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + FormulaParametersRepresentation: + title: Formula Parameters Output + type: object + description: Represents formula parameters. + discriminator: + propertyName: expressionType + properties: + expressionType: + description: | + Type of SQL formula expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + IdpConfigExtractedDloFieldInputRepresentation: + title: Document AI Config Extracted DLO Field Input + description: This type contains the fields required to configure an extracted field. + type: object + properties: + name: + description: | + Name of the extracted field. + This is the identifier for the field in the extracted data. + + **Available Version:** 63.0 + type: string + label: + description: | + Display label for the extracted field. + This is the human-readable name for the field. + + **Available Version:** 63.0 + type: string + dataType: + description: | + Data type of the extracted field. + Specifies how the field data should be interpreted. + + **Available Version:** 63.0 + enum: + - STRING + - NUMBER + - DATE + - BOOLEAN + type: string + required: + description: | + Whether the field is required. + Indicates if this field must have a value in the extracted data. + + **Available Version:** 63.0 + type: boolean + validationRules: + description: | + Validation rules for the extracted field. + Defines additional validation criteria for the field data. + + **Available Version:** 63.0 + type: object + required: + - name + - label + - dataType + - required + IdpConfigExtractedDloFieldRepresentation: + title: Document AI Config Extracted DLO Field Output + description: This type defines the properties and validation rules for an extracted field. + type: object + properties: + dloField: + description: | + The output DLO field. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + schemaName: + description: | + 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 + type: string + IdpConfigExtractedDloInputRepresentation: + title: Document AI Config Extracted DLO Input + description: This type contains the fields required to configure DLO extraction settings. + type: object + properties: + fields: + description: | + List of extracted DLO fields. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpConfigExtractedDloFieldInputRepresentation" + mappingRules: + description: | + Mapping rules for extracted data. + Defines how extracted data should be mapped to target fields. + + **Available Version:** 63.0 + type: object + required: + - fields + IdpConfigExtractedDloRepresentation: + title: Document AI Config Extracted DLO Output + description: This type defines how data should be extracted and mapped from documents. + type: object + properties: + dlo: + description: | + The output DLO. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + fields: + description: | + List of extracted DLO fields. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpConfigExtractedDloFieldRepresentation" + schemaName: + description: | + 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 + type: string + IdpConfigurationBaseRepresentation: + title: Idp Configuration Base Output + description: Represents the Document AI configuration base output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + activationStatus: + description: | + The configuration activation status. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Activated + - Deactivated + type: string + configMetadata: + description: | + A collection of custom key-value pairs. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: object + additionalProperties: + type: string + dataspace: + description: | + Data space of the configuration. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + description: + description: | + Description of the configuration. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + lastRunOn: + description: | + The last unstructured data-extraction job run. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + mlModel: + description: | + The ML model used to extract the unstructured data. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + runtimeStatus: + description: | + The status of the last off-core unstructured data-extraction job run. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Aborted + - Failed + - InProgress + - NotStarted + - Pending + - Ready + - Submitted + - Success + type: string + sourceDmo: + description: | + The unstructured DMO used as the input for the data extraction process. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + status: + description: | + The status of the latest configuration version that's been synced off-core. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - Error + - NotSynced + - Synced + - Syncing + type: string + version: + description: | + The current version of the configuration. This is incremented automatically with each edit. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpConfigurationDetailsRepresentation: + title: Document AI Configuration Details Output + description: Detailed representation of an Document AI configuration. + allOf: + - $ref: "#/components/schemas/IdpConfigurationBaseRepresentation" + - type: object + properties: + extractedDloConfig: + description: | + The configuration details of the DLOs to be extracted. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + extractedDlos: + description: | + List of references for the output DLOs. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpConfigExtractedDloRepresentation" + fileConfig: + description: | + The specs for the file types supported by the Document AI process. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/IdpFileConfigRepresentation" + schemaConfig: + description: | + The schema of the data to be extracted. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpConfigurationInputRepresentation: + title: Document AI Configuration Input + description: Input representation for creating or updating an Document AI configuration. + type: object + properties: + activationStatus: + description: | + Status of the configuration. + + **Available Version:** 63.0 + enum: + - Activated + - Deactivated + type: string + configMetadata: + description: | + A custom collection of key-value attributes. + + **Available Version:** 63.0 + type: object + description: + description: | + Description of the configuration. + + **Available Version:** 63.0 + type: string + extractedDloConfig: + description: | + The configuration details for the DLOs to be extracted. + + **Available Version:** 63.0 + type: object + additionalProperties: + $ref: "#/components/schemas/IdpConfigExtractedDloInputRepresentation" + fileConfig: + description: | + The specs for the file types supported by the Document AI process to be created. + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/IdpFileConfigInputRepresentation" + label: + description: | + Display label of the configuration. + + **Available Version:** 63.0 + type: string + mlModel: + description: | + The API name of the model used to extract the unstructured data. + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the configuration. + + **Available Version:** 63.0 + type: string + schemaConfig: + description: | + The schema of the data to be extracted. + + **Available Version:** 63.0 + type: string + sourceDmoDeveloperName: + description: | + The API name of the unstructured DMO used as input to the data + extraction process. + + **Available Version:** 63.0 + type: string + required: + - activationStatus + - fileConfig + - label + - mlModel + - name + - schemaConfig + IdpConfigurationPatchInputRepresentation: + title: Document AI Configuration Patch Input + description: Input representation for patching an Document AI configuration. + type: object + properties: + activationStatus: + description: | + Activation status of the configuration. + + **Available Version:** 63.0 + enum: + - Activated + - Deactivated + type: string + description: + description: | + New description for the configuration. + + **Available Version:** 63.0 + type: string + label: + description: | + New display label for the configuration. + + **Available Version:** 63.0 + type: string + IdpConfigurationRepresentation: + title: Document AI Configuration Output + description: Represents a Document AI configuration. + allOf: + - $ref: "#/components/schemas/IdpConfigurationBaseRepresentation" + IdpConfigurationsCollectionRepresentation: + title: Document AI Configurations Collection Output + description: Represents a collection of Document AI configurations with pagination + information. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + configurations: + description: | + List of Document AI configurations. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpConfigurationRepresentation" + required: + - configurations + IdpContentTypeRepresentation: + title: Document AI Content Type Output + description: This type defines the properties of a supported document content + type. + type: object + properties: + label: + description: | + Label of the file type. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of file. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpExtractDataInputRepresentation: + title: Document AI Extract Data Input + description: Input representation for extracting data from a document. + type: object + properties: + files: + description: | + The list of unstructured data source files to extract the schema from. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpGenerateSchemaFileInputRepresentation" + idpConfigurationIdOrName: + description: | + ID of the Document AI configuration to use. Either idpConfigurationIdOrName or mlModel and schemaConfig must be present. + + **Available Version:** 63.0 + type: string + mlModel: + description: | + 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 + type: string + schemaConfig: + description: | + 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 + type: string + required: + - files + IdpExtractedDataRepresentation: + title: Document AI Extracted Data Output + description: Represents data extracted from a document. + type: object + properties: + data: + description: | + Extracted data. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpExtractedFileDataRepresenation" + IdpExtractedFileDataRepresenation: + title: Document AI Extracted File Data Output + description: Represents extracted file data. + type: object + properties: + data: + description: | + 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 + type: string + error: + description: | + Error message if the data extraction fails. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpFileAdditionalParamsInputRepresentation: + type: object + description: Represents the additional parameters for file processing in IDP. + properties: + sheetName: + description: | + Name of the sheet to extract data from, for Excel and Google Sheets files. + + **Available Version:** 67.0 + type: string + IdpFileConfigInputRepresentation: + title: Document AI File Config Input + description: This type contains the fields required to configure file processing settings. + type: object + properties: + fileTypes: + description: | + List of allowed file formats for processing. + Specifies which file types can be processed by this configuration. + + **Available Version:** 63.0 + type: array + items: + type: string + required: + - fileTypes + IdpFileConfigRepresentation: + title: Document AI File Config Output + description: Represents the file types supported by the Document AI process. + type: object + properties: + allowedFileTypes: + description: | + List of file formats that are supported by the Document AI process. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + IdpGeneratedSchemaRepresentation: + title: Document AI Generated Schema Output + description: Represents a generated schema for an Document AI configuration. + type: object + properties: + error: + description: | + Error message if the schema generation fails. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + schema: + description: | + JSON schema definition. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpGenerateSchemaFileInputRepresentation: + title: Document AI Generate Schema File Input + description: This type contains the fields required to generate a schema from + a file. + type: object + properties: + additionalParams: + description: | + Additional parameters for file processing, for example, `sheetName` for Excel and Google Sheets. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/IdpFileAdditionalParamsInputRepresentation" + data: + description: | + Base64-encoded content of the file. + The actual file data in base64 format. + + **Available Version:** 63.0 + type: string + fileId: + description: | + Either a Salesforce file Id or a URI to SF Drive. + + **Available Version:** 63.0 + type: string + mimeType: + description: | + The file type. + + **Available Version:** 63.0 + type: string + IdpGenerateSchemaInputRepresentation: + title: Document AI Generate Schema Input + description: Input representation for generating a schema for an Document AI configuration. + type: object + properties: + files: + description: | + The list of unstructured data source files to extract the schema from. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpGenerateSchemaFileInputRepresentation" + mlModel: + description: | + 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 + type: string + required: + - files + - mlModel + IdpGlobalConfigRepresentation: + title: Document AI Global Config Output + description: Represents the global configuration for Document AI. + type: object + properties: + supportedContentTypes: + description: | + Content types supported for unstructured data extraction. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpContentTypeRepresentation" + supportedModels: + description: | + Models supported for unstructured data extraction. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/IdpSupportedModelRepresentation" + version: + description: | + The version of the configuration schema. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IdpSchemaDetectionInnerRepresentation: + title: Idp Schema Detection Inner Output + type: object + description: Represents the data in IDP schema detection results. + properties: + matchingFieldsInSchema: + description: | + Matching number of fields in the schema. Only returned for the `Single` schema detection mode. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: integer + matchingScore: + description: | + Matching score for the schema with the requested document. Only returned for the `Single` schema detection mode. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: number + format: double + pages: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/IdpSchemaDetectionPagesRepresentation" + schemaConfiguration: + description: | + Name of the schema configuration. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: string + totalFieldsInSchema: + description: | + Total number of fields in the schema. Only returned for the `Single` schema detection mode. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: integer + IdpSchemaDetectionInputRepresentation: + title: Idp Schema Detection Input + type: object + description: Represents the input for IDP schema detection. + properties: + files: + description: | + List of unstructured source files to detect the schema from. Supported file types are: PDF (`application/pdf`) and images (`image/png`, `image/jpg`, `image/jpeg`). + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/IdpGenerateSchemaFileInputRepresentation" + mlModel: + description: | + ID of the model to use for schema detection. + + **Available Version:** 67.0 + type: string + mode: + description: | + 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 + type: string + enum: + - Multi + - Single + schemaConfigurations: + description: | + List of Document AI schema configuration IDs to match against. + + **Available Version:** 67.0 + type: array + items: + type: string + IdpSchemaDetectionPagesRepresentation: + title: Idp Schema Detection Pages Output + type: object + description: Represents the pages in an IDP schema detection output. + properties: + matchingScore: + description: | + Matching score for the associated schema. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: number + format: double + pageNumber: + description: | + Page number from the document. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: integer + IdpSchemaDetectionRepresentation: + title: Idp Schema Detection Output + type: object + description: Represents IDP schema detection results. + properties: + data: + description: | + List of schema detection results. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/IdpSchemaDetectionInnerRepresentation" + IdpSupportedModelRepresentation: + title: Document AI Supported Model Output + description: This type defines the properties of a supported Document AI processing model. + type: object + properties: + id: + description: | + Unique identifier for the model. + This ID is used to reference the model in other API calls. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + label: + description: | + Label of the model. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + provider: + description: | + Provider of the model, such as `Open AI`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + IndexConfigInputRepresentation: + title: Index Config Input + type: object + description: Represents the input for a semantic search index configuration. + properties: + contextFieldConfiguration: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/ContextFieldConfigurationInputRepresentation" + recordFieldConfiguration: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/RecordFieldConfigurationInputRepresentation" + shouldVectorizeSearchableFields: + description: | + Indicates whether the searchable fields are vectorized (`true`) or not (`false`). + + **Available Version:** 64.0 + type: boolean + IndexConfigurationRepresentation: + title: Index Configuration Output + type: object + description: Represents the index configuration for a semantic search record. + properties: + contextFieldConfiguration: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/ContextFieldConfigurationRepresentation" + recordFieldConfiguration: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/RecordFieldConfigurationRepresentation" + shouldVectorizeSearchableFields: + description: | + Indicates whether the searchable fields are vectorized (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 64.0 + type: boolean + IndexFieldConfigurationInputRepresentation: + title: Index Field Configuration Input + type: object + description: Represents the input for index field configurations. + properties: + aliasName: + description: | + Alias of the index field. + + **Available Version:** 64.0 + type: string + dmoDeveloperName: + description: | + Developer name of the DMO. + + **Available Version:** 64.0 + type: string + dmoFieldDeveloperName: + description: | + Developer name of the DMO field. + + **Available Version:** 64.0 + type: string + relationships: + description: | + Field relationship paths between the source DMO fields and target DMO fields. + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/SourceTargetRelationshipInputRepresentation" + IndexFieldConfigurationRepresentation: + title: Index Field Configuration Output + type: object + description: Represents index field configurations. + properties: + aliasName: + description: | + Alias of the index field. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + dmoDeveloperName: + description: | + Developer name of the DMO. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + dmoFieldDeveloperName: + description: | + Developer name of the DMO field. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: string + relationships: + description: | + Field relationship paths between the source DMO fields and target DMO fields. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: array + items: + $ref: "#/components/schemas/FieldRelationshipsPathRepresentation" + IngestApiConnectionInputRepresentation: + title: Ingest API Connection Input + description: Input representation for an Ingest API connector. + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + IngestApiConnectionRepresentation: + title: Ingest API Connection Output + description: Represents an Ingest API connector. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + status: + description: | + Status of the Ingest API connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Connected + - Disconnected + - Failed + - NeedsReAuth + tenantSpecificEndpoint: + description: | + Tenant-specific endpoint of the Ingest API connector. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + IngestApiConnectionSchemaFieldInputRepresentation: + title: Ingest API Connection Schema Field Input + description: Represents the input for Ingestion API field types. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldInputRepresentation" + - type: object + properties: + currencyIsoCode: + description: | + Indicates whether the field is a currency ISO code (`true`) or not (`false`). + + **Available Version:** 61.0 + type: boolean + dataType: + description: | + Data type of the field. + + **Available Version:** 61.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + IngestApiConnectionSchemaFieldRepresentation: + title: Ingest API Connection Schema Field Output + description: Represents an Ingestion API connection schema field. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldRepresentation" + - type: object + properties: + currencyIsoCode: + description: | + Indicates whether the field is a currency ISO code (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + dataType: + description: | + Data type of the schema field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + IngestApiConnectionSchemaInputRepresentation: + title: Ingest API Connection Schema Input + description: Represents the input for an ingestion API schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaInputRepresentation" + - type: object + properties: + fields: + description: | + List of schema fields. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/IngestApiConnectionSchemaFieldInputRepresentation" + IngestApiConnectionSchemaRepresentation: + title: Ingest API Connection Schema Output + description: Represents a streaming app connection schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaRepresentation" + - type: object + properties: + availabilityStatus: + description: | + Availability status of the event. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Available + - InUse + fields: + description: | + List of schema fields. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/IngestApiConnectionSchemaFieldRepresentation" + IngestApiConnectorDetailsConfig: + title: Ingest API Connector Details Config Input + description: Represents the configuration details for an Ingestion API connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsConfig" + - type: object + properties: + events: + description: | + List of developer names of events from the schema selected from the connected app. + + **Available Version:** 63.0 + type: array + items: + type: string + name: + description: | + Name of the Ingestion API connector. + + **Available Version:** 63.0 + type: string + IngestionApiConnectorDetailsRepresentation: + title: Ingestion API Connector Details Output + description: Represents the output for an Ingestion API connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsRepresentation" + - type: object + properties: + events: + description: | + Develoepr names of the Ingestion API connector events. + + **Available Version:** 61.0 + type: array + items: + type: string + JoinNodeInputRepresentation: + title: Join Node Input + description: Represents join data node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JoinParametersInputRepresentation" + required: + - parameters + JoinNodeRepresentation: + title: Join Node Output + description: Represents a join data node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JoinParametersRepresentation" + JoinParametersInputRepresentation: + title: Join Parameters Input + description: Represents join node. + type: object + properties: + joinType: + description: | + Join type. + + **Available Version:** 60.0 + enum: + - Cross + - Inner + - LeftOuter + - Lookup + - MultiValueLookup + - Outer + - RightOuter + type: string + leftKeys: + description: | + Left keys. + + **Available Version:** 60.0 + type: array + items: + type: string + leftQualifier: + description: | + Left qualifier. + + **Available Version:** 60.0 + type: string + rightKeys: + description: | + Right keys. + + **Available Version:** 60.0 + type: array + items: + type: string + rightQualifier: + description: | + Right qualifier. + + **Available Version:** 60.0 + type: string + required: + - joinType + - leftKeys + - leftQualifier + - rightKeys + - rightQualifier + JoinParametersRepresentation: + title: Join Parameters Output + type: object + description: Represents join node parameters.. + properties: + joinType: + description: | + Type of join. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Cross + - Inner + - LeftOuter + - Lookup + - MultiValueLookup + - Outer + - RightOuter + leftKeys: + description: | + List of join left keys. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + leftQualifier: + description: | + Name of the join left qualifier. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + rightKeys: + description: | + List of join right keys. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + rightQualifier: + description: | + Name of the join right qualifier. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + JsonArrayInputRepresentation: + title: Json Array Input + description: Represents the input for an array JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + properties: + items: + description: | + List of items in the array. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + JsonBooleanInputRepresentation: + title: Json Boolean Input + description: Represents the input for a boolean JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + JsonIntegerInputRepresentation: + title: Json Integer Input + description: Represents the input for an integer JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + JsonNullInputRepresentation: + title: Json Null Input + description: Represents the input for a null JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + JsonNumberInputRepresentation: + title: Json Number Input + description: Represents the input for a number JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + JsonObjectInputRepresentation: + title: Json Object Input + description: Represents the input for an object JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + properties: + properties: + description: | + Mapping of property names and corresponding JSON schemas. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: object + required: + description: | + List of attributes that are marked as required in the JSON schema. + + **Available Version:** 60.0 + type: array + items: + type: string + JsonSchemaDetailsInputRepresentation: + title: Json Schema Details Input + type: object + description: Represents the input for JSON schema details. + properties: + dateAdded: + description: | + Date for when the file was uploaded in the UI. + + **Available Version:** 60.0 + type: integer + format: int64 + name: + description: | + Name of the file uploaded in the UI that contains the JSON schema. + + **Available Version:** 60.0 + type: string + schema: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/JsonArrayInputRepresentation" + - $ref: "#/components/schemas/JsonBooleanInputRepresentation" + - $ref: "#/components/schemas/JsonIntegerInputRepresentation" + - $ref: "#/components/schemas/JsonNullInputRepresentation" + - $ref: "#/components/schemas/JsonNumberInputRepresentation" + - $ref: "#/components/schemas/JsonObjectInputRepresentation" + - $ref: "#/components/schemas/JsonStringInputRepresentation" + size: + description: | + Size of the file (in MB) that contains the JSON schema. + + **Available Version:** 60.0 + type: number + format: double + JsonSchemaDetailsRepresentation: + title: Json Schema Details Output + type: object + description: Represents JSON schema details. + properties: + dateAdded: + description: | + Date for when the file was uploaded in the UI. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + format: int64 + name: + description: | + Name of the file uploaded in the UI that contains the JSON schema. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + schema: + description: | + JSON schema. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/JsonSchemaRepresentation" + size: + description: | + Size of the file (in MB) that contains the JSON schema. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: number + format: double + JsonSchemaInputRepresentation: + title: Json Schema Input + type: object + description: Represents the input for a JSON schema. + properties: + type: + description: | + Data type of the JSON field. + + **Available Version:** 60.0 + type: string + enum: + - Array + - Boolean + - Integer + - "Null" + - Number + - Object + - String + JsonSchemaRepresentation: + title: Json Schema Output + type: object + description: Represents a JSON schema. + properties: + type: + description: | + Type of schema field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Array + - Boolean + - Integer + - 'Null' + - Number + - Object + - String + JsonStringInputRepresentation: + title: Json String Input + description: Represents the input for a string JSON field. + allOf: + - $ref: "#/components/schemas/JsonSchemaInputRepresentation" + - type: object + LoadDatasetInputRepresentation: + title: Load Data Input + description: Represents the data to load. + type: object + properties: + label: + description: | + Label for the data. + + **Available Version:** 60.0 + type: string + type: + description: | + Data object type. + + **Available Version:** 60.0 + enum: + - DataLakeObject + - DataModelObject + type: string + required: + - label + - type + LoadDatasetRepresentation: + title: Load Dataset Output + description: Represents the dataset of a load node. + type: object + discriminator: + propertyName: type + properties: + label: + description: | + Label for the dataset. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type of dataset. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - CalculatedInsightObject + - DataLakeObject + - DataModelObject + type: string + LoadNodeInputRepresentation: + title: Load Node Input + description: Represents load data node in a batch data transform. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/LoadParametersInputRepresentation" + required: + - parameters + LoadNodeRepresentation: + title: Load Node Output + description: Represents a load node output. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/LoadParametersRepresentation" + LoadParametersInputRepresentation: + title: Load Parameters Input + description: Represents load node. + type: object + properties: + dataset: + description: | + Data to load. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/LoadDatasetInputRepresentation" + fields: + description: | + Fields to load. + + **Available Version:** 60.0 + type: array + items: + type: string + sampleDetails: + description: | + Sample parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SampleParametersInputRepresentation" + sampleSize: + description: | + Number of rows to load. + + **Available Version:** 60.0 + type: integer + required: + - dataset + - fields + - sampleDetails + - sampleSize + LoadParametersRepresentation: + title: Load Parameters Output + description: Represents load node output. + type: object + properties: + dataset: + description: | + Input dataset. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/LoadDatasetRepresentation" + fields: + description: | + Fields to select. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + sampleDetails: + description: | + Sample parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SampleParametersRepresentation" + sampleSize: + description: | + Sample size. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + MarketingCloudConnectionBusinessUnitRepresentation: + title: Marketing Cloud Connection Business Unit Output + description: Represents a business unit for the Marketing Cloud connector. + type: object + properties: + id: + description: | + ID of the business unit. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + label: + description: | + Label of the business unit. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + mid: + description: | + Member ID (MID) of the business unit. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + Developer name of the business unit. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + MarketingCloudConnectionInputRepresentation: + title: Marketing Cloud Connection Input + description: Input representation for a Marketing Cloud connector. + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + MarketingCloudConnectionPatchInputRepresentation: + title: Marketing Cloud Connection Patch Input + description: Input representation for a Marketing Cloud connector for a patch request. + allOf: + - $ref: "#/components/schemas/ConnectionPatchInputRepresentation" + - type: object + properties: + addActivationBusinessUnits: + description: | + List of Marketing Cloud business units to be added for activation. + + **Available Version:** 63.0 + type: array + items: + type: string + addBusinessUnitsToDataSpaces: + description: | + List of Marketing Cloud business-unit-to-data-space mappings to be added. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/McBuToDataSpaceInputRepresentation" + addIngestionBusinessUnits: + description: | + List of Marketing Cloud business units to be added for data ingestion. + + **Available Version:** 63.0 + type: array + items: + type: string + createProfileMappings: + description: | + Indicates whether mapping data for profile business units is allowed (`true`) or not (`false`). + + **Available Version:** 63.0 + type: boolean + removeActivationBusinessUnits: + description: | + List of Marketing Cloud business unit activations to be removed. + + **Available Version:** 63.0 + type: array + items: + type: string + removeBusinessUnitsToDataSpaces: + description: | + List of Marketing Cloud business-unit-to-data-space mappings to be removed. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/McBuToDataSpaceInputRepresentation" + removeIngestionBusinessUnits: + description: | + List of Marketing Cloud business units from which data ingestion is to be removed. + + **Available Version:** 63.0 + type: array + items: + type: string + MarketingCloudConnectionRepresentation: + title: Marketing Cloud Connection Output + description: Represents a Marketing Cloud connector. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + activationBusinessUnits: + description: | + List of member IDs (MIDs), Marketing Cloud business units, selected for activation. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/MarketingCloudConnectionBusinessUnitRepresentation" + businessUnitsToDataSpaces: + description: | + List of Marketing Cloud business-unit-to-data-space mappings. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/McBuToDataSpaceRepresentation" + createProfileBuMappings: + description: | + 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 + type: boolean + eid: + description: | + 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 + type: string + ingestionBusinessUnits: + description: | + List of member IDs (MIDs), Marketing Cloud business units, selected for ingestion. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: array + items: + $ref: "#/components/schemas/MarketingCloudConnectionBusinessUnitRepresentation" + MatchBoostOutputBridgeTableInputRepresentation: + title: Match Boost Output Bridge Table Input + type: object + description: Represents the bridge table input for a match boost use case template object. + properties: + sourceIdFieldName: + description: | + Column name corresponding to the equivalent column in the shared data. + + **Available Version:** 66.0 + type: string + MatchBoostOutputObjectConfigRepresentation: + title: Match Boost Output Object Config Input + type: object + description: Represents the configuration input for match boost use case template output objects. + properties: + bridgeTable: + description: | + Details about the bridge table. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MatchBoostOutputBridgeTableInputRepresentation" + objectName: + description: | + Name of the object. + + **Available Version:** 66.0 + type: string + relatedTable: + description: | + Details about the related table. + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MatchBoostOutputBridgeTableInputRepresentation" + MatchBoostOutputObjectInputRepresentation: + title: Match Boost Output Object Input + type: object + description: Represents the input for match boost use case template output objects. + properties: + outputObjectConfigs: + description: | + Configuration of the output objects. + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MatchBoostOutputObjectConfigRepresentation" + MatchBoostUsecaseConfigInputRepresentation: + title: Match Boost Usecase Config Input + description: Represents the input for match boost use case template types. + allOf: + - $ref: "#/components/schemas/DataCleanRoomUsecaseConfigInputRepresentation" + - type: object + properties: + outputObjects: + description: | + List of output objects for the use case template. + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MatchBoostOutputObjectInputRepresentation" + supportedContactPoints: + description: | + List of contact points supported by the provider. + + **Available Version:** 66.0 + type: array + items: + type: string + enum: + - Email + - PhoneNumber + McBuToDataSpaceInputRepresentation: + title: Marketing Cloud Business Unit to Data Space Input + description: Input representation for Marketing Cloud business-unit-to-data-space mappings for a patch request. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + dataspaceName: + description: | + Name of the data space. + + **Available Version:** 63.0 + type: string + mid: + description: | + 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 + type: string + required: + - dataspaceName + - mid + McBuToDataSpaceRepresentation: + title: Marketing Cloud Business Unit to Data Space Output + description: Represents a mapping of a Marketing Cloud business unit to a data space. + type: object + properties: + dataSpaceId: + description: | + ID of the data space object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataSpaceName: + description: | + Name of the data space. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + internalOrgId: + description: | + ID of the internal org object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + internalOrgName: + description: | + Name of the internal org, a Marketing Cloud business unit name. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + label: + description: | + Label of the data space internal org object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + mid: + description: | + Member ID (MID) of the internal org's external record. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + Name of the data space internal org object. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + MlBinaryClassificationJobDefInputRepresentation: + title: Ml Binary Classification Job Def Input + description: Represents the input for creating a binary classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveInputRepresentation" + - type: object + properties: + binaryClassificationSettings: + description: | + Binary classification settings. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlBinaryClassificationJobDefSettingsInputRepresentation" + MlBinaryClassificationJobDefRepresentation: + title: Ml Binary Classification Job Def Output + description: Represents a binary classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveRepresentation" + - type: object + properties: + binaryClassificationSettings: + description: | + Settings configuration for the binary classification prediction job definition. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlBinaryClassificationJobDefSettingsRepresentation" + MlBinaryClassificationJobDefSettingsInputRepresentation: + title: Ml Binary Classification Job Def Settings Input + type: object + description: Represents the settings configuration for a binary classification prediction job definition. + properties: + maxPrescriptions: + description: | + Maximum number of prescriptions to generate. + + **Available Version:** 66.0 + type: integer + maxTopContributors: + description: | + Maximum number of top contributors to generate. + + **Available Version:** 66.0 + type: integer + prescriptionThreshold: + description: | + Prescription threshold value. + + **Available Version:** 66.0 + type: integer + showClassProbabilities: + description: | + 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 + type: boolean + MlBinaryClassificationJobDefSettingsRepresentation: + title: Ml Binary Classification Job Def Settings Output + type: object + description: Represents the settings configuration for a binary classification prediction job definition. + properties: + maxPrescriptions: + description: | + Maximum number of prescriptions to include per prediction. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + maxTopContributors: + description: | + Maximum number of top contributors to include per prediction. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + prescriptionThreshold: + description: | + Improvement threshold for prescriptions. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + showClassProbabilities: + description: | + 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 + type: boolean + MlConfiguredModelCollectionRepresentation: + title: ML Configured Model Collection Output + description: Represents Ml Configured Model Collection + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + configuredModels: + description: | + List of configured models that are available in the org. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlConfiguredModelRepresentation" + required: + - configuredModels + MlConfiguredModelInputRepresentation: + title: ML Configured Model Input + description: Input representation for an Ml Configured Model + type: object + properties: + actionableFields: + description: | + 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 + type: array + items: + type: object + artifact: + description: | + Model artifact. + + **Available Version:** 61.0 + type: object + capability: + description: | + The model's capabilities. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - BinaryClassification + - ChatCompletion + - Completion + - Embedding + - Generic + - MulticlassClassification + - Regression + type: string + description: + description: | + Model description. + + **Available Version:** 61.0 + type: string + label: + description: | + Model's label. + + **Available Version:** 61.0 + type: string + parameterOverrides: + description: | + Model parameter overrides. + + **Available Version:** 61.0 + type: array + items: + type: object + status: + description: | + Whether the model is enabled or disabled. + + **Available Version:** 61.0 + enum: + - Disabled + - Enabled + type: string + required: + - actionableFields + - artifact + - capability + - description + - label + - parameterOverrides + - status + MlConfiguredModelRepresentation: + title: ML Configured Model Output + description: Represents a machine learning configured model output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + actionableFields: + description: | + List of actionable fields. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlCustomizableFieldRepresentation" + activations: + description: | + List of activations. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + enum: + - Flow + - PredictionJob + type: string + artifact: + description: | + The model artifact. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + capability: + description: | + Model capability. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - BinaryClassification + - ChatCompletion + - Completion + - Embedding + - Generic + - MulticlassClassification + - Regression + type: string + connectorType: + description: | + If the configured model references a model connector, this parameter indicates the connector type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Anthropic + - AzureOpenAI + - Bedrock + - Databricks + - Generic + - InternalEmbedding + - OpenAI + - SageMaker + - VertexAI + type: string + description: + description: | + User-defined description of the configured model. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + foundationalModel: + description: | + Details for the foundational model. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpMlFoundationalModelRepresentation" + generativeModelType: + description: | + Type of generative model. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Mixed + - Text + inputFields: + description: | + List of input features into the model. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelInputFieldBaseRepresentation" + inputTypes: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/MlModelInputTypeRepresentation" + isBatchSupported: + description: | + Indicates whether this model supports batch (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + lastActivatedBy: + description: | + Information about the user who last activated the configured model. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpUserRepresentation" + lastActivatedDate: + description: | + Date the configured model was last activated. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + modelCapabilities: + description: | + List of capabilities supported by the model. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - BinaryClassification + - ChatCompletion + - Completion + - Embedding + - Generic + - MulticlassClassification + - Regression + - SpeechSynthesis + - Summarization + - Transcribe + modelDisabledReasons: + description: | + Reason(s) why the model status is disabled. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + type: string + modelType: + description: | + Referenced model type. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Generative + - Predictive + - Unknown + type: string + outputFields: + description: | + List of output features from the model. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelOutputFieldRepresentation" + outputTypes: + description: | + List of supporting output types for multi-modalities, including parameters and their corresponding values. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/MlModelOutputTypeRepresentation" + parameterOverrides: + description: | + List of model parameter overrides. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelParameterOverrideBaseRepresentation" + parameters: + description: | + List of parameters supported by the model. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/CdpMlModelParameterDefinitionBaseRepresentation" + runtimeType: + description: | + Model runtime type. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - External + - Internal + setupType: + description: | + 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 + enum: + - EdcNoCode + - ModelConnector + - OutOfTheBox + type: string + status: + description: | + Model status. + + **Filter Group:** Small + + **Available Version:** 61.0 + enum: + - Disabled + - Enabled + type: string + visibility: + description: | + Model visibility. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - Hidden + - Shown + MlConnectorEndpointRepresentation: + title: ML Connector Endpoint Output + type: object + description: Representation for an ML connector endpoint. + properties: + authHeader: + description: The authentication header + type: string + authentication: + description: Connector endpoint authentication type - jwt or authkey based + type: string + enum: + - ApiKey + - AwsAccessKey + - GoogleSac + - Jwt + - Oauth + connectorType: + description: The connector type + type: string + enum: + - Anthropic + - AzureOpenAI + - Bedrock + - Databricks + - Generic + - InternalEmbedding + - OpenAI + - OpenConnector + - SageMaker + - Salesforce + - VertexAI + endpointUrl: + description: URL of the connect endpoint + type: string + foundationalModelName: + description: Foundational model name + type: string + label: + description: label + type: string + name: + description: name + type: string + namedCredential: + $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + privateKeyId: + description: The private key ID + type: string + region: + description: The region for aws auth + type: string + registeredModelApiName: + description: Registered Model API name on the Provider + type: string + requestFormat: + description: Connector endpoint request format + type: string + enum: + - Csv + - DataFrameRecords + - DataFrameSplit + - Json + - JsonDense + - NumpyInput + - NumpyInstance + responseFormat: + description: Connector endpoint response format + type: string + enum: + - Csv + - DataFrameRecords + - DataFrameSplit + - Json + - JsonDense + - NumpyInput + - NumpyInstance + serviceAccountEmail: + description: The service account email + type: string + MlClusteringJobDefInputRepresentation: + title: Ml Clustering Job Def Input + description: Represents the input for creating a clustering prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveInputRepresentation" + - type: object + properties: + clusteringSettings: + description: | + Clustering settings. + + **Available Version:** 68.0 + allOf: + - $ref: "#/components/schemas/MlClusteringJobDefSettingsInputRepresentation" + MlClusteringJobDefRepresentation: + title: Ml Clustering Job Def Output + description: Represents a clustering prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveRepresentation" + - type: object + properties: + clusteringSettings: + description: | + Settings configuration for the clustering prediction job definition. + + **Filter Group:** Small + + **Available Version:** 68.0 + allOf: + - $ref: "#/components/schemas/MlClusteringJobDefSettingsRepresentation" + MlClusteringJobDefSettingsInputRepresentation: + title: Ml Clustering Job Def Settings Input + type: object + description: Represents the settings configuration for a clustering prediction job definition. + properties: + clusterIdFieldLabel: + description: | + Label for the cluster ID output field. + + **Available Version:** 68.0 + type: string + clusterLabelFieldLabel: + description: | + Label for the cluster label output field. + + **Available Version:** 68.0 + type: string + maxTopContributors: + description: | + Maximum number of top contributors for clustering. + + **Available Version:** 68.0 + type: integer + MlClusteringJobDefSettingsRepresentation: + title: Ml Clustering Job Def Settings Output + type: object + description: Represents the settings configuration for a clustering prediction job definition. + properties: + clusterIdFieldLabel: + description: | + Label for the cluster ID output field. + + **Filter Group:** Small + + **Available Version:** 68.0 + type: string + clusterLabelFieldLabel: + description: | + Label for the cluster label output field. + + **Filter Group:** Small + + **Available Version:** 68.0 + type: string + maxTopContributors: + description: | + Maximum number of top contributors to include per prediction. + + **Filter Group:** Small + + **Available Version:** 68.0 + type: integer + MlDataAlertCollectionRepresentation: + title: ML Data Alert Collection Output + description: Represents a collection of data alerts for an ML model. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + alerts: + description: | + A list of data alerts. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlDataAlertRepresentation" + source: + description: | + Source the data alerts originate from. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + MlDataAlertDataBaseRepresentation: + title: ML Data Alert Data Base Output + description: Represents the base class for metadata and shared fields used across Data Alert objects of the ML model. + type: object + MlDataAlertInputRepresentation: + title: ML Data Alert Input + description: Represents the input for creating or updating a data alert. + type: object + properties: + accepted: + description: | + 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 + type: boolean + dismissed: + description: | + 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 + type: boolean + id: + description: | + ID of the alert. + + **Available Version:** 61.0 + type: string + MlDataAlertQueryInputRepresentation: + title: ML Data Alert Query Input + type: object + description: Represents the input for a data alert query. + properties: + asset: + description: | + Asset name or ID of the alert. + + **Available Version:** 61.0 + type: string + assetType: + description: | + Asset type of the alert. + + **Available Version:** 61.0 + type: string + enum: + - ModelArtifact + sourceTypes: + description: | + Deployed or stored artifact of an ML model. + + **Available Version:** 61.0 + type: array + items: + type: string + enum: + - ModelTraining + - Runtime + MlDataAlertRepresentation: + title: ML Data Alert Output + description: Represents a single data alert. + type: object + properties: + accepted: + description: | + Indicates whether the alert is accepted (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + alertType: + description: | + Type of alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Auc + - CollinearFields + - CorrelateWithProtectedFields + - CrossValidationFailed + - DataLeakage + - DisparateImpact + - ExtremeValues + - FalsePredictionRate + - HighCardinality + - MissingCategoricalValues + - MissingNumericalValues + - ObviousPredictor + - RecommendedBuckets + - Rsquared + - SingleValue + - SingleValueWithOther + applicable: + description: | + Indicates whether the alert is applicable (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + directives: + description: | + List of improvement directives (suggested actions) associated with the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlImprovementDirectiveRepresentation" + dismissed: + description: | + Indicates whether the alert is dismissed (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + id: + description: | + ID of the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + key: + description: | + Unique key for the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + lastStatusChangeBy: + description: | + User or system that last changed the status of the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpUserRepresentation" + lastStatusChangeDate: + description: | + Date when the alert's status was last changed. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + lastStatusChangeVersion: + description: | + Version number associated with the alert's most recent status change. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + message: + description: | + Alert message. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + relatedData: + description: | + Data that is related to the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlDataAlertDataBaseRepresentation" + sourceType: + description: | + Source type of alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - ModelTraining + - Runtime + subject: + description: | + Subject of the alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + url: + description: | + URL of the data alert. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlDmoFieldSourceTargetRelationshipInputRepresentation: + title: Ml Dmo Field Source Target Relationship Input + type: object + description: 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. + properties: + relationSourceDmoFieldName: + description: | + Developer name of the source DMO field. + + **Available Version:** 67.0 + type: string + relationSourceDmoName: + description: | + Developer name of the source DMO. + + **Available Version:** 67.0 + type: string + relationTargetDmoFieldName: + description: | + Developer name of the target DMO field. + + **Available Version:** 67.0 + type: string + relationTargetDmoName: + description: | + Developer name of the target DMO. + + **Available Version:** 67.0 + type: string + required: + - relationSourceDmoFieldName + - relationSourceDmoName + - relationTargetDmoFieldName + - relationTargetDmoName + MlDmoFieldSourceTargetRelationshipRepresentation: + title: Ml Dmo Field Source Target Relationship Output + description: Represents a relationship between two data model objects (DMOs). + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + parentRelationshipId: + description: | + ID of the parent relationship. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + relationSourceDmo: + description: | + Source DMO reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + relationSourceDmoField: + description: | + Source DMO field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + relationTargetDmo: + description: | + Target DMO reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + relationTargetDmoField: + description: | + Target DMO field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + MlFieldPlaceholderRepresentation: + title: Ml Field Placeholder Output + type: object + description: Represents a field placeholder for providing dynamic values at runtime. + properties: + field: + description: | + Field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + fieldDataType: + description: | + Data type of the field. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - ArrayOfText + - Boolean + - Currency + - Date + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + placeholderName: + description: | + Name of the placeholder in the format "{!$parameter}". + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlFilterFieldAssetInputRepresentation: + title: Ml Filter Field Asset Input + description: Represents the input for a filter field asset. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + MlImprovementDirectiveRepresentation: + title: ML Improvement Directive Output + description: Represents recommended actions and insights for improving an ML model. + type: object + properties: + directiveKey: + description: | + Directive key for the ML model. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + previewText: + description: | + Preview text for the ML model. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlModelInputTypeRepresentation: + title: ML Model Input Type Output + description: Represents the input type for a machine learning model. + discriminator: + propertyName: type + type: object + properties: + description: + description: | + Description of the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + isDefault: + description: | + Indicates whether the input type is the default (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + label: + description: | + Label of the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + maxDocuments: + description: | + Maximum document limit for the input type. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: integer + maxFileSizeMB: + description: | + Maximum file size limit in MB for the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + maxImages: + description: | + Maximum images for the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + maxInputToken: + description: | + Maximum input token for the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + maxPages: + description: | + Maximum pages for the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + name: + description: | + Name of the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - ApplicationPdf + - Float + - ImageJpeg + - ImagePng + - Json + - Text + value: + description: | + Value of the input type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + MlModelOutputTypeRepresentation: + title: ML Model Output Type Output + description: Represents the output type for a machine learning model. + discriminator: + propertyName: type + type: object + properties: + description: + description: | + Description of the output type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + isDefault: + description: | + Indicates whether the output type is the default (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + label: + description: | + Label of the output type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + name: + description: | + Name of the output type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - ApplicationPdf + - Float + - ImageJpeg + - ImagePng + - Json + - Text + value: + description: | + Value of the output type. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + MlMulticlassClassificationJobDefInputRepresentation: + title: Ml Multiclass Classification Job Def Input + description: Represents the input for creating a multiclass classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveInputRepresentation" + - type: object + properties: + multiclassClassificationSettings: + description: | + Multiclass classification settings. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlMulticlassClassificationJobDefSettingsInputRepresentation" + MlMulticlassClassificationJobDefRepresentation: + title: Ml Multiclass Classification Job Def Output + description: Represents a multiclass classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveRepresentation" + - type: object + properties: + multiclassClassificationSettings: + description: | + Settings configuration for the multiclass classification prediction job definition. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlMulticlassClassificationJobDefSettingsRepresentation" + MlMulticlassClassificationJobDefSettingsInputRepresentation: + title: Ml Multiclass Classification Job Def Settings Input + type: object + description: Represents the settings configuration for a multiclass classification prediction job definition. + properties: + maxTopContributors: + description: | + Maximum number of top contributors to generate. + + **Available Version:** 66.0 + type: integer + numberOfClasses: + description: | + Number of classes to include in the output. If unspecified, the default value is all classes in the outcome. + + **Available Version:** 66.0 + type: integer + MlMulticlassClassificationJobDefSettingsRepresentation: + title: Ml Multiclass Classification Job Def Settings Output + type: object + description: Represents the settings configuration for a multiclass classification prediction job definition. + properties: + maxTopContributors: + description: | + Maximum number of top contributors to include per prediction. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + numberOfClasses: + description: | + Number of classes to include in the output. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + MlPredictionJobDefBaseInputRepresentation: + title: Ml Prediction Job Def Base Input + description: Represents the input configuration for a prediction job definition. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/MlBinaryClassificationJobDefInputRepresentation" + - $ref: "#/components/schemas/MlClusteringJobDefInputRepresentation" + - $ref: "#/components/schemas/MlMulticlassClassificationJobDefInputRepresentation" + - $ref: "#/components/schemas/MlRegressionJobDefInputRepresentation" + - $ref: "#/components/schemas/MlSentimentDetectionJobDefInputRepresentation" + - $ref: "#/components/schemas/MlTopicClassificationJobDefInputRepresentation" + properties: + activationStatus: + description: | + Activation status of the prediction job. + + **Available Version:** 59.0 + type: string + enum: + - Active + - Inactive + apiName: + description: | + API name of the prediction job. + + **Available Version:** 59.0 + type: string + description: + description: | + Description of the prediction job. + + **Available Version:** 59.0 + type: string + label: + description: | + Label of the prediction job. + + **Available Version:** 59.0 + type: string + model: + description: | + Model associated with the prediction job. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + outputConfig: + description: | + Output data model object (DMO) details. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictionsConfigInputRepresentation" + scoringMode: + description: | + Scoring mode for the prediction job. + + **Available Version:** 59.0 + type: string + enum: + - Batch + - Streaming + type: + description: | + 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 + type: string + enum: + - BinaryClassification + - Clustering + - MulticlassClassification + - Regression + - SentimentDetection + - TopicClassification + MlPredictionJobDefBaseRepresentation: + title: Ml Prediction Job Def Base Output + description: Represents the base output for a prediction job definition. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/MlBinaryClassificationJobDefRepresentation" + - $ref: "#/components/schemas/MlClusteringJobDefRepresentation" + - $ref: "#/components/schemas/MlMulticlassClassificationJobDefRepresentation" + - $ref: "#/components/schemas/MlRegressionJobDefRepresentation" + - $ref: "#/components/schemas/MlSentimentDetectionJobDefRepresentation" + - $ref: "#/components/schemas/MlTopicClassificationJobDefRepresentation" + properties: + activationStatus: + description: | + Activation status of the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Active + - Inactive + dataSpace: + description: | + Data space details for the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + description: + description: | + Description of the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + lastRunDate: + description: | + Last execution date for the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + lastRunStatus: + description: | + Status of the last execution. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Aborted + - Failed + - InProgress + - NotStarted + - Pending + - Submited + - Success + model: + description: | + Model associated with the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + outputConfig: + description: | + Output data model object (DMO) details. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictionsConfigRepresentation" + scoringMode: + description: | + Scoring mode for the prediction job. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + enum: + - Batch + - Streaming + type: + description: | + 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 + type: string + enum: + - BinaryClassification + - Clustering + - MulticlassClassification + - Regression + - SentimentDetection + - TopicClassification + MlPredictionJobDefCollectionRepresentation: + title: Ml Prediction Job Def Collection Output + type: object + description: Represents a collection of prediction job definitions. + properties: + predictionJobDefinitions: + description: | + List of prediction jobs. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefBaseRepresentation" + totalSize: + description: | + Total size of the prediction jobs returned. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: integer + url: + description: | + URL of the page. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + MlRetrieverSourceInputRepresentation: + title: Ml Retriever Source Input + description: Represents the input for a search index reference. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + type: + description: | + Type of search index source. + + **Available Version:** 61.0 + type: string + enum: + - SearchIndex + - SearchIndexConfiguration + MlRetrieverUpdateInputRepresentation: + title: Ml Retriever Update Input + type: object + description: Represents the input for updating a retriever. All fields are optional. + properties: + description: + description: | + Description of the retriever. + + **Available Version:** 67.0 + type: string + label: + description: | + Label of the retriever. + + **Available Version:** 67.0 + type: string + MlPredictionJobDefDataFieldInputRepresentation: + title: Ml Prediction Job Def Data Field Input + description: Represents a data model object (DMO) field with an optional relationship path. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + dataObject: + description: | + Data model object (DMO) that contains the field. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + MlPredictionJobDefDataFieldRepresentation: + title: Ml Prediction Job Def Data Field Output + description: Represents a prediction job data field. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataObject: + description: | + Detals about the data model object (DMO) for the field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + MlPredictionJobDefFeaturesConfigInputRepresentation: + title: Ml Prediction Job Def Features Config Input + type: object + description: Represents the input configuration for features, including the data model object (DMO) and field mappings. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + fields: + description: | + List of field mappings between model features and DMO fields. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefFeatureMappingInputRepresentation" + MlPredictionJobDefFeaturesConfigRepresentation: + title: Ml Prediction Job Def Features Config Output + type: object + description: Represents the features configuration for a prediction job definition. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + fields: + description: | + List of mappings between model features and data model object (DMO) fields. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefFeatureMappingRepresentation" + MlPredictionJobDefFeatureMappingInputRepresentation: + title: Ml Prediction Job Def Feature Mapping Input + type: object + description: Represents the mapping between a model feature and a data model object (DMO) field. + properties: + mappedField: + description: | + Mapped data model object (DMO) field. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldInputRepresentation" + modelField: + description: | + Model feature field. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + updateScore: + description: | + Indicates whether an update to this field triggers a prediction update for streaming jobs (`true`) or not (`false`). + + **Available Version:** 59.0 + type: boolean + MlPredictionJobDefFeatureMappingRepresentation: + title: Ml Prediction Job Def Feature Mapping Output + type: object + description: Represents the mapping between a model feature and a data model object (DMO) field. + properties: + mappedField: + description: | + Mapped data model object (DMO) field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldRepresentation" + modelField: + description: | + Model feature field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + updateScore: + description: | + 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 + type: boolean + MlPredictionJobDefFieldRelationshipInputRepresentation: + title: Ml Prediction Job Def Field Relationship Input + type: object + description: Represents a join relationship between two data model object (DMO) fields. + properties: + sourceField: + description: | + Source field on the left side of the join. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefDataFieldInputRepresentation" + targetField: + description: | + Target field on the right side of the join. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefDataFieldInputRepresentation" + MlPredictionJobDefFieldRelationshipRepresentation: + title: Ml Prediction Job Def Field Relationship Output + type: object + description: Represents a prediction job field relationship. + properties: + sourceField: + description: | + Name of the data model object (DMO) source field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefDataFieldRepresentation" + targetField: + description: | + Name of the DMO target field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefDataFieldRepresentation" + MlPredictionJobDefInputFieldInputRepresentation: + title: Ml Prediction Job Def Input Field Input + type: object + description: Represents an input field for a prediction job definition. + properties: + mappedField: + description: | + Mapped data model object (DMO) field. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldInputRepresentation" + updateScore: + description: | + Indicates whether a prediction is rescored when this field updates (`true`) or not (`false`). + + **Available Version:** 66.0 + type: boolean + MlPredictionJobDefInputFieldRepresentation: + title: Ml Prediction Job Def Input Field Output + type: object + description: Represents an input field configuration for a prediction job definition. + properties: + mappedField: + description: | + Mapped data model object (DMO) field. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldRepresentation" + updateScore: + description: | + 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 + type: boolean + MlPredictionJobDefMappedFieldInputRepresentation: + title: Ml Prediction Job Def Mapped Field Input + description: Represents a data model object (DMO) field with an optional relationship path. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + dataObject: + description: | + Data model object (DMO) that contains the field. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + relationshipPath: + description: | + List of join relationships for accessing the field from a related DMO. + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefFieldRelationshipInputRepresentation" + MlPredictionJobDefMappedFieldRepresentation: + title: Ml Prediction Job Def Mapped Field Output + description: Represents a prediction job mapped data field. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + dataObject: + description: | + Data model object (DMO) details for the given field. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + relationshipPath: + description: | + Relationship path for cases where the field comes from a related DMO. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefFieldRelationshipRepresentation" + MlPredictionJobDefPredictionsConfigInputRepresentation: + title: Ml Prediction Job Def Predictions Config Input + type: object + description: Represents the input configuration for predictions generated by a model. + properties: + description: + description: | + Description of the output data model object (DMO). + + **Available Version:** 59.0 + type: string + objectLabel: + description: | + Object label of the output DMO. + + **Available Version:** 59.0 + type: string + objectName: + description: | + API name of the output DMO. + + **Available Version:** 59.0 + type: string + MlPredictionJobDefPredictionsConfigRepresentation: + title: Ml Prediction Job Def Predictions Config Output + type: object + description: Represents the configuration for prediction jobs. + properties: + dataObject: + description: | + Details about the output data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + fields: + description: | + List of model prediction fields and output DMO mappings. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefPredictionMappingRepresentation" + MlPredictionJobDefPredictionMappingRepresentation: + title: Ml Prediction Job Def Prediction Mapping Output + type: object + description: Represents the output for prediction job mappings. + properties: + mappedField: + description: | + Mapped field details from the output data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldRepresentation" + modelField: + description: | + Model feature details from a model output feature, if any. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + sourceField: + description: | + Source field details from an input DMO, if any. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefMappedFieldRepresentation" + MlPredictionJobDefPredictiveInputRepresentation: + title: Ml Prediction Job Def Predictive Input + description: Represents the input configuration for a prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseInputRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for the prediction job definition. + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefFeaturesConfigInputRepresentation" + MlPredictionJobDefPredictiveRepresentation: + title: Ml Prediction Job Def Predictive Output + description: Represents the base configuration for predictive prediction job definitions. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for features and field mappings. + + **Filter Group:** Small + + **Available Version:** 59.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefFeaturesConfigRepresentation" + MlPredictionJobDefSettingsRepresentation: + title: Ml Prediction Job Def Settings Output + type: object + description: Represents the general settings configuration for a prediction job definition. + properties: + maxPrescriptions: + description: | + Maximum number of prescriptions to include per prediction. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: integer + maxTopContributors: + description: | + Maximum number of top contributors to include per prediction. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: integer + prescriptionThreshold: + description: | + Improvement threshold for prescriptions. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: integer + MlRegressionJobDefInputRepresentation: + title: Ml Regression Job Def Input + description: Represents the input for creating a regression prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveInputRepresentation" + - type: object + properties: + regressionSettings: + description: | + Regression settings. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlRegressionJobDefSettingsInputRepresentation" + MlRegressionJobDefRepresentation: + title: Ml Regression Job Def Output + description: Represents a regression prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefPredictiveRepresentation" + - type: object + properties: + predictionSettings: + description: | + General prediction settings configuration. + + **Filter Group:** Small + + **Available Version:** 65.0 + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefSettingsRepresentation" + regressionSettings: + description: | + Regression-specific settings configuration. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlRegressionJobDefSettingsRepresentation" + MlRegressionJobDefSettingsInputRepresentation: + title: Ml Regression Job Def Settings Input + type: object + description: Represents the settings configuration for a regression prediction job definition. + properties: + maxPrescriptions: + description: | + Maximum number of prescriptions to generate. + + **Available Version:** 66.0 + type: integer + maxTopContributors: + description: | + Maximum number of top contributors to generate. + + **Available Version:** 66.0 + type: integer + prescriptionThreshold: + description: | + Improvement threshold for prescriptions. + + **Available Version:** 66.0 + type: integer + MlRegressionJobDefSettingsRepresentation: + title: Ml Regression Job Def Settings Output + type: object + description: Represents the settings configuration for a regression prediction job definition. + properties: + maxPrescriptions: + description: | + Maximum number of prescriptions to include per prediction. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + maxTopContributors: + description: | + Maximum number of top contributors to include per prediction. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + prescriptionThreshold: + description: | + Improvement threshold for prescriptions. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: integer + MlRetrieverCitationConfigurationInputRepresentation: + title: Ml Retriever Citation Configuration Input + type: object + description: Represents the input for configuring citation fields. + properties: + baseUrl: + description: | + Base URL that the `mappedUrlField` value is appended to. For example, if `baseUrl` is "https://example.com" and the data model object (DMO) field contains "/docs/article-123", the resulting URL is "https://example.com/docs/article-123". + + **Available Version:** 61.0 + type: string + mappedLabelField: + description: | + Name of the mapped DMO field containing the citation label. + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationFieldInputRepresentation" + mappedUrlField: + description: | + 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 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationFieldInputRepresentation" + type: + description: | + Type of citation. + + **Available Version:** 61.0 + type: string + enum: + - Custom + - Default + required: + - type + MlRetrieverCitationConfigurationRepresentation: + title: Ml Retriever Citation Configuration Output + type: object + description: Represents citation configuration. + properties: + baseUrl: + description: | + Base URL that the `mappedUrlField` value is appended to. For example, if `baseUrl` is "https://example.com" and the data model object (DMO) field contains "/docs/article-123", the resulting URL is "https://example.com/docs/article-123". + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + mappedLabelField: + description: | + Mapped label field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationFieldRepresentation" + mappedUrlField: + description: | + Mapped URL field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationFieldRepresentation" + type: + description: | + Type of citation. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Custom + - Default + MlRetrieverCitationFieldInputRepresentation: + title: Ml Retriever Citation Field Input + description: Represents the input for a citation field reference. + allOf: + - $ref: "#/components/schemas/MlRetrieverFieldBaseInputRepresentation" + - type: object + MlRetrieverCitationFieldRepresentation: + title: Ml Retriever Citation Field Output + description: Represents a citation field reference. + allOf: + - $ref: "#/components/schemas/MlRetrieverFieldBaseRepresentation" + - type: object + MlRetrieverCollectionRepresentation: + title: Ml Retriever Collection Output + description: Represents a paginated list of retrievers. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + retrievers: + description: | + List of retrievers. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverRepresentation" + MlRetrieverConfigurationBaseInputRepresentation: + title: Ml Retriever Configuration Base Input + type: object + description: Represents the input for creating a retriever configuration. + allOf: + - type: object + - oneOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationCustomSqlInputRepresentation" + - $ref: "#/components/schemas/MlRetrieverConfigurationEnsembleInputRepresentation" + - $ref: "#/components/schemas/MlRetrieverConfigurationNoCodeInputRepresentation" + properties: + isActive: + description: | + Indicates whether to activate the configuration on creation (`true`) or not (`false`). + + **Available Version:** 61.0 + type: boolean + isCitationEnabled: + description: | + 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 + type: boolean + numberOfResults: + description: | + Maximum number of results to return. Must be a positive integer. If unspecified, the default value is `10`. + + **Available Version:** 61.0 + type: integer + queryType: + description: | + Type of query. + + **Available Version:** 61.0 + type: string + enum: + - CustomSql + - Ensemble + - NoCode + retrievalMode: + description: | + Retrieval mode. + + **Available Version:** 61.0 + type: string + enum: + - Advanced + - Basic + required: + - queryType + MlRetrieverConfigurationBaseRepresentation: + title: Ml Retriever Configuration Base Output + description: Represents a retriever configuration. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + input: + description: | + Search index reference. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + isActive: + description: | + 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 + type: boolean + isCitationEnabled: + description: | + Indicates whether citation is enabled (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + numberOfResults: + description: | + Maximum number of results to return. Must be a positive integer. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + retrievalMode: + description: | + Retrieval mode. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Advanced + - Basic + searchIndexConfiguration: + description: | + Search index configuration reference. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + semanticSearchType: + description: | + Type of semantic search. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Enriched + - Hybrid + - Vector + sourceDmo: + description: | + Source data model object (DMO) to query. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + vectorDmo: + description: | + Vector data model object (DMO) containing embeddings for semantic search. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + version: + description: | + Version number of the configuration. Must be non-negative. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: integer + MlRetrieverConfigurationCollectionRepresentation: + title: Ml Retriever Configuration Collection Output + description: Represents a paginated list of configurations. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + configurations: + description: | + List of configurations. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverConfigurationRepresentation" + MlRetrieverConfigurationCustomSqlInputRepresentation: + title: Ml Retriever Configuration Custom Sql Input + description: 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. + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseInputRepresentation" + - type: object + properties: + isAdvancedModeSupported: + description: | + Indicates whether advanced retrieval mode is supported (`true`) or not (`false`). If unspecified, the default value is `false`. + + **Available Version:** 67.0 + type: boolean + isCitationSupported: + description: | + 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 + type: boolean + isEnrichedIndexSupported: + description: | + 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 + type: boolean + retrieverQueryTemplateDefinition: + description: | + SQL query template definition including query template, parameters, citation definition, and enriched index definition. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateDefinitionInputRepresentation" + required: + - retrieverQueryTemplateDefinition + MlRetrieverConfigurationDetailRepresentation: + title: Ml Retriever Configuration Detail Output + description: Represents a configuration with full details. + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseRepresentation" + - type: object + properties: + citationConfiguration: + description: | + Citation configuration. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationConfigurationRepresentation" + fieldPlaceholders: + description: | + List of field placeholders with parameter values specified at runtime. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlFieldPlaceholderRepresentation" + isAdvancedModeSupported: + description: | + Indicates whether advanced mode is supported (`true`) or not (`false`). Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isCitationSupported: + description: | + Indicates whether citation output is supported (`true`) or not (`false`). Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isEnrichedIndexSupported: + description: | + Indicates whether enriched search index chunk resolution is supported (`true`) or not (`false`). Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + outputFields: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/MlRetrieverOutputFieldRepresentation" + queryFilter: + description: | + Query filter. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpMlFilterRepresentation" + referencedRetrievers: + description: | + List of sub-retrievers. Applies only to `Ensemble`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverRepresentation" + retrieverQueryTemplateDefinition: + description: | + Query template definition. Applies only to `CustomSql` and `Ensemble`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateDefinitionRepresentation" + MlRetrieverConfigurationEnsembleInputRepresentation: + title: Ml Retriever Configuration Ensemble Input + description: Represents the input for an Ensemble retriever configuration that fans out to multiple sub-retrievers and combines the results after reranking. + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseInputRepresentation" + - type: object + properties: + outputFields: + description: | + 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 + type: array + items: + type: string + referencedRetrievers: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + required: + - referencedRetrievers + MlRetrieverConfigurationNoCodeInputRepresentation: + title: Ml Retriever Configuration No Code Input + description: Represents the input for a NoCode retriever configuration that retrieves data from a search index. The SQL query template is internally generated. + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseInputRepresentation" + - type: object + properties: + citationConfiguration: + description: | + Citation configuration. Applies only to `NoCode`. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverCitationConfigurationInputRepresentation" + input: + description: | + ID or API name of the search index that the retriever is associated with. Applies only to `NoCode`. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverSourceInputRepresentation" + outputFields: + description: | + List of data model object (DMO) fields to include in retriever results. + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverOutputFieldInputRepresentation" + queryFilter: + description: | + Pre-filter applied to available prefilter fields on the search index. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/CdpMlFilterInputRepresentation" + required: + - input + - outputFields + MlRetrieverConfigurationRepresentation: + title: Ml Retriever Configuration Output + description: Represents a configuration. + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseRepresentation" + - type: object + MlRetrieverConfigurationUpdateInputRepresentation: + title: Ml Retriever Configuration Update Input + type: object + description: Represents the input for updating a configuration. + properties: + isActive: + description: | + Indicates whether to activate the configuration (`true`) or not (`false`). At most one configuration can be active per retriever. + + **Available Version:** 61.0 + type: boolean + required: + - isActive + MlRetrieverFieldBaseInputRepresentation: + title: Ml Retriever Field Base Input + type: object + description: Represents the input for a field reference. + properties: + relatedDmoFieldName: + description: | + Name of the related data model object (DMO) field. + + **Available Version:** 61.0 + type: string + relatedDmoName: + description: | + Name of the related DMO. + + **Available Version:** 61.0 + type: string + MlRetrieverFieldBaseRepresentation: + title: Ml Retriever Field Base Output + description: Represents a field reference. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + relatedDmo: + description: | + Related data model object (DMO) reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + relatedDmoField: + description: | + Related DMO field reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + MlRetrieverInputRepresentation: + title: Ml Retriever Input + type: object + description: Represents the input for creating a retriever. + properties: + configuration: + description: | + 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 + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseInputRepresentation" + dataSpaces: + description: | + 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 + type: array + items: + type: string + description: + description: | + Description of the retriever. + + **Available Version:** 61.0 + type: string + label: + description: | + Label of the retriever. + + **Available Version:** 61.0 + type: string + ownerType: + description: | + Type of owner. + + **Available Version:** 61.0 + type: string + enum: + - AiAgent + - Api + required: + - configuration + - label + - ownerType + MlRetrieverOutputFieldInputRepresentation: + title: Ml Retriever Output Field Input + description: 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. + allOf: + - $ref: "#/components/schemas/MlRetrieverFieldBaseInputRepresentation" + - type: object + properties: + dataSourceType: + description: | + Type of data source. + + **Available Version:** 67.0 + type: string + enum: + - DataModelObject + - SearchFunction + label: + description: | + Display label for the output field. Must be unique within the retriever. + + **Available Version:** 67.0 + type: string + relationships: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/MlDmoFieldSourceTargetRelationshipInputRepresentation" + required: + - label + MlRetrieverOutputFieldRepresentation: + title: Ml Retriever Output Field + description: Represents an output field. + allOf: + - $ref: "#/components/schemas/MlRetrieverFieldBaseRepresentation" + - type: object + properties: + relationshipPathId: + description: | + Record ID of the head relationship. Applies only to `NoCode`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + relationships: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/MlDmoFieldSourceTargetRelationshipRepresentation" + MlRetrieverQueryEnrichedSearchIndexDefinitionInputRepresentation: + title: Ml Retriever Query Enriched Search Index Definition Input + type: object + description: Represents the input for an enriched search index definition to resolve enriched chunks to plain chunks. Required when `isEnrichedIndexSupported` is `true`. CustomSql only. + properties: + chunkColumnName: + description: | + Name or alias of the SELECT column containing the chunk content. + + **Available Version:** 67.0 + type: string + chunkRecordIdColumnName: + description: | + Name or alias of the SELECT column containing the chunk record ID. + + **Available Version:** 67.0 + type: string + searchIndexApiName: + description: | + API name of the enriched search index. + + **Available Version:** 67.0 + type: string + required: + - chunkColumnName + - chunkRecordIdColumnName + - searchIndexApiName + MlRetrieverQueryEnrichedSearchIndexDefinitionRepresentation: + title: Ml Retriever Query Enriched Search Index Definition Output + type: object + description: Represents an enriched search index definition. + properties: + chunkColumnName: + description: | + Name or alias of the SELECT column containing chunk content. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + chunkRecordIdColumnName: + description: | + Name or alias of the SELECT column containing the chunk record ID. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + searchIndexApiName: + description: | + API name of the enriched search index. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation: + title: Ml Retriever Query Template Citation Definition Base Input + type: object + description: Represents the input for a query template citation definition. Discriminated by `citationType` (Default or Custom). Required when `isCitationSupported` is `true`. CustomSql only. + properties: + citationType: + description: | + Type of citation. + + **Available Version:** 67.0 + type: string + enum: + - Custom + - Default + customLabelColumnName: + description: | + Name or alias of the SELECT column used as the citation label. Required when `citationType` is `Custom`. + + **Available Version:** 67.0 + type: string + required: + - citationType + MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation: + title: Ml Retriever Query Template Citation Definition Base Output + type: object + description: Represents a citation definition. + discriminator: + propertyName: citationType + properties: + citationType: + description: | + Type of citation. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Custom + - Default + customLabelColumnName: + description: | + Name or alias of the SELECT column used as citation label. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlRetrieverQueryTemplateCitationDefinitionCustomInputRepresentation: + title: Ml Retriever Query Template Citation Definition Custom Input + description: Represents the input for a custom citation definition where label and link are defined by user-specified SQL columns. CustomSql only. + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation" + - type: object + properties: + customBaseUrl: + description: | + Base URL that the `customLinkColumnName` value is appended to. For example, if `customBaseUrl` is "https://example.com" and the column contains "/docs/article-123", the resulting URL is "https://example.com/docs/article-123". + + **Available Version:** 67.0 + type: string + customLinkColumnName: + description: | + 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 + type: string + required: + - customLinkColumnName + MlRetrieverQueryTemplateCitationDefinitionCustomRepresentation: + title: Ml Retriever Query Template Citation Definition Custom Output + description: Represents a custom citation definition where label and link are defined by user-specified columns. CustomSql only. + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation" + - type: object + properties: + customBaseUrl: + description: | + Base URL that the `customLinkColumnName` value is appended to. For example, if `customBaseUrl` is "https://example.com" and the column contains "/docs/article-123", the resulting URL is "https://example.com/docs/article-123". + + **Filter Group:** Small + + **Available Version:** 67.0 + type: string + customLinkColumnName: + description: | + 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 + type: string + MlRetrieverQueryTemplateCitationDefinitionDefaultInputRepresentation: + title: Ml Retriever Query Template Citation Definition Default Input + description: Represents the input for a Default citation definition where citation links are generated from source and chunk record IDs in SQL columns. CustomSql only. + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionBaseInputRepresentation" + - type: object + properties: + chunkObjectApiName: + description: | + 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 + type: string + chunkRecordIdColumnName: + description: | + 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 + type: string + sourceObjectApiName: + description: | + 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 + type: string + sourceRecordIdColumnName: + description: | + Name or alias of the SELECT column used as the source record ID. + + **Available Version:** 67.0 + type: string + required: + - sourceObjectApiName + - sourceRecordIdColumnName + MlRetrieverQueryTemplateCitationDefinitionDefaultRepresentation: + title: Ml Retriever Query Template Citation Definition Default Output + description: Retriever query template citation definition for Default + citation type. CustomSql only. + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionBaseRepresentation" + - type: object + properties: + chunkObjectApiName: + description: | + 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 + type: string + chunkRecordIdColumnName: + description: | + 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 + type: string + sourceObjectApiName: + description: | + API name of the source DMO whose records are cited. Required when citationType is `Default`. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: string + sourceRecordIdColumnName: + description: | + 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 + type: string + MlRetrieverQueryTemplateDataCloudAssetRepresentation: + title: Ml Retriever Query Template Data Cloud Asset Output + type: object + description: Represents a Data Cloud asset referenced in the query template. + properties: + assetApiName: + description: | + API name of the asset. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + assetType: + description: | + Type of asset. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - CalculatedInsight + - DataLakeObject + - DataModelObject + - SearchIndex + MlRetrieverQueryTemplateDefinitionInputRepresentation: + title: Ml Retriever Query Template Definition Input + type: object + description: Represents the input for a SQL query template definition. CustomSql only. + properties: + enrichedSearchIndexDefinition: + description: | + Enriched search index definition to resolve enriched chunks to plain chunks. Required when `isEnrichedIndexSupported` is `true`. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryEnrichedSearchIndexDefinitionInputRepresentation" + mainUserQueryParameterName: + description: | + 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 + type: string + queryCitationDefinition: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionCustomInputRepresentation" + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionDefaultInputRepresentation" + queryTemplatePlaceholders: + description: | + 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 + type: array + items: + $ref: "#/components/schemas/MlRetrieverQueryTemplatePlaceholderInputRepresentation" + retrieverQueryTemplate: + description: | + Data 360 SQL query template. Can contain parameters in the format `:"parameter"`. + + **Available Version:** 67.0 + type: string + searchOverallScoreColumnName: + description: | + 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 + type: string + required: + - retrieverQueryTemplate + MlRetrieverQueryTemplateDefinitionRepresentation: + title: Ml Retriever Query Template Definition Output + type: object + description: Represents a query template definition. + properties: + dataCloudAssets: + description: | + List of Data 360 assets referenced in the SQL query template. Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverQueryTemplateDataCloudAssetRepresentation" + enrichedSearchIndexDefinition: + description: | + Enriched search index definition. Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryEnrichedSearchIndexDefinitionRepresentation" + mainUserQueryParameterName: + description: | + Name of the parameter containing the user query text in the format `":\"parameter\""`. Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + queryCitationDefinition: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionCustomRepresentation" + - $ref: "#/components/schemas/MlRetrieverQueryTemplateCitationDefinitionDefaultRepresentation" + queryTemplate: + description: | + SQL query template. Can contain parameters in the format ":parameter". + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + queryTemplateMetadata: + description: | + Query template metadata. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverQueryTemplateMetadataRepresentation" + queryTemplatePlaceholders: + description: | + List of parameters used in the SQL query template. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverQueryTemplatePlaceholderRepresentation" + queryTemplateVersionNumber: + description: | + Version number of the query template. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - V3PARAM + searchOverallScoreColumnName: + description: | + Name of the column containing the overall search relevance score. Applies only to `CustomSql`. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlRetrieverQueryTemplateMetadataRepresentation: + title: Ml Retriever Query Template Metadata Output + type: object + description: Represents query template metadata. + properties: + selectColumns: + description: | + List of SELECT columns in the SQL query. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverQueryTemplateMetadataSelectColumnRepresentation" + MlRetrieverQueryTemplateMetadataSelectColumnRepresentation: + title: Ml Retriever Query Template Metadata Select Column Output + type: object + description: Represents a SELECT column in the query template. + properties: + fieldAlias: + description: | + Alias of the SELECT column. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + fieldName: + description: | + Name of the column. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + tableAlias: + description: | + Alias of the table. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + tableName: + description: | + Name of the table. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlRetrieverQueryTemplatePlaceholderInputRepresentation: + title: Ml Retriever Query Template Placeholder Input + type: object + description: Represents the input for a query template parameter or placeholder in the format `":\"parameter\""`. CustomSql only. + properties: + placeholderDataType: + description: | + Data type of the parameter value. + + **Available Version:** 67.0 + type: string + enum: + - ArrayOfText + - Boolean + - Date + - DateTime + - Number + - Text + placeholderDescription: + description: | + Description of the parameter purpose. Required for `CustomSql`. Not applicable to `NoCode`. + + **Available Version:** 67.0 + type: string + placeholderLabel: + description: | + Display label for the parameter. + + **Available Version:** 67.0 + type: string + placeholderName: + description: | + 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 + type: string + placeholderValue: + description: | + Default value for the parameter. + + **Available Version:** 67.0 + type: string + required: + - placeholderDataType + - placeholderName + MlRetrieverQueryTemplatePlaceholderRepresentation: + title: Ml Retriever Query Template Placeholder Output + type: object + description: Represents a parameter in the SQL query template. + properties: + placeholderDataType: + description: | + Data type of the parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - ArrayOfText + - Boolean + - Date + - DateTime + - Number + - Text + placeholderDescription: + description: | + Description of the parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + placeholderLabel: + description: | + Label of the parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + placeholderName: + description: | + 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 + type: string + placeholderType: + description: | + Type of parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - NamedParameter + - Placeholder + placeholderValue: + description: | + Default value of the parameter. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlRetrieverRepresentation: + title: Ml Retriever Output + description: Represents a retriever with its latest and active configurations. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + activeConfiguration: + description: | + Currently active configuration. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseRepresentation" + configurationsUrl: + description: | + URL of the configurations sub-resource. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + connection: + description: | + Connection reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + dataSourceType: + description: | + Type of data source. Use `RealTimeSearchIndex` or `SearchIndex` for `NoCode` retrievers, and `DataCloudAsset` for `CustomSql` retrievers. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - DataCloudAsset + - RealTimeSearchIndex + - SearchIndex + dataSpaces: + description: | + List of data spaces. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + description: + description: | + Description of the retriever. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + isDefault: + description: | + Indicates whether the retriever is the default for its search index (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isGlobal: + description: | + Indicates whether the retriever is global (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + isVirtual: + description: | + Indicates whether the retriever is virtual (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 61.0 + type: boolean + latestConfiguration: + description: | + Most recent configuration version. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverConfigurationBaseRepresentation" + ownerType: + description: | + Type of owner. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Adl + - AiAgent + - Api + - Customer + - IntelligentContext + - Internal + - Ui + ownership: + description: | + Owner reference. + + **Filter Group:** Small + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + queryType: + description: | + Type of query. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - CustomSql + - Ensemble + - NoCode + retrieverLifetime: + description: | + Lifetime of the retriever. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Persistent + - Transient + MlRetrieverReviewInputRepresentation: + title: Ml Retriever Review Input + type: object + description: Represents the input for reviewing a CustomSql retriever. + properties: + existingRetrieverAsset: + description: | + Reference to an existing retriever when reviewing a new configuration. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + retrieverInput: + description: | + Retriever input to review. + + **Available Version:** 67.0 + allOf: + - $ref: "#/components/schemas/MlRetrieverInputRepresentation" + required: + - retrieverInput + MlRetrieverReviewItemRepresentation: + title: Ml Retriever Review Item Output + type: object + description: Represents a single review finding for a CustomSql retriever. + properties: + code: + description: | + Finding code. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - 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: + description: | + Path to the field in the request. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + message: + description: | + Localized message. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + messageKey: + description: | + Message key for localization. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + messageParams: + description: | + List of parameters for the message template. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: array + items: + type: string + severity: + description: | + Severity of the finding. `Error` blocks the creation and `Info` is a suggestion. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + enum: + - Error + - Info + MlRetrieverReviewRepresentation: + title: Ml Retriever Review Output + type: object + description: Represents the review result for a CustomSql retriever input. + properties: + extractedSelectColumns: + description: | + List of SELECT columns extracted from the SQL query. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverReviewSelectColumnRepresentation" + findings: + description: | + List of review findings, such as errors and suggestions. + + **Filter Group:** Small + + **Available Version:** 67.0 + type: array + items: + $ref: "#/components/schemas/MlRetrieverReviewItemRepresentation" + hasErrors: + description: | + Indicates whether the input has errors that prevent creation (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 67.0 + type: boolean + MlRetrieverReviewSelectColumnRepresentation: + title: Ml Retriever Review Select Column Output + type: object + description: Represents a SELECT column extracted from a CustomSql query. + properties: + fieldName: + description: | + Name or alias of the column. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + type: + description: | + Data type of the column. + + **Filter Group:** Small + + **Available Version:** 61.0 + type: string + MlSentimentDetectionJobDefInputRepresentation: + title: Ml Sentiment Detection Job Def Input + description: Represents the input for creating a sentiment detection prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseInputRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for sentiment detection. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlSentimentDetectionInputConfigInputRepresentation" + MlSentimentDetectionInputConfigInputRepresentation: + title: Ml Sentiment Detection Input Config Input + type: object + description: Represents the input configuration for a sentiment detection prediction job definition. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + textFields: + description: | + List of text fields to perform sentiment detection on. + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefInputFieldInputRepresentation" + MlSentimentDetectionInputConfigRepresentation: + title: Ml Sentiment Detection Input Config Output + type: object + description: Represents the input configuration for a sentiment detection prediction job definition. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + textFields: + description: | + List of text fields to perform sentiment detection on. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefInputFieldRepresentation" + MlSentimentDetectionJobDefRepresentation: + title: Ml Sentiment Detection Job Def Output + description: Represents a sentiment detection prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for sentiment detection. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlSentimentDetectionInputConfigRepresentation" + MlSetupBaseUpdateInputRepresentation: + title: ML Setup Base Update Input + description: Represents the base class for the core fields you can update in a model setup. + type: object + properties: + type: + description: | + Setup type. + + **Available Version:** 59.0 + type: string + enum: + - EdcNoCode + - ModelConnector + MlTopicClassificationInputConfigInputRepresentation: + title: Ml Topic Classification Input Config Input + type: object + description: Represents the input configuration for a topic classification prediction job definition. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + textFields: + description: | + List of text fields to perform topic classification on. + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefInputFieldInputRepresentation" + topicLabels: + description: | + Topic labels for classifying the text fields. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlTopicClassificationJobStaticLabelsInputRepresentation" + MlTopicClassificationInputConfigRepresentation: + title: Ml Topic Classification Input Config Output + type: object + description: Represents the input configuration for a topic classification prediction job definition. + properties: + dataObject: + description: | + Input data model object (DMO). + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceRepresentation" + textFields: + description: | + List of text fields to perform topic classification on. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: array + items: + $ref: "#/components/schemas/MlPredictionJobDefInputFieldRepresentation" + topicLabels: + description: | + Topic labels for classifying the text fields. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlTopicClassificationJobLabelsBaseRepresentation" + MlTopicClassificationJobDefInputRepresentation: + title: Ml Topic Classification Job Def Input + description: Represents the input for creating a topic classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseInputRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for topic classification. + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlTopicClassificationInputConfigInputRepresentation" + MlTopicClassificationJobDefRepresentation: + title: Ml Topic Classification Job Def Output + description: Represents a topic classification prediction job definition. + allOf: + - $ref: "#/components/schemas/MlPredictionJobDefBaseRepresentation" + - type: object + properties: + inputConfig: + description: | + Input configuration for topic classification. + + **Filter Group:** Small + + **Available Version:** 66.0 + allOf: + - $ref: "#/components/schemas/MlTopicClassificationInputConfigRepresentation" + MlTopicClassificationJobLabelsBaseInputRepresentation: + title: Ml Topic Classification Job Labels Base Input + type: object + description: Represents the base input for topic classification labels. + properties: + type: + description: | + Type of labels mapping. + + **Available Version:** 66.0 + type: string + enum: + - Static + MlTopicClassificationJobStaticLabelsInputRepresentation: + title: Ml Topic Classification Job Static Labels Input + description: Represents the base class for topic classification labels. + allOf: + - $ref: "#/components/schemas/MlTopicClassificationJobLabelsBaseInputRepresentation" + - type: object + properties: + values: + description: | + Static list of topic labels to be used for classification. + + **Available Version:** 66.0 + type: array + items: + type: string + MlTopicClassificationJobLabelsBaseRepresentation: + title: Ml Topic Classification Job Labels Base Output + type: object + description: Represents the base configuration for topic classification labels. + properties: + type: + description: | + Type of labels mapping. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + enum: + - Dynamic + - Static + MonthlySpecificScheduleInputRepresentation: + title: Monthly Schedule Input + description: Represents the input for creating a monthly schedule where the days are fixed by numerical date. + allOf: + - $ref: "#/components/schemas/ScheduleInputRepresentation" + - type: object + properties: + daysOfMonth: + description: | + 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 + type: array + items: + type: integer + MonthlySpecificScheduleRepresentation: + title: Monthly Schedule Output + description: Represents a segment publication schedule that runs monthly. + allOf: + - $ref: "#/components/schemas/ScheduleOutputRepresentation" + - type: object + properties: + daysOfMonth: + description: | + 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 + type: array + items: + type: integer + interval: + description: | + Hourly interval at which segments can be published, from `1` through `24`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + NameLabelInputRepresentation: + title: Name Label Input + description: Represents the input for specifying a name and label. + type: object + properties: + label: + description: | + Label. + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Available Version:** 60.0 + type: string + required: + - label + - name + NameLabelRepresentation: + title: Name Label Output + description: Name label representation. + type: object + properties: + label: + description: | + Label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + OutputD360FieldsMappingInputRepresentation: + title: Output D360 Fields Mapping Input + description: Represents D360 output node field mapping. + type: object + properties: + sourceField: + description: | + Source field name. + + **Available Version:** 60.0 + type: string + targetField: + description: | + Target field name. + + **Available Version:** 60.0 + type: string + required: + - sourceField + - targetField + OutputD360FieldsMappingRepresentation: + title: Output D360 Fields Mapping + type: object + description: Represents a D360 output node field mapping. + properties: + sourceField: + description: | + Source field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetField: + description: | + Target field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + OutputD360NodeInputRepresentation: + title: Output D360 Node Input + description: Represents D360 output node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/OutputD360ParametersInputRepresentation" + required: + - parameters + OutputD360NodeRepresentation: + title: Output D360 Node + description: Represents a D360 output node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/OutputD360ParametersRepresentation" + OutputD360ParametersInputRepresentation: + title: Output D360 Parameters Input + description: Represents D360 output node parameters. + type: object + properties: + fieldsMappings: + description: | + Field mappings. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/OutputD360FieldsMappingInputRepresentation" + name: + description: | + D360 object name. + + **Available Version:** 60.0 + type: string + type: + description: | + Output type. + + **Available Version:** 60.0 + enum: + - DataLakeObject + - DataModelObject + type: string + required: + - fieldsMappings + - name + - type + OutputD360ParametersRepresentation: + title: Output D360 Parameters + type: object + description: Represents D360 output node parameters. + properties: + dedupOrder: + description: | + Order for eliminating duplicate primary keys in output nodes. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SortSpecificationRepresentation" + fieldsMappings: + description: | + List of field mappings. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/OutputD360FieldsMappingRepresentation" + name: + description: | + Name of the D360 object. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + streaming: + description: | + List of streaming parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/StreamingParametersRepresentation" + type: + description: | + Type of output. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - DataLakeObject + - DataModelObject + writeMode: + description: | + Type of write mode. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Append + - DeleteOnly + - Merge + - MergeUpsertDelete + - Overwrite + ParameterRepresentation: + title: Parameter Output + type: object + description: Represents the output for a dynamic parameter. + properties: + isCollection: + description: | + Indicates whether the parameter is part of a collection (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + name: + description: | + Name of the parameter. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + type: + description: | + Type of the parameter. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + PerFileExtensionRepresentation: + title: Per File Extension Output + description: Represents the per-file extension details. + type: object + properties: + config: + description: | + Configuration of the file details. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConfigRepresentation" + fileExtension: + description: | + File extension, for example `html`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + PivotV2InputRepresentation: + title: Pivot V2 Input + description: Pivot v2 input representation. + type: object + properties: + pivotFieldsInfo: + description: | + Pivot fields info. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/NameLabelInputRepresentation" + - additionalProperties: + type: array + items: + type: object + type: string + type: string + sourceFields: + description: | + Source fields. + + **Available Version:** 60.0 + type: array + items: + type: string + valueCombinations: + description: | + Value combinations. + + **Available Version:** 60.0 + type: array + items: + type: array + items: + type: string + required: + - pivotFieldsInfo + - sourceFields + - valueCombinations + PivotV2Representation: + title: Pivot V2 Output + description: Pivot v2 representation. + type: object + properties: + pivotFieldsInfo: + description: | + Pivot fields info. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/NameLabelRepresentation" + sourceFields: + description: | + List of source fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + valueCombinations: + description: | + Value combinations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: array + items: + type: string + PredictionContributorInputRepresentation: + title: Prediction Contributor Input + type: object + description: Represents the input for a prediction contributor. + properties: + field: + description: | + Prediction field. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldInputRepresentation" + impact: + description: | + Prediction impact. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldInputRepresentation" + value: + description: | + Prediction value. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldInputRepresentation" + PredictionContributorRepresentation: + title: Prediction Contributor Output + type: object + description: Represents a prediction contributor. + properties: + field: + description: | + Contributor field. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldRepresentation" + impact: + description: | + Contributor impact. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldRepresentation" + value: + description: | + Contributor value. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/PredictionFieldRepresentation" + PredictionFieldInputRepresentation: + title: Prediction Field Input + type: object + description: Represents the input for a prediction field. + properties: + label: + description: | + Label of the prediction field. + + **Available Version:** 60.0 + type: string + modelOutputFieldName: + description: | + Name of the prediction model output field. + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the prediction field. + + **Available Version:** 60.0 + type: string + type: + description: | + Data type of the prediction field. + + **Available Version:** 60.0 + type: string + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + PredictionFieldRepresentation: + title: Prediction Field Output + type: object + description: Represents a prediction field. + properties: + label: + description: | + Label of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + modelOutputFieldName: + description: | + Name of the model output field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Data type of the field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + PredictSourceInputRepresentation: + title: Predict Source Input + type: object + description: Represents the input for a prediction source. + properties: + name: + description: | + Name of the prediction source. + + **Available Version:** 60.0 + type: string + type: + description: | + Type of the prediction source. + + **Available Version:** 60.0 + type: string + enum: + - ConfiguredModel + - MlModelGroup + PredictSourceRepresentation: + title: Predict Source Output + type: object + description: Represents a prediction source. + properties: + name: + description: | + Name of the source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Type of the source. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - ConfiguredModel + - MlModelGroup + PrivateNetworkRouteCollectionRepresentation: + title: Private Network Route Collection Output + description: Represents a list of Private Network Routes. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + routes: + description: | + List of Private Network Routes. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: array + items: + $ref: "#/components/schemas/PrivateNetworkRouteRepresentation" + PrivateNetworkRouteInputRepresentation: + title: Private Network Route Input + description: Input representation to create a Private Network Route. + type: object + properties: + cloudProvider: + description: | + Details about the cloud provider for the Private Network Route. + + **Available Version:** 65.0 + allOf: + - $ref: "#/components/schemas/CloudProviderDetailsInputRepresentation" + description: + description: | + Description of the Private Network Route. + + **Available Version:** 65.0 + type: string + label: + description: | + Label of the Private Network Route. + + **Available Version:** 65.0 + type: string + name: + description: | + Developer name of the Private Network Route. + + **Available Version:** 65.0 + type: string + route: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/AmazonMSKRouteDetailsInputRepresentation" + - $ref: "#/components/schemas/RedshiftRouteDetailsInputRepresentation" + - $ref: "#/components/schemas/SnowflakeRouteDetailsInputRepresentation" + required: + - description + - label + - name + - route + PrivateNetworkRouteRepresentation: + title: Private Network Route Output + description: Represents a Private Network Route. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + cloudProvider: + description: | + Details about the cloud provider for the Private Network Route. + + **Filter Group:** Small + + **Available Version:** 65.0 + allOf: + - $ref: "#/components/schemas/CloudProviderDetailsRepresentation" + route: + description: | + 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 + oneOf: + - $ref: "#/components/schemas/AmazonMSKRouteDetailsRepresentation" + - $ref: "#/components/schemas/RedshiftRouteDetailsRepresentation" + - $ref: "#/components/schemas/SnowflakeRouteDetailsRepresentation" + QueryPathConfigInputRepresentation: + title: Query Path Config Input + description: Represents the query path configuration input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + queryPaths: + description: | + List of query path configurations. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathInputRepresentationConfig" + QueryPathConfigListInputRepresentation: + title: Query Path Config List Input + description: Represents the query path configuration list input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + configs: + description: | + Query path configuration. + type: array + items: + $ref: "#/components/schemas/QueryPathConfigInputRepresentation" + QueryPathConfigListRepresentation: + title: Query Path Config List Output + description: Represents the activation query path configuration list output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + configs: + description: | + List of query path configurations. + type: array + items: + $ref: "#/components/schemas/QueryPathConfigRepresentation" + QueryPathConfigRepresentation: + title: Query Path Config Output + description: Represents the query path configuration output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + queryPath: + description: | + List of query paths. + type: array + items: + $ref: "#/components/schemas/QueryPathRepresentation" + QueryPathInputRepresentation: + title: Query Path Input + description: Represents the query path input. + allOf: + - $ref: "#/components/schemas/CdpAssetReferenceInputRepresentation" + - type: object + properties: + fieldLabel: + description: | + Field label. + + **Available Version:** 60.0 + type: string + fieldName: + description: | + Field name. + + **Available Version:** 60.0 + type: string + objectLabel: + description: | + Object label. + + **Available Version:** 60.0 + type: string + objectName: + description: | + Object name. + + **Available Version:** 60.0 + type: string + QueryPathInputRepresentationConfig: + title: Query Path Input Config + description: Represents the input for a list of query paths. + type: object + properties: + queryPath: + description: | + List of query paths. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/QueryPathInputRepresentation" + required: + - queryPath + QueryPathRepresentation: + title: Query Path Output + description: Represents a query path output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + fieldLabel: + description: | + Field label for the query path. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + fieldName: + description: | + Field name for the query path. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + objectLabel: + description: | + Object label for the query path. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + objectName: + description: | + Object name for the query path. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: object + QuerySqlBaseRepresentation: + title: Query SQL Base Output + description: Base representation for query SQL output. + type: object + properties: + returnedRows: + format: int64 + description: | + Number of rows returned by the query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + data: + description: | + Data associated with the SQL query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/QuerySqlRowRepresentation" + metadata: + description: | + Metadata associated with the SQL query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/QuerySqlMetadataItemRepresentation" + QuerySqlInputRepresentation: + title: Query SQL Input + description: Represents the input to create a query SQL request. + type: object + properties: + querySettings: + description: | + 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 + type: object + additionalProperties: + type: string + rowLimit: + format: int64 + description: | + 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 + type: integer + sql: + description: | + 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 + type: string + sqlParameters: + description: | + List of value and type information about parameters in the named parameter style. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/QuerySqlParameterItemRepresentation" + required: + - sql + QuerySqlMetadataItemRepresentation: + title: Query SQL Metadata Item Output + description: Represents metadata associated with the Query SQL request. + type: object + properties: + innerElement: + description: | + Description of array fields. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + name: + description: | + Name of the field. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + nullable: + description: | + If `true`, the field is nullable. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + precision: + description: | + Precision for numeric fields. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + scale: + description: | + Scale for numeric fields. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + type: + description: | + Type of the field. + + **Filter Group:** Small + + **Available Version:** 63.0 + enum: + - ArrayOfX + - BigInt + - Bool + - Char + - Date + - Double + - Float + - Integer + - Numeric + - Oid + - SmallInt + - Time + - Timestamp + - TimestampTZ + - Unspecified + - Varchar + type: string + QuerySqlPageRepresentation: + title: Query SQL Page Output + description: Represents SQL query output. + allOf: + - $ref: "#/components/schemas/QuerySqlBaseRepresentation" + QuerySqlParameterItemRepresentation: + title: Query SQL Parameter Item Input + type: object + description: Represents the input for SQL parameter fields. + properties: + name: + description: | + Name of the SQL parameter. + + **Available Version:** 62.0 + type: string + type: + description: | + Type of SQL parameter. + + **Available Version:** 62.0 + type: string + enum: + - ArrayOfX + - BigInt + - Bool + - Char + - Date + - Double + - Float + - Integer + - Numeric + - Oid + - SmallInt + - Time + - Timestamp + - TimestampTZ + - Unspecified + - Varchar + value: + description: | + Value of the SQL parameter. + + **Available Version:** 62.0 + type: string + QuerySqlRepresentation: + title: Query SQL Output + description: Represents the output of the Query SQL. + allOf: + - $ref: "#/components/schemas/QuerySqlBaseRepresentation" + - type: object + properties: + status: + description: | + Stores metadata related to the status of query. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/QuerySqlStatusRepresentation" + QuerySqlRowRepresentation: + title: Query SQL Row Output + description: Represents data fetched by the Query SQL request. + type: object + properties: + row: + description: | + List of column values. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: object + QuerySqlStatusRepresentation: + title: Query SQL Status Output + description: Represents status metadata for Query SQL. + type: object + properties: + completionStatus: + description: | + 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 + enum: + - Finished + - ResultsProduced + - Running + - Unspecified + type: string + expirationTime: + description: | + Time when the query expires. You can't make requests to an expired query. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + progress: + format: double + description: | + 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 + type: number + queryId: + description: | + ID of the query for which status information is returned. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + rowCount: + format: int64 + description: | + Number of rows available for extraction. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + RankingFieldsDetailsRepresentation: + title: Ranking Fields Details Output + description: Ranking fields details representation. + type: object + properties: + developerName: + description: | + Developer name of the ranking field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + entitySourceType: + description: | + Developer name of the entity source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + fieldRelationshipPathId: + description: | + Relationships path ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + id: + description: | + Record's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + rankType: + description: | + 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 + type: string + relatedDmoDeveloperName: + description: | + Related data model object (DMO) developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldDeveloperName: + description: | + Related DMO field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldId: + description: | + Related DMO field ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldName: + description: | + Related DMO field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoId: + description: | + Related DMO ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoName: + description: | + Related DMO name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relationships: + description: | + List of relationships. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FieldRelationshipsPathRepresentation" + RecencyCriteriaRepresentation: + title: Recency Criteria Output + description: Represents recency criteria data. + type: object + properties: + fieldName: + description: | + Field name of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + value: + description: | + Value of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + type: string + valueType: + description: | + Value type of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Record + - Time + type: string + valueUnit: + description: | + Value unit of the recency criteria. + + **Filter Group:** Small + + **Available Version:** 59.0 + enum: + - Day + - Hour + type: string + RecordFieldConfigurationInputRepresentation: + title: Record Field Configuration Input + description: Represents the input for record field configurations. + allOf: + - $ref: "#/components/schemas/IndexFieldConfigurationInputRepresentation" + - type: object + properties: + tokenizations: + description: | + List of tokenizations. + + **Available Version:** 58.0 + type: array + items: + $ref: "#/components/schemas/TokenizationInputRepresentation" + RecordFieldConfigurationRepresentation: + title: Record Field Configuration Output + description: Represents record field configurations. + allOf: + - $ref: "#/components/schemas/IndexFieldConfigurationRepresentation" + - type: object + properties: + tokenizations: + description: | + List of tokenizations. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: array + items: + $ref: "#/components/schemas/TokenizationRepresentation" + RedshiftRouteDetailsInputRepresentation: + title: Redshift Route Details Input + description: | + Input representation of route details for the cloud service used by the Private Network Route: Amazon Redshift. + allOf: + - $ref: "#/components/schemas/RouteDetailsInputRepresentation" + - type: object + RedshiftRouteDetailsRepresentation: + title: Redshift Route Details Output + description: | + Represents route details for the cloud service used by the Private Network Route: Amazon Redshift. + allOf: + - $ref: "#/components/schemas/RouteDetailsRepresentation" + - type: object + RefreshConfigInputRepresentation: + title: Refresh Config Input + description: Represents the input for a data stream refresh configuration. + type: object + properties: + additionalAttributes: + description: | + Additional attributes for the data stream refresh configuration. For example, `shouldFetchImmediately`, `shouldTreatMissingFilesAsFailures`, and `doesPeriodicFullRefresh`. + + **Available Version:** 60.0 + type: object + additionalProperties: + type: string + frequency: + description: | + Frequency for the data stream refresh. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/DataStreamFrequencyInputRepresentation" + isAccelerationEnabled: + description: | + Indicates whether acceleration is enabled for the data stream refresh (`true`) or not (`false`). + + **Available Version:** 62.0 + type: boolean + refreshMode: + description: | + Refresh mode for the data stream. + + **Available Version:** 60.0 + type: string + enum: + - TOTAL_REPLACE + - UPSERT + - INCREMENTAL + - REPLACE + - NEAR_REAL_TIME_INCREMENTAL + - PARTIAL_UPDATE + RefreshConfigRepresentation: + title: Data Stream Refresh Config Output + description: Refresh configuration of the data stream. + type: object + properties: + frequency: + description: | + Frequency of the refresh configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataStreamFrequencyRepresentation" + hasHeaders: + description: | + Indicates whether the refresh configuration has headers (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + isAccelerationEnabled: + description: | + Indicates whether acceleration is enabled for the corresponding data lake object (DLO) (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 62.0 + type: boolean + refreshMode: + description: | + Refresh mode of the refresh configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - TOTAL_REPLACE + - UPSERT + - INCREMENTAL + - REPLACE + - NEAR_REAL_TIME_INCREMENTAL + - PARTIAL_UPDATE + type: string + shouldFetchImmediately: + description: | + Indicates whether the refresh config should fetch immediately (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + shouldTreatMissingFilesAsFailures: + description: | + Indicates whether the refresh config should treat missing files as failures (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + RelationshipFieldRepresentation: + title: Relationship Field Output + description: Represents details about the field involved in a relationship between + data model objects (DMOs). + type: object + properties: + label: + description: | + Label of the field in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + name: + description: | + Developer name of the field in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + type: + description: | + Type of the field in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + enum: + - CalculatedInsightField + - DatamodelField + - Sobjectfield + type: string + RelationshipObjectRepresentation: + title: Relationship Object Output + description: Represents details about the object involved in a relationship between + data model objects (DMOs). + type: object + properties: + keyQualifierField: + description: | + Key qualifier field of the object in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + label: + description: | + Label of the object in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + name: + description: | + Developer name of the object in the relationship. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + ResourceFilterByPropertyInputRepresentation: + title: Resource Filter By Property Input + description: Input representation to filter fields and objects for a connection by property. + type: object + # Omit parent ConnectionInputRepresentation object to avoid overly + # complicated inheritance in documentation. Include `name` property + # inherited from parent because it's required for functional filter. + properties: + name: + description: | + Name of the property to filter against the `values` based on the `filterGroup`. + + **Available Version:** 60.0 + type: string + filterOperator: + description: | + Filter operation to perform on the `name` and `values`. + + **Available Version:** 62.0 + type: string + enum: + - EqualsOp + - LikeOp + - SubstrOp + values: + description: | + List of values on which to filter the `name` based on the `filterOperator`. + + **Available Version:** 62.0 + type: array + items: + type: string + required: + - filterOperator + - values + ResourceFiltersInputRepresentation: + title: Resource Filters Input + description: Input representation for resource filters for a connection. + type: object + # Omit parent ConnectionInputRepresentation object to avoid overly + # complicated inheritance in documentation. + properties: + filtersByProperty: + description: | + List of filters that return only a specific subset of fields and objects for a connection. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ResourceFilterByPropertyInputRepresentation" + required: + - filtersByProperty + RouteDetailsInputRepresentation: + title: Route Details Input + description: Abstract superclass for all route details input types for a Private Network Route. + type: object + discriminator: + propertyName: type + mapping: + AmazonMsk: "#/components/schemas/AmazonMSKRouteDetailsInputRepresentation" + Redshift: "#/components/schemas/RedshiftRouteDetailsInputRepresentation" + Snowflake: "#/components/schemas/SnowflakeRouteDetailsInputRepresentation" + properties: + serviceName: + description: | + Service name of the endpoint for the Private Network Route. + + **Available Version:** 65.0 + type: string + type: + description: | + Type of the Private Network Route. + + **Available Version:** 65.0 + type: string + enum: + - AmazonMsk + - Redshift + - Snowflake + required: + - serviceName + - type + RouteDetailsRepresentation: + title: Route Details Output + type: object + description: Represents route details for a Private Network Route. + discriminator: + propertyName: type + mapping: + AmazonMsk: "#/components/schemas/AmazonMSKRouteDetailsRepresentation" + Redshift: "#/components/schemas/RedshiftRouteDetailsRepresentation" + Snowflake: "#/components/schemas/SnowflakeRouteDetailsRepresentation" + properties: + serviceName: + description: | + Service name of the endpoint for the Private Network Route. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + type: + description: | + Type of the Private Network Route. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + enum: + - AmazonMsk + - Redshift + - Snowflake + RunHistoryOutputProgressRepresentation: + title: Run History Output Progress Output + description: For a batch data transform, contains information about the output + node that the transformed data is written to. + type: object + properties: + completedDate: + description: | + Date and time when the data transform finished writing + to the output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataObjectName: + description: | + Developer name of the object used as the data transform's output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + dataObjectType: + description: | + Type of object used for the data transform's output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - DataLakeObject + - DataModelObject + type: string + name: + description: | + Name of the data transform's output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + status: + description: | + Status of the result in the output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + enum: + - Error + - Pending + - Running + - Success + type: string + totalRows: + format: int64 + description: | + Total number of rows written to the output node. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: integer + SalesforceMarketingCloudConnectorDetailsConfig: + title: Salesforce Marketing Cloud Connector Details Config Input + description: Represents the configuration details for a Salesforce Marketing Cloud connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsConfig" + - type: object + properties: + eid: + description: | + Enterprise ID of the Marketing Cloud account. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + mid: + description: | + Member ID (business unit) of the Marketing Cloud account. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + subType: + description: | + The subtype of the connector details, either `SalesforceMarketingCloudStandard` or `SalesforceMarketingCloudDataExtension`. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + SalesforceMarketingCloudConnectorDetailsRepresentation: + title: Salesforce Marketing Cloud Connector Details Output + description: Represents the output for a Salesforce Marketing Cloud connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsRepresentation" + - type: object + properties: + eid: + description: | + Enterprise ID of the Marketing Cloud account. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + mid: + description: | + Member ID (business unit) of the Marketing Cloud account. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + SalesforceMarketingCloudDataExtensionConnectionObjectRepresentation: + title: Salesforce Marketing Cloud Data Extension Connection Object Output + description: Represents a data extension source object for a Salesforce Marketing Cloud connection. + allOf: + - $ref: "#/components/schemas/BaseConnectionObjectRepresentation" + - type: object + properties: + customObjectId: + description: | + Custom object ID of the data extension source object. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + description: + description: | + Description of the data extension source object. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + required: + - customObjectId + SalesforceMarketingCloudStandardConnectionObjectRepresentation: + title: Salesforce Marketing Cloud Standard Connection Object Output + description: Represents a standard source object for a Salesforce Marketing Cloud connection. + allOf: + - $ref: "#/components/schemas/BaseConnectionObjectRepresentation" + - type: object + properties: + bundleName: + description: | + Name of the bundle to which the source object belongs. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + required: + - bundleName + SampleParametersInputRepresentation: + title: Sample Parameters Input + description: Represents sample parameters for a load node. + type: object + properties: + filters: + description: | + Sample filters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FilterParametersInputRepresentation" + sortBy: + description: | + Fields to sort sample on. + + **Available Version:** 60.0 + type: array + items: + type: string + sortDirection: + description: | + Sample sort direction. + + **Available Version:** 60.0 + enum: + - Ascending + - Descending + type: string + type: + description: | + Sample type. + + **Available Version:** 60.0 + enum: + - Custom + - TopN + - Unique + type: string + uniqueSampleFieldName: + description: | + Field name for unique sample. + + **Available Version:** 60.0 + type: string + required: + - filters + - sortBy + - sortDirection + - type + - uniqueSampleFieldName + SampleParametersRepresentation: + title: Sample Parameters Output + description: Represents the sample parameters of a load node. + type: object + properties: + filters: + description: | + Sample filters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/FilterParametersRepresentation" + sortBy: + description: | + Fields to sort sample on. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + sortDirection: + description: | + Sample sort direction. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Ascending + - Descending + type: string + type: + description: | + Sample type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Custom + - TopN + - Unique + type: string + uniqueSampleFieldName: + description: | + Field name for unique sample. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + ScheduleInputRepresentation: + title: Schedule Input + description: Base schedule input representation. + type: object + discriminator: + propertyName: frequency + mapping: + Daily: "#/components/schemas/DailyScheduleInputRepresentation" + Hourly: "#/components/schemas/CdpHourlyScheduleInputRepresentation" + Minutely: "#/components/schemas/CdpMinutelyScheduleInputRepresentation" + Monthly: "#/components/schemas/MonthlySpecificScheduleInputRepresentation" + MonthlyRelative: "#/components/schemas/CdpMonthlyRelativeScheduleInputRepresentation" + None: "#/components/schemas/CdpNoneScheduleInputRepresentation" + Weekly: "#/components/schemas/WeeklyScheduleInputRepresentation" + properties: + definitionName: + description: | + Name of the schedule definition. + + **Available Version:** 63.0 + type: string + frequency: + description: | + Frequency on which the schedule is run. `None` removes the schedule and is the default. + + **Available Version:** 58.0 + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + - Transform + type: string + timeInfo: + description: | + When to run the schedule. + + **Available Version:** 58.0 + allOf: + - $ref: "#/components/schemas/CdpTimeInputRepresentation" + required: + - frequency + - time + ScheduleOutputRepresentation: + title: Schedule Info Output + type: object + description: Represents additional information about the segment publish schedule. + discriminator: + propertyName: frequency + mapping: + Daily: "#/components/schemas/DailyScheduleRepresentation" + Hourly: "#/components/schemas/CdpHourlyScheduleRepresentation" + Minutely: "#/components/schemas/CdpMinutelyScheduleRepresentation" + Monthly: "#/components/schemas/MonthlySpecificScheduleRepresentation" + MonthlyRelative: "#/components/schemas/CdpMonthlyRelativeScheduleRepresentation" + None: "#/components/schemas/CdpNoneScheduleRepresentation" + Weekly: "#/components/schemas/WeeklyScheduleRepresentation" + properties: + frequency: + description: | + Publish schedule frequency. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Daily + - Hourly + - Minutely + - Monthly + - MonthlyRelative + - Weekly + - None + - Transform + nextScheduledDate: + description: | + Next scheduled date to publish the segment. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + timeInfo: + description: | + Additional information about the publish schedule time. + + **Filter Group:** Small + + **Available Version:** 63.0 + $ref: "#/components/schemas/TimeOutputRepresentation" + ScheduleRepresentation: + title: Schedule Representation Output + description: Represents a save node. + type: object + properties: + schedule: + description: | + Schedule of the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + url: + description: | + URL of the data transform schedule. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SchemaFieldFormatSymbolsRepresentation: + title: Schema Field Format Symbols Output + description: Represents format symbols for a schema node field. + type: object + properties: + currencySymbol: + description: | + Field currency symbol. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + decimalSymbol: + description: | + Field decimal symbol. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + groupingSymbol: + description: | + Field grouping symbol. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SchemaFieldNewPropertiesRepresentation: + title: Schema Field New Properties Output + description: Represents new field properties for a schema node. + type: object + properties: + label: + description: | + Field label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + typeProperties: + description: | + New property values. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaFieldTypePropertiesRepresentation" + SchemaFieldParametersInputRepresentation: + title: Schema Field Parameters Input + description: Represents a schema node field. + type: object + properties: + errorValue: + description: | + Value to output on error. + + **Available Version:** 60.0 + type: string + name: + description: | + Schema field name. + + **Available Version:** 60.0 + type: string + newProperties: + description: | + Field properties. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaFieldPropertiesInputRepresentation" + required: + - errorValue + - name + - newProperties + SchemaFieldPropertiesInputRepresentation: + title: Schema Field Properties Input + description: Represents common field properties. + type: object + properties: + label: + description: | + Field label. + + **Available Version:** 60.0 + type: string + name: + description: | + Field name. + + **Available Version:** 60.0 + type: string + typeProperties: + description: | + Field type properties. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaTypePropertiesCastInputRepresentation" + required: + - label + - name + - typeProperties + SchemaFieldRepresentation: + title: Schema Field Output + description: Represents a schema node field. + type: object + properties: + errorValue: + description: | + Value to output on error. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + newProperties: + description: | + New property values. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaFieldNewPropertiesRepresentation" + SchemaFieldTypePropertiesRepresentation: + title: Schema Field Type Properties Output + description: Represents a schema node field type. + type: object + properties: + format: + description: | + Field format. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + length: + description: | + Field length. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + precision: + description: | + Field precision. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + scale: + description: | + Field scale. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + symbols: + description: | + Field symbols. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaFieldFormatSymbolsRepresentation" + type: + description: | + Field type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + SchemaFormatSymbolsInputRepresentation: + title: Schema Format Symbols Input + description: Represents the format for symbols. + type: object + properties: + currencySymbol: + description: | + Currency symbol format. + + **Available Version:** 60.0 + type: string + decimalSymbol: + description: | + Decimal symbol format. + + **Available Version:** 60.0 + type: string + groupingSymbol: + description: | + Grouping symbol format. + + **Available Version:** 60.0 + type: string + required: + - currencySymbol + - decimalSymbol + - groupingSymbol + SchemaNodeInputRepresentation: + title: Schema Node Input + description: Represents a schema node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaParametersInputRepresentation" + required: + - parameters + SchemaNodeRepresentation: + title: Schema Node Output + description: Represents a schema node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaParametersRepresentation" + SchemaParametersInputRepresentation: + title: Schema Parameters Input + description: Represents a schema node in Batch Data Transforms. + type: object + properties: + fields: + description: | + Schema fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SchemaFieldParametersInputRepresentation" + slice: + description: | + Schema slice definition. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaSliceInputRepresentation" + required: + - fields + - slice + SchemaParametersRepresentation: + title: Schema Parameters Output + description: Represents a schema node. + type: object + properties: + fields: + description: | + Fields to edit. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SchemaFieldRepresentation" + slice: + description: | + Which fields to keep or drop. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaSliceRepresentation" + SchemaSliceInputRepresentation: + title: Schema Slice Input + description: Represents slice definition. + type: object + properties: + fields: + description: | + List of fields for `Select` or `Drop`. + + **Available Version:** 60.0 + type: array + items: + type: string + ignoreMissingFields: + description: | + Indicates whether to ignore missing fields (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + mode: + description: | + Slice mode. + + **Available Version:** 60.0 + enum: + - Drop + - Select + type: string + required: + - fields + - ignoreMissingFields + - mode + SchemaSliceRepresentation: + title: Schema Slice Output + description: Represents a schema node slice. + type: object + properties: + fields: + description: | + Fields to select or drop. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + ignoreMissingFields: + description: | + Indicates whether to ignore missing fields (`true`) or not (`false`) + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + mode: + description: | + Select or drop fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SchemaTypePropertiesCastInputRepresentation: + title: Schema Type Properties Cast Input + description: Represents casting for types. + type: object + properties: + format: + description: | + DateTime format. + + **Available Version:** 60.0 + type: string + length: + description: | + Total length of text. + + **Available Version:** 60.0 + type: integer + precision: + description: | + Length of arbitrary precision value. + + **Available Version:** 60.0 + type: integer + scale: + description: | + Number of digits to right of decimal point. + + **Available Version:** 60.0 + type: integer + symbols: + description: | + Number format. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SchemaFormatSymbolsInputRepresentation" + type: + description: DataType to Convert to + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + required: + - format + - length + - precision + - scale + - symbols + - type + SearchRankingFieldInputRepresentation: + title: Search Ranking Field Input + description: Represents the input for ranking search fields. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + aliasName: + description: | + Alias of the field. + + **Available Version:** 64.0 + type: string + developerName: + description: | + Developer name of the rank field. + + **Available Version:** 61.0 + type: string + rankType: + description: | + Ranking factor used to influence the ranking of search result field types, `POPULARITY` or `RECENCY`, for hybrid search. + + **Available Version:** 61.0 + type: string + relatedDmoDeveloperName: + description: | + API name of the related data model object (DMO). + + **Available Version:** 61.0 + type: string + relatedDmoFieldDeveloperName: + description: | + API name of the related DMO field chosen for ranking factor. + + **Available Version:** 61.0 + type: string + relatedDmoFieldName: + description: | + Name of the related DMO field chosen for ranking factor. + + **Available Version:** 61.0 + type: string + relatedDmoName: + description: | + Name of the related DMO. + + **Available Version:** 61.0 + type: string + relationships: + description: | + Field relationship paths. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/SourceTargetRelationshipInputRepresentation" + SegmentTimeZoneRepresentation: + title: Segment Time Zone Output + type: object + description: Represents the time zone of a segment publish schedule. + properties: + gmtOffset: + description: | + Time zone offset to GMT. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: number + format: double + name: + description: | + Time zone name. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + zoneId: + description: | + Time zone identifier. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + SemanticSearchConfigRepresentation: + title: Semantic Search Config Output + description: Semantic Search Config Representation + type: object + properties: + config: + description: | + The semantic search configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SemanticSearchDefDetailRepresentation: + title: Semantic Search Def Detail Output + description: Semantic Search Definition Detail Representation + type: object + properties: + attachmentDmoId: + description: | + Attachment data model object's (DMO's) ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + attachmentDmoName: + description: | + Attachment DMO's name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + chunkDmoDeveloperName: + description: | + Chunk DMO's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + chunkDmoId: + description: | + Chunk DMO's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + chunkDmoName: + description: | + Chunk DMO's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + chunkingConfiguration: + description: | + Chunking configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ChunkingConfigurationRepresentation" + dataspace: + description: | + Name of the data space. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + description: + description: | + Description. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + developerName: + description: | + Developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + id: + description: | + ID of the record. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + indexConfiguration: + description: | + Index configuration for the semantic search record. + + **Filter Group:** Small + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/IndexConfigurationRepresentation" + indexRefreshedOn: + description: | + Date and time of the search index's last update. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + label: + description: | + Label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + rankingConfigurations: + description: | + List of ranking configuration object IDs that were created for hybrid search. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/RankingFieldsDetailsRepresentation" + searchType: + description: | + Type of the search index (`HYBRID` or `VECTOR`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoDeveloperName: + description: | + Source DMO's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoId: + description: | + Source DMO's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + transcribeDmoDeveloperName: + description: | + Transcribe DMO's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + transcribeDmoName: + description: | + Transcribe DMO's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + transformConfigurations: + description: | + Transform configurations. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TransformConfigurationRepresentation" + vectorDmoDeveloperName: + description: | + Vector DMO's developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoId: + description: | + Vector DMO's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoName: + description: | + Vector DMO's label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorEmbedding: + description: | + Vector embedding. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorEmbeddingDetailsRepresentation" + vectorEmbeddingConfiguration: + description: | + Vector embedding configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorConfigurationRepresentation" + version: + description: | + Version of the record. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SemanticSearchDefDetailsRepresentation: + title: Semantic Search Def Details Output + description: Semantic search definition details representation + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + semanticSearchDefinitionDetails: + description: | + List of semantic search definition detail objects. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SemanticSearchDefDetailRepresentation" + required: + - semanticSearchDefinitionDetails + SemanticSearchInputRepresentation: + title: Semantic Search Input + description: The input representation for semantic search. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + activationStatus: + description: | + Activation status of the semantic search record. + + **Available Version:** 60.0 + type: string + attachmentDmoDeveloperName: + description: | + Developer name of the attachment `MktDataModelObject`. For example, `loanAgreement__dlm`. + + **Available Version:** 62.0 + type: string + chunkDmoDeveloperName: + description: | + Developer name of the data model object (DMO) used for chunking, excluding the `__dlm` suffix. + + **Available Version:** 60.0 + type: string + chunkDmoName: + description: | + Name of the DMO used for chunking. + + **Available Version:** 60.0 + type: string + chunkingConfiguration: + description: | + Chunking configuration. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ChunkingConfigInputRepresentation" + description: + description: | + Description of semantic search record to be created. + + **Available Version:** 60.0 + type: string + developerName: + description: | + Developer name of the semantic search record to be created. + + **Available Version:** 60.0 + type: string + indexConfiguration: + description: | + Index configuration for the semantic search record. + + **Available Version:** 64.0 + allOf: + - $ref: "#/components/schemas/IndexConfigInputRepresentation" + label: + description: | + Label of semantic search record to be created. + + **Available Version:** 60.0 + type: string + processingType: + description: | + Processing type of the search index, such as `NEAR_REALTIME` or `REALTIME`. + + **Available Version:** 63.0 + type: string + rankingConfigurations: + description: | + List of ranking configurations for hybrid search. Selecting fields for a ranking configuration is optional. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SearchRankingFieldInputRepresentation" + searchType: + description: | + Type of the search index (`HYBRID` or `VECTOR`). + + **Available Version:** 60.0 + type: string + sourceDmoDeveloperName: + description: | + Developer name of the source (parent) `MktDataModelObject`. For example, `loanAgreement__dlm`. + + **Available Version:** 60.0 + type: string + transcribeDmoDeveloperName: + description: | + Transcribe output DMO developer name. + + **Available Version:** 60.0 + type: string + transcribeDmoName: + description: | + Transcribe output DMO name. + + **Available Version:** 60.0 + type: string + transcribeDmoId: + description: | + Transcribe output DMO ID. + + **Available Version:** 60.0 + type: string + transformConfigurations: + description: | + Transform configuration. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TransformConfigInputRepresentation" + vectorDmoDeveloperName: + description: | + Developer name of the vector DMO, excluding the `__dlm` suffix. + + **Available Version:** 60.0 + type: string + vectorDmoName: + description: | + Name of the vector DMO. + + **Available Version:** 60.0 + type: string + vectorEmbedding: + description: | + Vector embedding objects. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorEmbeddingInputRepresentation" + vectorEmbeddingConfiguration: + description: | + Vector embedding configuration. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorEmbeddingConfigInputRepresentation" + required: + - chunkDmoDeveloperName + - chunkDmoName + - chunkingConfiguration + - developerName + - label + - searchType + - sourceDmoDeveloperName + - vectorDmoDeveloperName + - vectorDmoName + - vectorEmbedding + - vectorEmbeddingConfiguration + SemanticSearchRepresentation: + title: Semantic Search Output + description: Represents the output for a semantic search record. + allOf: + - $ref: "#/components/schemas/CdpPaginatedResponseBaseRepresentation" + - type: object + properties: + chunkingStrategies: + description: | + List of chunking strategy object IDs. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + id: + description: | + ID of the semantic search definition that was updated or created. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + rankingConfigurations: + description: | + List of ranking configuration object IDs that were created for hybrid search. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + transformations: + description: | + The list of transformation IDs. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + vectorEmbedding: + description: | + The structure for vector embeddings, including any extra fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorEmbeddingRepresentation" + type: object + SnowflakeRouteDetailsInputRepresentation: + title: Snowflake Route Details Input + description: | + Input representation of route details for the cloud service used by the Private Network Route: Amazon Snowflake. + allOf: + - $ref: "#/components/schemas/RouteDetailsInputRepresentation" + - type: object + properties: + accountUrl: + description: | + URL of the Snowflake account. + + **Available Version:** 65.0 + type: string + required: + - accountURL + SnowflakeRouteDetailsRepresentation: + title: Snowflake Route Details Output + description: | + Represents route details for the cloud service used by the Private Network Route: Amazon Snowflake. + allOf: + - $ref: "#/components/schemas/RouteDetailsRepresentation" + - type: object + properties: + accountUrl: + description: | + URL of the Snowflake account. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + required: + - accountURL + SortSpecificationRepresentation: + title: Sort Specification Output + type: object + description: Represents a parameter sort specification. + properties: + direction: + description: | + Direction for the sort. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Ascending + - Descending + fieldName: + description: | + Field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SourceTargetRelationshipInputRepresentation: + title: Source Target Relationship Input + description: Represents the input for the relationship to a source search index data model object (DMO). + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + sourceDmoDeveloperName: + description: | + Source DMO developer name. + + **Available Version:** 60.0 + type: string + sourceDmoFieldDeveloperName: + description: | + Source DMO field developer name. + + **Available Version:** 60.0 + type: string + sourceDmoLabel: + description: | + Source DMO label. + + **Available Version:** 61.0 + type: string + sourceFieldLabel: + description: | + Source DMO field label. + + **Available Version:** 61.0 + type: string + targetDmoDeveloperName: + description: | + Target DMO developer name. + + **Available Version:** 60.0 + type: string + targetDmoFieldDeveloperName: + description: | + Target DMO field developer name. + + **Available Version:** 60.0 + type: string + targetDmoLabel: + description: | + Target DMO label. + + **Available Version:** 61.0 + type: string + targetFieldLabel: + description: | + Target DMO field label. + + **Available Version:** 61.0 + type: string + required: + - sourceDmoDeveloperName + - sourceDmoFieldDeveloperName + - targetDmoDeveloperName + - targetDmoFieldDeveloperName + SplitNodeInputRepresentation: + title: Split Node Input + description: Represents a split node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SplitParametersInputRepresentation" + required: + - parameters + SplitNodeRepresentation: + title: Split Node Output + description: Represents a split node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SplitParametersRepresentation" + SplitParametersInputRepresentation: + title: Split Parameters Input + description: Represents a split node. + type: object + properties: + delimiter: + description: | + Field delimiter. + + **Available Version:** 60.0 + type: string + sourceField: + description: | + Source field. + + **Available Version:** 60.0 + type: string + targetFields: + description: | + Target fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/NameLabelInputRepresentation" + required: + - delimiter + - sourceField + - targetFields + SplitParametersRepresentation: + title: Split Parameters Output + type: object + description: Represents split node parameters. + properties: + delimiter: + description: | + Delimiter of the split parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceField: + description: | + Source field. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetFields: + description: | + List of target fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/NameLabelRepresentation" + SqlDataTransformDefinitionInputRepresentation: + title: Sql Data Transform Definition Input + description: Defines a streaming data transform during a creation (post) request. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionInputRepresentation" + - type: object + properties: + expression: + description: | + SQL expression for the streaming transform. + + **Available Version:** 60.0 + type: string + targetDlo: + description: | + Target data lake object (DLO) for the streaming transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetDmo: + description: | + Target data model object (DMO) for the streaming transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SqlDataTransformDefinitionRepresentation: + title: Sql Data Transform Defintion Output + description: Represents a streaming data transform definition. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionRepresentation" + - type: object + properties: + expression: + description: | + SQL expression for the data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + targetDlo: + description: | + Name of the target data lake object (DLO). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SqlFilterNodeInputRepresentation: + title: SQL Filter Node Input + description: Represents a SQL filter node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SqlFilterParametersInputRepresentation" + required: + - parameters + SqlFilterNodeRepresentation: + title: Sql Filter Node Output + description: Represents a SQL filter node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/SqlFilterParametersRepresentation" + SqlFilterParametersInputRepresentation: + title: SQL Filter Parameters Input + description: Represents a SQL filter expression. + type: object + properties: + expressionType: + description: | + Type of filter expression. + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + sqlFilterExpression: + description: | + SQL filter expression. + + **Available Version:** 60.0 + type: string + required: + - sqlFilterExpression + SqlFilterParametersRepresentation: + title: Sql Filter Parameters Output + type: object + description: Represents SQL filter node parameters. + properties: + expressionType: + description: | + Type of SQL filter expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Dcsql + - Sql + sqlFilterExpression: + description: | + SQL filter expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + SqlFormulaFieldInputRepresentation: + title: SQL Formula Field Input + description: Represents a SQL formula field. + type: object + properties: + formulaExpression: + description: | + Formula expression. + + **Available Version:** 60.0 + type: string + label: + description: | + Label. + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Available Version:** 60.0 + type: string + type: + description: | + SQL formula type. + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + required: + - formulaExpression + - label + - name + - type + SqlFormulaFieldRepresentation: + title: SQL Formula Field Output + description: SQL formula field representation. + type: object + discriminator: + propertyName: type + properties: + defaultValue: + description: | + Default value. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + formulaExpression: + description: | + Formula expression. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + label: + description: | + Label. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + name: + description: | + Name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: + description: | + Sql Formula type. + + **Filter Group:** Small + + **Available Version:** 60.0 + enum: + - Boolean + - DateOnly + - DateTime + - Number + - Text + type: string + StaticDataConfigInputRepresentation: + title: Static Data Config Input + description: Represents the configuration input for static data. + type: object + properties: + staticData: + description: | + List of static data. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/StaticDataInputRepresentation" + required: + - staticData + StaticDataConfigRepresentation: + title: Static Data Config Output + description: Represents the static data configuration output. + type: object + properties: + staticData: + description: | + List of activation static attributes. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/StaticDataRepresentation" + StaticDataInputRepresentation: + title: Static Data Input + description: Represents the input for static data. + type: object + properties: + name: + description: | + Name of the static attribute. + + **Available Version:** 60.0 + type: string + value: + description: | + Value of the static attribute. + + **Available Version:** 60.0 + type: string + required: + - name + - value + StaticDataRepresentation: + title: Static Data Output + description: Represents the static data output. + type: object + properties: + name: + description: | + Column name of the static data. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + value: + description: | + Column value of the static data. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + StlDataTransformDefinitionInputRepresentation: + title: Stl Data Transform Definition Input + description: Defines a batch data transform during a creation (post) request. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionInputRepresentation" + - type: object + properties: + nodes: + description: | + Map of transform nodes defined for the batch data transform. + + **Filter Group:** Small + + **Available Version:** 62.0 + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + ui: + description: | + UI object info required for rendering in the interactive data transform editor. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: object + StlDataTransformDefinitionRepresentation: + title: Stl Data Transform Definition Output + description: Represents a base64atch data transform definition. + allOf: + - $ref: "#/components/schemas/DataTransformDefinitionRepresentation" + - type: object + properties: + nodes: + description: | + Transform nodes defined for the STL data transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + ui: + description: | + STL data transform UI metadata. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + StreamingAppConnectionInputRepresentation: + title: Streaming App Connection Input + description: Input representation for a Streaming App connector. + allOf: + - $ref: "#/components/schemas/ConnectionInputRepresentation" + - type: object + properties: + streamingAppSubType: + description: | + 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 + type: string + enum: + - WebApp_GA4 + streamingAppType: + description: | + Connector type of the Streaming App connector. + + **Available Version:** 64.0 + type: string + enum: + - MobileApp + - ServerApp + - WebApp + required: + - streamingAppType + StreamingAppConnectionPatchInputRepresentation: + title: Streaming App Connection Patch Input + description: Input representation for a Streaming App connector for a patch request. + allOf: + - $ref: "#/components/schemas/ConnectionPatchInputRepresentation" + - type: object + properties: + modules: + description: | + List of Streaming App modules to be added. + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ConnectionModuleConfigInputRepresentation" + required: + - modules + StreamingAppConnectionRepresentation: + title: Streaming App Connection Output + description: Represents a Streaming App connector. + allOf: + - $ref: "#/components/schemas/ConnectionRepresentation" + - type: object + properties: + modules: + description: | + List of Steaming App modules. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/ConnectionModuleConfigRepresentation" + sourceId: + description: | + Source ID of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + status: + description: | + Status of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Connected + - Disconnected + - Failed + - NeedsReAuth + streamingAppSubType: + description: | + Subtype of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + enum: + - WebApp_GA4 + streamingAppType: + description: | + Type of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - MobileApp + - ServerApp + - WebApp + tenantSpecificEndpoint: + description: | + Tenant-specific endpoint of the Streaming App connector. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + StreamingAppConnectionSchemaFieldInputRepresentation: + title: Streaming App Connection Schema Field Input + description: Represents the input for Streaming App field types. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldInputRepresentation" + - type: object + properties: + dataType: + description: | + Data type of the schema field. + + **Available Version:** 60.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + isDataRequired: + description: | + Indicates whether the field is mandatory (`true`) or not (`false`). + + **Available Version:** 60.0 + type: boolean + primaryIndexOrder: + description: | + Index that defines which event field is the primary key. + + **Available Version:** 60.0 + type: integer + StreamingAppConnectionSchemaFieldRepresentation: + title: Streaming App Connection Schema Field Output + description: Represents a Streaming App connection schema field. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaFieldRepresentation" + - type: object + properties: + dataType: + description: | + Data type of the schema fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Boolean + - Currency + - Date + - DateOnly + - DateTime + - Email + - Number + - Percent + - Phone + - Text + - Url + isDataRequired: + description: | + Indicates whether the field is mandatory (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 60.0 + type: boolean + primaryIndexOrder: + description: | + Index that defines which event field is the primary key. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + StreamingAppConnectionSchemaInputRepresentation: + title: Streaming App Connection Schema Input + description: Represents the input for a Streaming App schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaInputRepresentation" + - type: object + properties: + availabilityStatus: + description: | + Availability status of the event. + + **Available Version:** 60.0 + type: string + enum: + - Available + - InUse + category: + description: | + Category of the event. + + **Available Version:** 60.0 + type: string + enum: + - Engagement + - Other + - Profile + fields: + description: | + List of schema fields. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/StreamingAppConnectionSchemaFieldInputRepresentation" + StreamingAppConnectionSchemaRepresentation: + title: Streaming App Connection Schema Output + description: Represents a Streaming App connection schema. + allOf: + - $ref: "#/components/schemas/ConnectionSchemaRepresentation" + - type: object + properties: + availabilityStatus: + description: | + Availability status of the event. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Available + - InUse + category: + description: | + Category of the event. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Engagement + - Other + - Profile + fields: + description: | + List of schema fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/StreamingAppConnectionSchemaFieldRepresentation" + StreamingConnectorDetailsConfig: + title: Streaming Connector Details Config Input + description: Represents the configuration details for a streaming connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsConfig" + - type: object + properties: + category: + description: | + Category of the connector events. + + **Available Version:** 63.0 + type: string + enum: + - Directory_Table + - Engagement + - Insights + - Other + - Profile + events: + description: | + List of developer names of events from the schema selected from the connected app. + + **Available Version:** 63.0 + type: array + items: + type: string + name: + description: | + Name of the streaming connector. + + **Available Version:** 63.0 + type: string + streamingAppType: + description: | + Type of streaming app. + + **Available Version:** 63.0 + type: string + enum: + - MobileApp + - ServerApp + - WebApp + StreamingConnectorDetailsRepresentation: + title: Streaming Connector Details Output + description: Represents the output for a streaming connector. + allOf: + - $ref: "#/components/schemas/ConnectorDetailsRepresentation" + - type: object + properties: + category: + description: | + Category of the streaming connector. + + **Available Version:** 60.0 + type: string + enum: + - Engagement + - Other + - Profile + events: + description: | + Developer names of the streaming connector events. + + **Available Version:** 60.0 + type: array + items: + type: string + streamingAppType: + description: | + Type of streaming connector app, such as `WebApp` or `MobileApp`. + + **Available Version:** 60.0 + type: string + StreamingParametersRepresentation: + title: Streaming Parameters Output + type: object + description: Represents an output node's streaming parameters. + properties: + outputMode: + description: | + Type of output mode. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Append + - Complete + - Update + triggerIntervalSec: + description: | + Trigger interval in seconds. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: integer + triggerType: + description: | + Type of trigger. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + enum: + - Fixed + TimeOutputRepresentation: + title: Time Output + type: object + description: Represents the time in a publish schedule. + properties: + hour: + description: | + Hour amount. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + minute: + description: | + Minute amount. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + timezone: + description: | + Timezone of the publish schedule. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/SegmentTimeZoneRepresentation" + TokenizationInputRepresentation: + title: Tokenization Input + type: object + description: Represents the input for record field configuration tokenizations. + properties: + name: + description: | + Name of the tokenization, such as `TYPEAHEAD` or `STANDARD`. + + **Available Version:** 64.0 + type: string + TokenizationRepresentation: + title: Tokenization Output + type: object + description: Represents record field configuration tokenizations. + properties: + name: + description: | + Name of the tokenization, such as `TYPEAHEAD` or `STANDARD`. + + **Filter Group:** Small + + **Available Version:** 64.0 + type: string + TransformConfigInputRepresentation: + title: Transform Config Input + description: Represents the input for transforming an unstructured configuration. + type: object + properties: + fileLevelConfiguration: + description: | + File-level configurations used in the transform. + + **Available Version:** 61.0 + type: array + items: + $ref: "#/components/schemas/TransformFileLevelConfigurationInputRepresentation" + transformType: + description: | + Type of the transformation. Only transcribe is currently supported. + + **Available Version:** 61.0 + type: string + TransformConfigurationRepresentation: + title: Transform Configuration Output + description: Transform Configuration Detail Representation + type: object + properties: + fileLevelConfiguration: + description: | + List of file-level configurations for transform. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TransformFileLevelConfiguration" + transformType: + description: | + Transform type. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + TransformFileLevelConfiguration: + title: Transform File Level Configuration Output + description: Represents the file-level configuration for a transform. + type: object + properties: + config: + description: | + The configuration. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConfigRepresentation" + fileExtensions: + description: | + The list of file extensions, for example, ``. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + TransformFileLevelConfigurationInputRepresentation: + title: Transform File Level Configuration Input + description: Represents the input for a file transform configuration. + type: object + properties: + config: + description: | + Transform configuration. + + **Available Version:** 61.0 + allOf: + - $ref: "#/components/schemas/ConfigInputRepresentation" + fileExtensions: + description: | + File extensions list, for example, ``. + + **Available Version:** 61.0 + type: array + items: + type: string + TransformValidationIssueRepresentation: + title: Transform Validation Issue Output + description: Data transform validation issue representation. + type: object + properties: + definitionName: + description: | + Name of the validation definition issue. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + errorCode: + description: | + Error code. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - 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: + description: | + Error message. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + errorSeverity: + description: | + Error severity. + + **Filter Group:** Small + + **Available Version:** 62.0 + type: string + enum: + - Error + - Fatal + - Warning + type: + description: | + Type of validation issue. + + **Filter Group:** Small + + **Available Version:** 65.0 + type: string + enum: + - Definition + - Transform + TypeAndFilterInputRepresentation: + title: Type and Filter Input + description: Represents a wrapper for logical comparison filters. + type: object + properties: + filter: + description: | + Filter for the entity. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/BaseComparisonInputRepresentation" + type: + description: | + Name of the entity. + + **Available Version:** 60.0 + type: string + required: + - filter + - type + TypeAndFilterInputRepresentationConfig: + title: Type And Filter Input Config + description: Represents logical comparison input for a filter configuration. + type: object + properties: + filters: + description: | + List of filters. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/TypeAndFilterInputRepresentation" + required: + - filters + TypeAndFilterRepresentation: + title: Type and Filter Output + description: Represents the type and filter output. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + filter: + description: | + Filter. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/BaseComparisonRepresentation" + type: + description: | + Type. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + type: object + TypecastNodeInputRepresentation: + title: Typecast Node Input + description: Represents a typecast node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/TypecastParametersInputRepresentation" + required: + - parameters + TypeCastNodeRepresentation: + title: Type Cast Node Output + description: Represents a typecast node. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/TypeCastParametersRepresentation" + type: object + TypecastParametersInputRepresentation: + title: Typecast Parameters Input + description: Represents a typecast node. + type: object + properties: + fields: + description: | + Fields to typecast. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SchemaFieldParametersInputRepresentation" + required: + - fields + TypeCastParametersRepresentation: + title: Type Cast Parameters Output + description: Represents parameters of a typecast node. + type: object + properties: + fields: + description: | + Fields to edit. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SchemaFieldRepresentation" + UpdateNodeInputRepresentation: + title: Update Node Input + description: Update node in Batch Data Transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeInputRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/UpdateParametersInputRepresentation" + required: + - parameters + UpdateNodeRepresentation: + title: Update Node Output + description: Update data node in batch data transforms. + allOf: + - $ref: "#/components/schemas/DataTransformNodeRepresentation" + - type: object + properties: + parameters: + description: | + Node-specific parameters. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/UpdateParametersRepresentation" + UpdateParametersInputRepresentation: + title: Update Parameters Input + description: Represents input for an update node. + type: object + properties: + leftKeys: + description: | + Left keys. + + **Available Version:** 60.0 + type: array + items: + type: string + rightKeys: + description: | + Right keys. + + **Available Version:** 60.0 + type: array + items: + type: string + updateColumns: + description: | + Update columns. + + **Available Version:** 60.0 + type: object + required: + - leftKeys + - rightKeys + - updateColumns + UpdateParametersRepresentation: + title: Update Parameters Output + description: Represents update node output. + type: object + properties: + leftKeys: + description: | + Left keys. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + rightKeys: + description: | + Right keys. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + updateColumns: + description: | + Update columns. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + UseCaseTemplateAttributeAggregateConfigRepresentation: + title: Use Case Template Attribute Aggregate Config Output + description: Represents the attribute aggregation configuration details for a clean room template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + operators: + description: | + Type of aggregation operators. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - Count + - Distinct + - Sum + threshold: + description: | + Minimum number of rows in the result. This value is non-nullable. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: integer + UseCaseTemplateAttributeConfigRepresentation: + title: Use Case Template Attribute Config Output + description: Represents the attribute configuration details for a clean room template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + alias: + description: | + Alias of the use case template attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + defaultValue: + description: | + Default value of the use case template attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + description: + description: | + Description of the use case template attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + queryOptions: + description: | + Configuration of query options for the use case template attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateAttributeQueryOptionConfigRepresentation" + required: + description: | + Indicates whether the use case template attribute is required (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + tableName: + description: | + Table name of the use case template attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + tooltip: + description: | + Helper text shown in the UI. + + **Filter Group:** Small + + **Available Version:** 66.0 + type: string + UseCaseTemplateAttributeQueryOptionConfigRepresentation: + title: Use Case Template Attribute Query Option Config Output + description: Represents the attribute query configuration details for a clean room template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + aggregationOption: + description: | + Option for the attribute to be used with aggregation functions. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateAttributeAggregateConfigRepresentation" + selectable: + description: | + Indicates whether the attribute can be used in a `SELECT` clause (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + supportGroupBy: + description: | + Indicates whether the attribute can be used in a `GROUP BY` clause (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + supportJoin: + description: | + Indicates whether the attribute can be used in a `JOIN` clause (`true`) or not (`false`). + + **Filter Group:** Small + + **Available Version:** 63.0 + type: boolean + UseCaseTemplateConfigRepresentation: + title: Use Case Template Config Output + description: Represents the configuration details for a clean room template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + memberConfigs: + description: | + Configuration for the use case template members. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/UseCaseTemplateMemberConfigRepresentation" + UseCaseTemplateMappingAttributeFilterOptionRepresentation: + title: Use Case Template Mapping Attribute Filter Option Output + type: object + description: Represents the filter options for the mapping attributes for a clean room use case template. + properties: + operator: + description: | + Logical operator to apply on the attribute values. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + values: + description: | + List of values qualified for filter application + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + UseCaseTemplateMappingAttributeRepresentation: + title: Use Case Template Mapping Attribute Output + description: Represents the mapping attributes for a clean room use case template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + alias: + description: | + Alias for the mapping attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + attributeId: + description: | + ID of the mapping attribute. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + defaultValue: + description: | + Default value of the mapping attribute if it is not mapped. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + filterOptions: + description: | + Filter criteria to be applied to the attribute values. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateMappingAttributeFilterOptionRepresentation" + path: + description: | + Path that defines the relationship between this attribute and the collaboration entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/UseCaseTemplateMappingPathAttributeRepresentation" + subjectAttribute: + description: | + Pair that identifies the mapping between the template field and the mapped field. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateMappingSubjectAttributeRepresentation" + tableName: + description: | + Logical table name with which the attribute is associated. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + UseCaseTemplateMappingPathAttributeRepresentation: + title: Use Case Template Mapping Path Attribute Output + type: object + description: Represents the mapping path of attributes for a clean room use case template. + properties: + sourceAttribute: + description: | + Details of the source attribute in the path component. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateMappingSubjectAttributeRepresentation" + targetAttribute: + description: | + Details of the target attribute in the path component. + + **Filter Group:** Small + + **Available Version:** 63.0 + allOf: + - $ref: "#/components/schemas/UseCaseTemplateMappingSubjectAttributeRepresentation" + UseCaseTemplateMappingRepresentation: + title: Use Case Template Mapping Output + description: Represents a mapping for a clean room use case template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributes: + description: | + Mapping attributes for the use case template. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/UseCaseTemplateMappingAttributeRepresentation" + collaborationEntity: + description: | + 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 + type: string + UseCaseTemplateMappingSubjectAttributeRepresentation: + title: Use Case Template Mapping Subject Attribute Output + type: object + description: Represents a mapping subject attribute for a clean room use case template. + properties: + fieldLabel: + description: | + Label of the mapped entity field. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + fieldName: + description: | + Name of the mapped entity field. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + objectLabel: + description: | + Label of the mapped entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + objectName: + description: | + Name of the mapped entity. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + UseCaseTemplateMemberConfigRepresentation: + title: Use Case Template Member Config Output + description: Represents the member configuration details for a clean room template. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseRepresentation" + - type: object + properties: + attributeConfigs: + description: | + Attribute configuration for use case template members. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + $ref: "#/components/schemas/UseCaseTemplateAttributeConfigRepresentation" + memberType: + description: | + Type of use case template member. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: string + enum: + - Consumer + - Provider + UserValueInputRepresentation: + title: User Value Input + description: Represents the input for a user value. + type: object + properties: + id: + description: | + ID, such as `strip_html` or `max_tokens`. + + **Available Version:** 60.0 + type: string + value: + description: | + Value, such as `false`, `100`, or `COSINE`. + + **Available Version:** 60.0 + type: string + UserValuesRepresentation: + title: User Values Output + description: Represents user values. + type: object + properties: + id: + description: | + ID, for example `strip_html`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + value: + description: | + Value, for example `false`. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: object + VectorConfigElementRepresentation: + title: Vector Config Element Output + description: Represents details of part of a vector embedding config representation. + type: object + properties: + id: + description: ID, for example `HNSW`. + type: string + userValues: + description: | + User values, for example `{ hnswEfConstruction : 8 }` + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/UserValuesRepresentation" + VectorConfigurationRepresentation: + title: Vector Configuration Output + description: Represents vector-embedding configuration details. + type: object + properties: + embeddingModel: + description: | + Embedding model. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorConfigElementRepresentation" + index: + description: | + Indexes. + + **Filter Group:** Small + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/VectorConfigElementRepresentation" + similarityMetric: + description: | + Similarity metric. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + VectorEmbeddingConfigInputRepresentation: + title: Vector Embedding Config Input + description: Represents the input for a vector-embedding configuration. + type: object + properties: + embeddingModel: + description: | + Deployed ML model that creates embeddings, for example, `e5-large`. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConfigInputRepresentation" + index: + description: | + Type used in vector indexing, such as `HNSW` or `FLAT`. + + **Available Version:** 60.0 + allOf: + - $ref: "#/components/schemas/ConfigInputRepresentation" + similarityMetric: + description: | + Similarity metric used to calculate distance between vectors, for example, `COSINE`. + + **Available Version:** 60.0 + type: string + version: + description: | + Version of the record. + + **Available Version:** 60.0 + type: string + VectorEmbeddingDetailsRepresentation: + title: Vector Embedding Details Output + description: Represents vector-embedding details. + type: object + properties: + developerName: + description: | + Developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + id: + description: | + Record ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoDeveloperName: + description: | + Source data model object (DMO) developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoFieldDeveloperName: + description: | + Source DMO field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoFieldId: + description: | + Source DMO field ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + sourceDmoId: + description: | + Source DMO ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoDeveloperName: + description: | + Vector DMO developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoFieldDeveloperName: + description: | + Vector DMO field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoFieldId: + description: | + Vector DMO field ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorDmoId: + description: | + Vector DMO ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + vectorEmbeddingRelatedFields: + description: | + Vector-embedding related fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/VectorEmbeddingRelatedFieldsDetailsRepresentation" + VectorEmbeddingInputRepresentation: + title: Vector Embedding Input + description: Represents the input for vector embedding. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + einsteinStudioModelId: + description: | + Einstein Studio AI model ID. + + **Available Version:** 60.0 + type: string + vectorEmbeddingRelatedFields: + description: | + Extra fields for vector embedding. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/VectorEmbeddingRelatedFieldsInputRepresentation" + VectorEmbeddingRelatedFieldsDetailsRepresentation: + title: Vector Embedding Related Fields Details Output + description: Represents vector-embedding related fields details. + type: object + properties: + fieldRelationshipPathId: + description: | + Relationships path ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + id: + description: | + Record ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoDeveloperName: + description: | + Related data model object's (DMO's) developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldDeveloperName: + description: | + Related DMO's field developer name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldId: + description: | + Related DMO's field ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoFieldName: + description: | + Related DMO's field name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoId: + description: | + Related DMO's ID. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedDmoName: + description: | + Related DMO's name. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relationships: + description: | + List of relationships. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/FieldRelationshipsPathRepresentation" + VectorEmbeddingRelatedFieldsInputRepresentation: + title: Vector Embedding Related Fields Input + description: Represents the input for vector-embedding extra fields. + allOf: + - $ref: "#/components/schemas/CdpAssetBaseInputRepresentation" + - type: object + properties: + relatedDmoDeveloperName: + description: | + Related data model object (DMO) developer name. + + **Available Version:** 60.0 + type: string + relatedDmoFieldDeveloperName: + description: | + Related DMO field developer name. + + **Available Version:** 60.0 + type: string + relatedDmoFieldName: + description: | + Related DMO field name. + + **Available Version:** 61.0 + type: string + relatedDmoName: + description: | + Related DMO name. + + **Available Version:** 61.0 + type: string + relationshipCardinality: + description: | + Relationship cardinality between the source DMO field and target DMO field. For example, `OneToOne`, `ManyToOne`, or `OneToMany`. + + **Available Version:** 64.0 + type: string + relationships: + description: | + Field relationship paths. + + **Available Version:** 60.0 + type: array + items: + $ref: "#/components/schemas/SourceTargetRelationshipInputRepresentation" + VectorEmbeddingRepresentation: + title: Vector Embedding Output + description: Represents the output for vector-embedding. + type: object + properties: + id: + description: | + ID of created/updated vector embedding. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: string + relatedFields: + description: | + List of IDs of created vector embedding related fields. + + **Filter Group:** Small + + **Available Version:** 60.0 + type: array + items: + type: string + WeeklyScheduleInputRepresentation: + title: Weekly Schedule Input + description: Represents the input for creating a weekly schedule. + allOf: + - $ref: "#/components/schemas/ScheduleInputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule is to run. You can specify one day. + + **Available Version:** 58.0 + type: array + items: + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + WeeklyScheduleRepresentation: + title: Weekly Schedule Output + description: Represents a segment publication schedule that runs weekly. + allOf: + - $ref: "#/components/schemas/ScheduleOutputRepresentation" + - type: object + properties: + daysOfWeek: + description: | + Days of the week on which the schedule is to run. You can specify one day. + + **Filter Group:** Small + + **Available Version:** 63.0 + type: array + items: + type: string + enum: + - Friday + - Monday + - Saturday + - Sunday + - Thursday + - Tuesday + - Wednesday + interval: + description: | + Hourly interval at which segments can be published, from `1` through `52`. + + **Filter Group:** Small + + **Available Version:** 58.0 + type: integer + examples: + # activation targets & activations + get-activation-targets-response-example: + value: + { + "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]", + } + get-activations-response-example: + value: + { + "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]" + } + Amazon-S3-connector-request-example: + value: + { + "dataSpaceName": "default", + "name": "s3_target2", + "connector": + { + "name": "s3_conn_1", + "outputFormat": "CSV", + "bucketName": "", + "folderName": "folderName", + "accessKey": "", + "secretKey": "", + }, + "platformType": "AmazonS3" + } + Marketing-Cloud-connector-request-example: + value: + { + "dataSpaceName": "default", + "name": "mc-target", + "description": "MC target payload", + "platformType": "SalesforceMarketingCloud", + "connector": + { + "targetSubType": "DE", + "name": "MCE_Connector", + "businessUnitConfig": { "businessUnits": ["524000668", "524000673"] } + } + } + File-based-connectors-(Azure-GCS-SFTP)-request-example: + value: + { + "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" + } + } + Amazon-S3-connector-response-example: + value: + { + "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" + } + Marketing-Cloud-connector-response-example: + value: + { + "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" + } + File-based-connectors-(Azure-GCS-SFTP)-response-example: + value: + { + "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" + } + act-target-get-response-3-example: + value: + { + "connector": { "name": "sftpTargetConnector" }, + "platformType": "Sftp", + "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", + "platformName": "SFTP", + "status": "ACTIVE" + } + Data-Cloud-activation-target-response-example: + value: + { + "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", + } + Data-Cloud-activation-target-request-example: + value: + { + "name": "dc-connect-api", + "description": "Activation target for Data 360", + "platformType": "DataCloud", + "dataSpaceName": "default", + "isCappingEnabled": false, + "connector": {} + } + Ecosystem-external-platform-request-example: + value: + { + "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" }, + ] + } + } + } + strategic-partner-request-example: + value: + { + "name": "google-ads-platform-target", + "description": "description", + "platformType": "ExternalPlatform", + "dataSpaceName": "default", + "isCappingEnabled": false, + "connector": { "name": "PremiumPartnerGoogle", "keyPrefixName": "cdpactvstrgptnr" }, + } + Ecosystem-external-platform-response-example: + value: + { + "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" + } + strategic-partner-response-example: + value: + { + "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" + } + update-activation-target-request-example: + value: { "dataSpaceName": "default", "name": "s3_target2_changed" } + create-s3-activation-response-example: + value: + { + "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", + "shouldExcludeDeletes": false, + "shouldExcludeUpdates": false, + "staticDataConfig": { "staticData": [{ "name": "Test", "value": "TestValue" }] }, + "status": "ACTIVE", + } + activation-response-example: + value: + { + "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", + "shouldExcludeDeletes": false, + "shouldExcludeUpdates": false, + "staticDataConfig": { "staticData": [{ "name": "Test", "value": "TestValue" }] }, + "status": "ACTIVE", + } + publish-activation-response-example: + value: + { + "errors": [ + {} + ], + "success": true, + "publishStatus": "Publishing" + } + external-platform-activation-response-example: + value: + { + "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", + } + create-S3-activation-request-example: + value: + { + "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" }] }, + } + update-activation-request-example: + value: + { + "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" }, + ], + }, + } + create-strategic-partner-activation-request-example: + value: + { + "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", + } + create-strategic-partner-activation-response-example: + value: + { + "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", + } + get-audience-dmo-response-example: + value: + { + "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, + } + get-activation-external-platforms-output-example: + value: + { + "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, + } + # calculated insights + get-calculated-insights-output-example: + value: + { + "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, + }, + } + get-calculated-insight-output-example: + value: + { + "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, + } + create-calculated-insight-input-example: + value: + { + "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", + } + create-calculated-insight-output-example: + value: + { + "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", + } + update-calculated-insight-input-example: + value: + { + "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", + } + update-calculated-insight-output-example: + value: + { + "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", + } + # connections + update-mc-connection-request: + value: + { + "connectorType": "SalesforceMarketingCloud", + "addIngestionBusinessUnits": ["524002279"], + "removeIngestionBusinessUnits": ["524002280"], + "addActivationBusinessUnits": ["524002279"], + "removeActivationBusinessUnits": ["524002280"], + "addBusinessUnitsToDataSpaces": [{ "dataspaceName": "default", "mid": "524000406" }], + "removeBusinessUnitsToDataSpaces": + [{ "dataspaceName": "dataspace1", "mid": "524004881" }], + "createProfileBuMappings": "true", + } + update-mc-connection-response: + value: + { + "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", + } + get-connection-response-example: + value: + { + "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", + } + get-salesforcemarketingcloud-connection-response-example: + value: + { + "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, + } + get-salesforcedotcom-connections-response-example: + value: + { + "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, + } + get-database-schemas-request: + value: { "advancedAttributes": { "databaseName": "testdb" } } + get-database-schemas-response: + value: { "schemas": ["testSchema", "testSchema2"] } + get-databases-response: + value: { "databases": ["main", "samples", "hive_metadata"] } + test-connection-request: + value: + { + "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" }], + }, + }, + } + get-data-preview-request: + value: { "advancedAttributes": {}, "fields": ["Id", "column_boolean"], "limit": 100 } + get-data-preview-response: + value: + { + "advancedAttributes": {}, + "records": + [ + { "record": { "Id": 1, "column_boolean": true } }, + { "record": { "Id": 2, "column_boolean": false } }, + ], + } + get-data-extension-connection-fields-request: + value: + { + "advancedAttributes": {}, + "filters": + { + "filtersByProperty": + [ + { + "name": "subType", + "filterOperator": "EqualsOp", + "values": ["SalesforceMarketingCloudDataExtension"], + }, + { "name": "mid", "filterOperator": "EqualsOp", "values": ["524000862"] }, + ], + }, + } + get-bundle-stream-connection-fields-request: + value: + { + "advancedAttributes": {}, + "filters": + { + "filtersByProperty": + [ + { + "name": "subType", + "filterOperator": "EqualsOp", + "values": ["SalesforceMarketingCloudStandard"], + }, + { "name": "mid", "filterOperator": "EqualsOp", "values": ["524000862"] }, + ], + }, + } + get-connection-fields-response: + value: + { + "advancedAttributes": {}, + "fields": + [ + { + "name": "Id", + "originalType": "TEXT", + "type": "Text", + "isRequired": false, + "label": "Id", + "creationType": "Standard", + "isCalculatedField": false, + }, + ], + "incrementalExtractAttributes": {}, + "primaryKeys": ["Id"], + } + post-connection-fields-request-example: + value: { "advancedAttributes": { "database": "dev", "schema": "byol" } } + collection-of-fields-response-example: + value: + { + "advancedAttributes": {}, + "fields": + [ + { "name": "order_id", "originalType": "varchar", "type": "Text" }, + { + "format": "MM/dd/yyyy HH:mm:ss.SSS", + "name": "order_time", + "originalType": "timestamp", + "type": "DateTime", + }, + { "name": "order_verified", "originalType": "bool", "type": "Boolean" }, + { "name": "order_discount", "originalType": "numeric", "type": "Number" }, + ], + "incrementalExtractAttributes": {}, + "primaryKeys": [], + } + csv-file-fields-response-example: + value: + { + "advancedAttributes": + { + "fileName": "test.csv", + "importDirectory": "012ab34567cdefghij/[timestamp subpath]/", + "fileType": "CSV", + "driveLibraryId": "fileUploads$dc_file_upload", + "parentDirectory": "/", + }, + "fields": [], + "incrementalExtractAttributes": {}, + "primaryKeys": [], + } + post-connection-preview-request-example: + value: + { + "advancedAttributes": { "database": "dev", "schema": "public" }, + "fields": { "string_col": "", "date_col": "" }, + } + response-with-field-data-example: + value: + { + "advancedAttributes": { "database": "dev", "schema": "public" }, + "records": [{ "record": { "string_col": "Test String", "date_col": "01/01/2020" } }], + } + csv-file-preview-response-example: + value: + { + "advancedAttributes": + { + "fileName": "test.csv", + "importDirectory": "012ab34567cdefghij/[timestamp subpath]/", + "fileType": "CSV", + "driveLibraryId": "fileUploads$dc_file_upload", + "parentDirectory": "/", + }, + "records": [], + } + connection-schema-output-example: + value: + { + "schemas": + [ + { + "label": "schemaName", + "name": "schemaName", + "schemaType": "StreamingApp", + "fields": + [ + { "name": "schemaFieldOne", "label": "schemaFieldOne", "dataType": "Number" }, + { "name": "schemaFieldTwo", "label": "schemaFieldTwo", "dataType": "Text" }, + ], + }, + ], + } + put-connection-schema-input-example: + value: + { + "schemas": + [ + { + "label": "schemaName", + "name": "schemaName", + "schemaType": "StreamingApp", + "fields": + [ + { "name": "schemaFieldOne", "label": "schemaFieldOne", "dataType": "Number" }, + { "name": "schemaFieldTwo", "label": "schemaFieldTwo", "dataType": "Text" }, + ], + }, + ], + } + connection-sitemap-output-example: + value: + { + "sitemap": "Contents of the sitemap file", + "sitemapPath": "A string with a URL of the sitemap", + } + put-connection-sitemap-input-example: + value: { "sitemap": "Contents of the sitemap file" } + get-data-extensions-connection-objects-request: + value: + { + "filters": + { + "filtersByProperty": + [ + { + "name": "subType", + "filterOperator": "EqualsOp", + "values": ["SalesforceMarketingCloudDataExtension"], + }, + { "name": "name", "filterOperator": "LikeOp", "values": ["API_Test"] }, + { "name": "mid", "filterOperator": "EqualsOp", "values": ["524000862"] }, + ], + }, + } + get-bundle-streams-connection-objects-request: + value: + { + "filters": + { + "filtersByProperty": + [ + { + "name": "subType", + "filterOperator": "EqualsOp", + "values": ["SalesforceMarketingCloudStandard"], + }, + { "filterOperator": "EqualsOp", "values": ["524000862"] }, + ], + }, + } + get-connection-objects-response: + value: + { + "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" }, + }, + ], + } + get-data-extensions-connection-objects-response: + value: + { + "objects": + [ + { + "customObjectId": "fb4605de-2e67-f011-a5e1-5cba2c7596a8", + "description": "ENGA_DE_TEST1", + "name": "ENGA_DE_TEST2", + }, + ], + } + get-bundle-streams-connection-objects-response: + value: + { + "objects": + [ + { "bundleName": "MOBILE_CONNECT", "name": "ContactPointPhone" }, + { "bundleName": "MOBILE_CONNECT", "name": "SmsMt" }, + ], + } + get-connector-info-list-response: + value: + { + "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" }, + ], + }, + ], + } + get-connector-info-response: + value: + { + "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", + }, + } + # data action targets + get-data-action-targets-response-example: + value: + { + "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, + } + create-webHook-data-action-target-request-example: + value: + { + "type": "WebHook", + "label": "webhook_from_api", + "apiName": "webhook_from_api", + "config": + { "targetEndpoint": "https://webhook.site/4a6d3817-2aab-4926-a92a-26814205b046" }, + } + create-core-data-action-target-request-example: + value: + { + "type": "Core", + "label": "My core data action target", + "apiName": "my_core_data_action_target", + "config": { "orgLabel": "MyCompany Org", "orgId": "00DX2000001ZUi5" }, + } + webHook-data-action-target-response-example: + value: + { + "apiName": "webhook_from_api", + "config": + { "targetEndpoint": "https://webhook.site/4a6d3816-2aab-4126-a92a-26814205b046" }, + "label": "webhook_from_api", + "status": "PROCESSING", + "type": "WEBHOOK", + } + core-data-action-target-response-example: + value: + { + "apiName": "my_core_data_action_target", + "config": { "label": "MyCompany Org", "orgId": "00DX2000001ZUi5" }, + "label": "My core data action target", + "status": "PROCESSING", + "type": "CORE", + } + create-mc-data-action-target-request-example: + value: + { + "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", + }, + } + create-signing-key-response-example: + value: + { + "signingAlgorithm": "HMACSHA256", + "signingKey": "b+uouYjFtl6+1kLH3EVl+Pitm64fl5gO6TREnWltEBzfqjTk5vARLumZ7BR6hWirNawxhz5s+Mv3SzyETNBxPg==", + } + # data actions + get-data-actions-response-example: + value: + { + "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, + } + create-data-action-request-example: + value: + { + "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": [], + } + create-data-action-response-example: + value: + { + "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, + } + # clean rooms + collaborations-output-example: + value: + { + "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, + } + create-collaboration-input-example: + value: + { + "label": "collab21", + "providerDevName": "X00Dxx00nZbkbQyW_TestProviderName1746172733791", + "templateVersionId": "00Dxx00nZbkbBjk8ef", + "templateName": "OVERLAP", + "specificationDevName": "X00Dxx00MhXCjA7M_null1746504015424", + "dataCloudOrgId": "00Dxx00nZbkbQgmEIE", + } + collaboration-output-example: + value: + { + "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", + }, + }, + } + accept-collaboration-invitation-input-example: + value: { "invitationId": "1TOxx0000004D3UGAU", "specificationId": "1TIxx0000004CIiGAM" } + accept-collaboration-invitation-snowflake-input-example: + value: + { + "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" + } + } + } + accept-collaboration-invitation-aws-s3-input-example: + value: + { + "invitationId": "1TOxx0000004CQoGAM", + "specificationId": "1TIxx0000004CH6GAM", + "outputConfiguration": { + "outputDestinationType": "EXTERNAL_CONNECTOR", + "externalId": "ext12345678", + "connectionAttributes": { + "connectorType": "CleanroomAwsS3", + "roleArn": "string", + "s3Url": "string" + } + } + } + accept-collaboration-invitation-output-example: + value: + { + "invitationId": "1TOxx0000004D3UGAU", + "invitationStatus": "ACCEPT_INITIATED", + "memberId": "1TPSB0000000WuL4AU", + "memberOrgId": "00DSB00000eLeZh2AK", + "memberStatus": "ACTIVE", + "memberType": "PROVIDER", + "providerId": "1TQSB00000rVBtV4AW", + } + disable-collaboration-output-example: + value: + { + "name": "Example Data Clean Room", + "id": "DCR-001", + "description": "This is an example clean room for secure collaboration.", + "dataSpace": "ExampleDataSpace", + "status": "DISABLED" + } + reject-collaboration-invitation-input-example: + value: { "invitationId": "1TOxx0000004D3UGAU" } + reject-collaboration-invitation-output-example: + value: + { + "invitationId": "1TOxx0000004D3UGAU", + "invitationStatus": "REJECT_INITIATED", + "memberId": "1TPSB0000000WuL4AU", + "memberOrgId": "00DSB00000eLeZh2AK", + "memberStatus": "INACTIVE", + "memberType": "PROVIDER", + "providerId": "1TQSB00000rVBtV4AW", + } + run-AWS-flow-query-job-input-example: + value: { "queryExecutionName": "rawtalks1", "queryParameters": { "threshold_count": "4" } } + run-Native-flow-query-job-input-example: + value: + { "queryExecutionName": "queryJob2", "segmentIds": ["1sgRO00000000FB", "1sgRO00000000EI"] } + run-AWS-flow-query-job-output-example: + value: + { + "id": "a1fef7e9-cfdd-48b4-9d2a-c6e21d77fc58", + "label": "rawtalks1", + "segmentNames": [], + "status": "CREATED", + } + run-Native-flow-query-job-output-example: + value: + { + "id": "85dc54ca-f277-4851-b7fa-bdd1696cb0a9", + "label": "queryJob2", + "segmentNames": [], + "status": "CREATED", + } + data-clean-room-query-jobs-output-example: + value: + { + "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", + }, + ], + } + clean-room-result-data-objects-output-example: + value: + { + "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" + } + ] + } + providers-output-example: + value: + { + "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, + } + AWS-provider-input-example: + value: + { + "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"], + }, + } + Extensible-provider-input-example: + value: + { + "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", + }, + } + Native-provider-input-example: + value: + { + "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", + }, + } + AWS-provider-output-example: + value: + { + "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"] }, + } + Extensible-provider-output-example: + value: + { + "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"] }, + } + Native-provider-output-example: + value: + { + "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"] }, + } + provider-output-example: + value: + { + "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"] }, + } + specifications-output-example: + value: + { + "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, + } + specification-input-example: + value: + { + "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", + } + specification-output-example: + value: + { + "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", + }, + } + templates-output-example: + value: + { + "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, + } + get-template-collaborations-response-example: + value: + { + "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" + } + } + ] + } + } + ] + } + } + } + test-clean-room-connection-input-example: + value: + { + "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" + } + } + test-clean-room-connection-success-output-example: + value: + { + "success": true, + "message": "Connection test successful" + } + test-clean-room-connection-fail-output-example: + value: + { + "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" + } + } + # data graphs + create-data-graph-input-example: + value: + { + "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": [] + } + } + get-data-graph-by-lookup-output-example: + value: + { + "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-data-graph-by-id-output-example: + value: + { + "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-data-graph-metadata-output-example: + value: + { + "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", + } + activate-data-graph-input-example: + value: + { + "dataGraphName": "MyDataGraph", + "fullRefreshConfig": { + "schedule": { + "frequency": 1, + "timeGranularity": "Day" + } + } + } + # data kits + get-data-kits-output: + value: + { + "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" + } + ] + } + ] + } + create-data-kit-input: + value: + { + "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" + } + ] + } + } + ] + } + create-data-kit-output: + value: + { + "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" + } + get-available-components-output: + value: + { + "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" + } + ] + } + update-data-kit-input: + value: + { + "components": [ + { + "type": "DataLakeObject", + "info": { + "name": "Opportunity_Home__dll", + "label": "Opportunity_Home" + } + } + ] + } + update-data-kit-output: + value: + { + "components": [ + { + "info": { + "label": "Opportunity_Home", + "name": "Opportunity_Home__dll" + }, + "type": "DataLakeObject" + } + ], + "devName": "NewDataKit", + "label": "New Data Kit From API" + } + deploy-crm-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "CRM", + "bundleName": "BundleName", + "forceNoRefresh": true, + "bundleConfig": { + "orgId": "org123" + } + } + } + ] + } + deploy-ingestion-api-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "INGESTAPI", + "bundleName": "IngestionDataStreams", + "bundleConfig": { + "connectorName": "NewIngestionConnector" + } + } + } + ] + } + deploy-connector-framework-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "MORECONNECTORS", + "bundleName": "BundleName", + "forceNoRefresh": true, + "bundleConfig": { + "connectionName": "connectionName" + } + } + } + ] + } + deploy-streaming-app-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "STREAMINGAPP", + "bundleName": "BundleName", + "forceNoRefresh": true, + "bundleConfig": { + "connectorName": "connectorName", + "streamingAppDataConnectorType" : "MobileApp" + } + } + } + ] + } + deploy-b2c-commerce-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "COMMERCE", + "bundleName": "commercebundle1", + "bundleConfig": { + "instanceId": "bjmp_prd" + } + } + } + ] + } + deploy-byol-bundle-data-kit-input: + value: + { + "components": [ + { + "type": "DataStreamBundle", + "config": { + "connectorType": "EXTERNAL", + "bundleName": "testsnowflake", + "bundleConfig": { + "connectionName": "testsnowflake" + } + } + } + ] + } + deploy-dlo-data-kit-input: + value: + { + "components": [ + { + "type": "DataLakeObject", + "config": { + "dataSourceObjectDevName": "Namespace__DLOname", + "apiName": "hello", + "label": "lab", + "dataSpaceName": "default" + } + } + ] + } + deploy-calculated-insight-data-kit-input: + value: + { + "components": [ + { + "type": "CalculatedInsight", + "config": { + "apiName": "Namespace__testCI", + "apiNameOverride": "CiTest1", + "label": "CiTest1", + "publishInterval":"NotScheduled" + } + } + ] + } + deploy-batch-data-transform-data-kit-input: + value: + { + "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" + } + ] + } + } + ] + } + data-kit-manifest-output: + value: + { + "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" + ] + } + ] + } + undeploy-data-kit-component-input-example: + value: + { + "components": + [ + { "type": "DataTransform", "name": "testDk__managed_stream_transform" }, + { "type": "DataLakeObject", "name": "testDk__managed_dlo" }, + ], + } + data-kit-async-output-example: + value: { "jobId": "08PVF000000fHhd" } + get-data-kit-component-dependencies-output-example: + value: + { + "componentDependencies": + [{ "id": "0gOVF000000UfTxYAK", "name": "managed_dlo", "type": "DataLakeObject" }], + } + get-data-kit-component-status-output-example: + value: + { + "componentDetails": + [ + { + "componentId": "0gOVF000000UfTxYAK", + "dataKitName": "testDk__manageDk", + "status": "Active", + }, + ], + "status": { "code": "ACTIVE", "message": "The Status of the component is ACTIVE" }, + } + # data lake objects + get-DLOs-output-example: + value: + { + "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", + }, + ], + } + create-DLO-input-example: + value: + { + "name": "DataLakeObjectTwo", + "label": "DataLakeObjectTwo", + "category": "Profile", + "dataspaceInfo": + [ + { + "name": "default", + "filter": + { + "conjunctiveOperator": "OrOperator", + "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", + }, + ], + } + DLO-output-example: + value: + { + "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", + }, + "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", + } + update-DLO-input-example: + value: + { + "label": "DataLakeObjectTWO", + "dataLakeFieldInputRepresentations": + [ + { + "name": "FieldFour", + "label": "FieldFour", + "dataType": "Text", + "isPrimaryKey": "false", + }, + ], + } + # data model objects + get-DMOs-output-example: + value: + { + "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", + }, + ], + } + get-DMO-mapping-output-example: + value: + { + "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", + } + get-DMO-output-example: + value: + { + "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", + } + patch-DMO-mapping-input-example: + value: + { + "sourceEntityDeveloperName": "StaticCurrencyRates_Home__dll", + "targetEntityDeveloperName": "StaticCurrencyRates_Home__dlm", + "fieldMapping": + [ + { + "sourceFieldDeveloperName": "InternalOrganization__c", + "targetFieldDeveloperName": "InternalOrganizationId__c", + }, + ], + } + patch-DMO-mapping-output-example: + value: + { + "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", + } + patch-DMO-input-example: + value: + { + "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", + }, + ], + } + patch-DMO-output-example: + value: + { + "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", + } + post-DMO-mapping-input-example: + value: + { + "sourceEntityDeveloperName": "test1__dll", + "targetEntityDeveloperName": "ssot__AcademicYear__dlm", + "fieldMapping": + [ + { + "sourceFieldDeveloperName": "eventinstanceid__c", + "targetFieldDeveloperName": "ssot__Id__c", + }, + { + "sourceFieldDeveloperName": "EmailAddress__c", + "targetFieldDeveloperName": "ssot__Name__c", + }, + ], + } + post-DMO-mapping-output-example: + value: + { + "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", + } + post-DMO-input-example: + value: + { + "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", + }, + ], + } + post-DMO-output-example: + value: + { + "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", + } + get-DMO-mappings-output-example: + value: + { + "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", + }, + ], + } + all-dmo-relationships-output-example: + value: + { + "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, + } + create-dmo-relationships-input-example: + value: + { + "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", + }, + ], + } + # data spaces + get-all-data-spaces-output-example: + value: + { + "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, + } + create-data-space-input-example: + value: { "label": "nonDefault", "prefix": "ndf", "description": "Custom data space." } + create-data-space-output-example: + value: + { + "description": "Custom data space.", + "id": "0vhSB000001bqwjYAA", + "label": "nonDefault", + "name": "nonDefault", + "prefix": "ndf", + "status": "Active", + } + get-data-space-output-example: + value: + { + "description": "Custom data space.", + "id": "0vhSB000001bqwjYAA", + "label": "nonDefault", + "name": "nonDefault", + "prefix": "ndf", + "status": "Active", + } + update-data-space-input-example: + value: { "label": "nonDefault", "description": "Custom data space." } + update-data-space-output-example: + value: + { + "description": "Custom data space.", + "id": "0vhSB000001bqwjYAA", + "label": "nonDefault", + "name": "nonDefault", + "prefix": "ndf", + "status": "Active", + } + get-data-space-members-output-example: + value: + { + "currentPageUrl": "", + "totalSize": 1, + "members": + [ + { + "memberName": "DeveloperName1__dll", + "status": "ACTIVE", + "filter": + { + "conjunctiveOperator": "OrOperator", + "conditions": + [ + { + "fieldName": "Field__c", + "filterValue": "test", + "operator": "EqualsOperator", + "tableName": "DeveloperName__dll", + }, + ], + }, + }, + ], + } + upsert-data-space-members-input-example: + value: + { + "members": + { + "members": + [ + { + "memberName": "DeveloperName1__dll", + "filter": + { + "conjunctiveOperator": "OrOperator", + "conditions": + { + "conditions": + [ + { + "fieldName": "Field__c", + "filterValue": "test", + "operator": "EqualsOperator", + "tableName": "DeveloperName__dll", + }, + ], + }, + }, + }, + ], + }, + } + upsert-data-space-members-output-example: + value: + { + "dataSpaceMembers": + { + "members": + [ + { + "memberName": "DeveloperName1__dll", + "status": "PROCESSING", + "filter": + { + "conjunctiveOperator": "OrOperator", + "conditions": + [ + { + "fieldName": "Field__c__c", + "filterValue": "test", + "operator": "EqualsOperator", + "tableName": "DeveloperName__dll", + }, + ], + }, + }, + ], + }, + "errors": [], + "success": "true", + } + get-data-space-member-output-example: + value: { "memberName": "DeveloperName1__dll", "status": "ACTIVE" } + # data streams + get-sfdc-data-streams-output-example: + value: + { + "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, + } + get-mc-data-streams-output-example: + value: + { + "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", + }, + "label": "default", + "name": "default", + }, + { + "filter": + { + "conditions": + [ + { + "fieldName": "InternalOrganization__c", + "filterValue": "524000862", + "operator": "InOperator", + "tableName": "sfmc_campaign_524000862__dll", + }, + ], + "conjunctiveOperator": "NoneOperator", + }, + "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, + } + get-data-stream-output-example: + value: + { + "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", + } + create-s3-data-stream-request-example: + value: + { + "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, + }, + } + create-s3-data-stream-from-existing-DLO-request-example: + value: + { + "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, + }, + } + create-s3-data-stream-with-org-currency-request-example: + value: + { + "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" }, + } + create-full-refresh-data-stream-request: + value: + { + "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" }, + ], + } + create-incremental-datetime-data-stream-request: + value: + { + "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", + }, + ], + } + create-incremental-numeric-data-stream-request: + value: + { + "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", + }, + ], + } + create-bundle-data-stream-request: + value: + { + "name": "name", + "label": "label", + "refreshConfig": {}, + "connectorInfo": + { + "connectorType": "SalesforceMarketingCloud", + "connectorDetails": + { + "subType": "SalesforceMarketingCloudStandard", + "eid": "524000862", + "mid": "524000862", + "sourceObjectName": "EinsteinEmailEngagementScoring", + }, + }, + "advancedAttributes": {}, + "sourceFields": [], + "dataLakeObjectInfo": {}, + "mappings": [], + } + create-snowflake-data-stream-request: + value: + { + "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" + } + create-s3-data-stream-response-example: + value: + { + "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", + } + create-s3-data-stream-from-existing-DLO-response-example: + value: + { + "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", + } + create-s3-data-stream-with-org-currency-response-example: + value: + { + "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", + } + update-s3-data-stream-request-example: + value: + { + "datastreamType": "CONNECTORSFRAMEWORK", + "label": "updatedLabel", + "refreshConfig": + { + "refreshMode": "TOTAL_REPLACE", + "frequency": + { "frequencyType": "WEEKLY", "refreshDayOfWeek": "Monday", "hours": [8] }, + }, + "advancedAttributes": + { + "fileName": "*.csv", + "importDirectory": "divyy", + "isMissingFileFailure": false, + "areHeadersIncludedInFile": true, + }, + } + update-BYOL-data-stream-request-example: + value: + { + "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" }, + } + update-data-stream-source-field-request-example: + value: + { + "sourceFields": [{ "dataType": "Text", "name": "NewField" }], + "mappings": + [ + { + "sourceFieldLabel": "NewField", + "targetFieldName": "NewField", + "targetFieldReturntype": "Text", + }, + ], + } + update-data-stream-formula-field-request-example: + value: + { + "sourceFields": + [ + { "dataType": "Text", "name": "first name" }, + { "dataType": "Text", "name": "last name" }, + ], + "mappings": + [ + { + "transformationFormula": "CONCAT(sourceField['first name']", + "targetFieldName": "full_name", + "targetFieldReturntype": "TEXT", + }, + ], + } + update-s3-data-stream-response-example: + value: + { + "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", + } + update-BYOL-data-stream-response-example: + value: + { + "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", + } + # data transforms + get-data-transforms-output-example: + value: + { + "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, + } + create-batch-data-transform-request-example: + value: + { + "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", + } + create-streaming-data-transform-request-example: + value: + { + "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", + } + create-data-transform-response-example: + value: + { + "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", + } + get-data-transform-run-history-output-example: + value: + { + "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, + } + validate-data-transforms-input-example: + value: + { + "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", + }, + } + validate-data-transforms-output-example: + value: + { + "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": [], + } + # document processing + detect-schema-input-example: + value: + { + "schemaConfigurations": [ + "Invoice_Schema_v1", + "Receipt_Schema_v2" + ], + "mlModel": "llmgateway__VertexAIGemini25Flash001", + "files": [ + { + "data": "", + "mimeType": "application/pdf" + } + ], + "mode": "Single" + } + detect-schema-multi-input-example: + value: + { + "schemaConfigurations": [ + "Bank_Statement_Schema_v1", + "Pay_Stub_Schema_v2", + "Tax_Form_W2_Schema_v1" + ], + "mlModel": "llmgateway__VertexAIGemini25Flash001", + "files": [ + { + "data": "", + "mimeType": "application/pdf" + } + ], + "mode": "Multi" + } + detect-schema-output-example: + value: + { + "data": [ + { + "schemaConfiguration": "Invoice_Schema_v1", + "matchingScore": 0.95, + "totalFieldsInSchema": 25, + "matchingFieldsInSchema": 24 + } + ] + } + detect-schema-multi-output-example: + value: + { + "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 + } + ] + } + ] + } + extract-data-request-with-base64-example: + value: + { + "idpConfigurationIdOrName": "example_config_ver1", + "files": [{ "mimeType": "image/png", "data": "base64" }], + } + extract-data-request-with-base64-schema-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "mimeType": "image/png", "data": "base64" }], + "schemaConfig": "{}", + } + extract-data-request-with-content-document-example: + value: + { + "idpConfigurationIdOrName": "example_config_ver1", + "files": [{ "fileId": "068xxxxxxxxxxxxxxx" }], + } + extract-data-request-with-content-document-schema-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "fileId": "068xxxxxxxxxxxxxxx" }], + "schemaConfig": "{}", + } + extract-data-request-with-sfdrive-example: + value: + { + "idpConfigurationIdOrName": "example_config_ver1", + "files": [{ "fileId": "sfdrive://$dc_file_upload$/path-to-file" }], + } + extract-data-request-with-sfdrive-schema-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "fileId": "sfdrive://$dc_file_upload$/path-to-file" }], + "schemaConfig": "{}", + } + extract-data-request-with-schema-config-example: + value: + { + "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"] + } + } + } + } + } + extract-data-output-example: + value: + { + "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, + }, + ], + } + generate-schema-request-with-base64-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "mimeType": "image/png", "data": "base64" }], + } + generate-schema-request-with-content-document-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "fileId": "068xxxxxxxxxxxxxxx" }], + } + generate-schema-request-with-sfdrive-example: + value: + { + "mlModel": "llmgateway__OpenAIGPT4Omni_08_06", + "files": [{ "fileId": "sfdrive://$dc_file_upload$/path-to-file" }], + } + generate-schema-output-example: + value: + { + "error": null, + "schema": '{"schema":{"type":"object","properties":{"invoiceNumber":{"type":"string"},"date":{"type":"string","format":"date"},"amount":{"type":"number"},"vendor":{"type":"string"}}}}', + } + get-all-document-ai-configurations-output-example: + value: + { + "currentPageUrl": "/services/data/v63.0/ssot/document-processing?limit=25&offset=0", + "nextPageUrl": null, + "configurations": + [ + { + "id": "1Ofxx0000004C92CAE", + "label": "Document AI Config 1", + "name": "Document AI_Config_1", + "url": "/services/data/v63.0/ssot/document-processing/1Ofxx0000004C92CAE", + }, + ], + "totalSize": 1, + } + create-document-ai-configuration-input-example: + value: + { + "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", + }, + }, + }, + }, + } + document-ai-configuration-output-example: + value: + { + "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-document-ai-configuration-output-example: + value: + { + "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", + } + update-document-ai-configuration-input-example: + value: + { + "label": "My Document AI Config (updated)", + "description": "Some description (updated)", + "activationStatus": "ACTIVATED", + } + get-document-ai-global-configuration-output-example: + value: + { + "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", + } + # identity resolutions + get-identity-resolutions-output-example: + value: + { + "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.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.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": [], + }, + ], + }, + ], + } + get-identity-resolution-output-example: + value: + { + "anonymousUnifiedProfiles": 0, + "configurationType": "individual", + "consolidationRate": 0.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, + } + create-identity-resolution-input-example: + value: + { + "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" }, + ], + } + create-identity-resolution-output-example: + value: + { + "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, + } + update-identity-resolution-input-example: + value: + { + "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": [], + }, + ], + } + update-identity-resolution-output-example: + value: + { + "anonymousUnifiedProfiles": 0, + "configurationType": "individual", + "consolidationRate": 0.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, + } + run-identity-resolution-input-example: + value: { "callingApp": "Flow", "callingAppInfo": "10" } + # insights + get-insight-metadata-output-example: + value: + { + "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-calculated-insight-metadata-output-example: + value: + { + "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" + } + ] + } + # machine learning + create-data-alert-input-example: + value: + { + "asset": "12l000000000000", + "assetType": "ModelArtifact", + "sourceTypes": ["ModelTraining"] + } + create-data-alert-output-example: + value: + { + "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", + } + ] + } + update-data-alert-input-example: + value: { "accepted": true } + update-data-alert-output-example: + value: + { + "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" + } + get-configured-model-collection-output-example: + value: + { + "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 + } + configured-model-output-example: + value: + { + "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" + } + get-jobs-output-example: + value: + { + "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 + } + get-job-output-example: + value: + { + "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" + } + get-tasks-output-example: + value: + { + "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" + } + ] + } + get-task-output-example: + value: + { + "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" + } + get-model-artifact-collection-output-example: + value: + { + "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.0, + "minValue": 0.0, + "overridable": true, + "parameterName": "temperature", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "description": "The maximum number of tokens to generate in the completion.", + "maxValue": 4096.0, + "minValue": 1.0, + "overridable": true, + "parameterName": "max_tokens", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "overridable": true, + "parameterName": "frequency_penalty", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "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.0, + "minValue": 0.0, + "overridable": true, + "parameterName": "temperature", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "description": "The maximum number of tokens to generate in the completion.", + "maxValue": 16384.0, + "minValue": 1.0, + "overridable": true, + "parameterName": "max_tokens", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "overridable": true, + "parameterName": "frequency_penalty", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "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 + } + model-artifact-output-example: + value: + { + "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.0, + "minValue": 0.0, + "overridable": true, + "parameterName": "temperature", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "description": "The maximum number of tokens to generate in the completion.", + "maxValue": 4096.0, + "minValue": 1.0, + "overridable": true, + "parameterName": "max_tokens", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "overridable": true, + "parameterName": "frequency_penalty", + "type": "Continuous" + }, + { + "applicableCapabilities": ["ChatCompletion"], + "defaultValue": 0.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.0, + "minValue": -2.0, + "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" + } + update-model-artifact-input-example: + value: { "label": "", "description": "", "status": "Disabled" } + get-prediction-input-example: + value: + { + "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 } + } + maxTopFactors-output-example: + value: + { + "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 + } + } + binary-classification-output-example: + value: + { + "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 + } + } + model-setup-versions-output-example: + value: + { + "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 + } + ] + } + model-setup-version-output-example: + value: + { + "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 + } + post-model-setup-version-input-example: + value: + { + "description": "Initial version of the Customer Churn Prediction model setup.", + "type": "EdcNoCode" + } + model-setup-version-partitions-output-example: + value: + { + "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" + } + model-setup-version-partition-output-example: + value: + { + "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" + } + customsql-create-configuration-request: + value: { + "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" + } + } + } + customsql-create-retriever-request: + value: { + "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" + } + } + } + } + customsql-get-create-update-configuration-response: + value: { + "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 + } + customsql-get-create-update-retriever-response: + value: { + "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" + } + ensemble-create-configuration-request: + value: { + "queryType": "Ensemble", + "numberOfResults": 5, + "retrievalMode": "Basic", + "referencedRetrievers": [ + { + "name": "File_UDMO_retriever_1Cx_tGW8e28c6ed" + }, + { + "id": "1Cxxx0000004CFUCA2" + } + ], + "outputFields": [ + "Chunk", + "Article Number" + ], + "isCitationEnabled": true + } + ensemble-create-retriever-request: + value: { + "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 + } + } + ensemble-get-create-update-configuration-response: + value: { + "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 + } + ensemble-get-create-update-retriever-response: + value: { + "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" + } + get-configurations-response: + value: { + "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 + } + get-retrievers-response: + value: { + "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 + } + nocode-create-configuration-request: + value: { + "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 + } + nocode-create-retriever-request: + value: { + "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 + } + } + nocode-get-create-update-configuration-response: + value: { + "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 + } + nocode-get-create-update-retriever-response: + value: { + "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" + } + review-retriever-request: + value: { + "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" + } + } + review-retriever-response: + value: { + "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 + } + update-retriever-configuration-request: + value: { + "isActive": true + } + update-retriever-request: + value: { + "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." + } + get-prediction-jobs-output-example: + value: + { + "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" + } + prediction-job-def-post-binary-request-example: + value: + { + "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 + } + } + prediction-job-def-post-clustering-request-example: + value: + { + "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 + } + } + prediction-job-def-post-multiclass-request-example: + value: + { + "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 + } + ] + } + } + prediction-job-def-post-sentiment-request-example: + value: + { + "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 + } + ] + } + } + prediction-job-def-post-topic-request-example: + value: + { + "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"] + } + } + } + prediction-job-def-patch-request-example: + value: + { + "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" + } + prediction-job-def-binary-response-example: + value: + { + "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": "" + } + prediction-job-def-clustering-response-example: + value: + { + "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": "" + } + prediction-job-def-multiclass-response-example: + value: + { + "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": "" + } + prediction-job-def-sentiment-response-example: + value: + { + "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": "" + } + prediction-job-def-topic-response-example: + value: + { + "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": "" + } + # metadata + get-metadata-output-example: + value: + { + "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-metadata-entities-response: + value: + { + "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" + } + ] + } + # profile + get-profile-metadata-output-example: + value: + { + "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-profile-metadata-dmo-output-example: + value: + { + "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-profile-query-dmo-output-example: + value: + { + "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": {}, + } + # query v1 & v2 + query-data-input-example: + value: + { + "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'", + } + # query v3 + create-query-request-simple-example: + value: { "sql": "select * from Flight__dll", "rowLimit": 2 } + create-query-request-parameters-example: + value: + { + "sql": 'select * from FlightSeat__dll where "boardingstatus__c"=:myparam', + "rowLimit": 2, + "sqlParameters": [ + { + "type": "varchar", + "name": "myparam", + "value": "Boarded" + } + ] + } + create-query-request-settings-example: + value: + { + "querySettings": { + "date_style": "MDY", + "lc_time": "en_US", + "query_timeout": "1800000ms" + }, + "sql": "SELECT * FROM Case_Home__dll LIMIT 10" + } + create-query-response-simple-example: + value: + { + "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.0, + "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.0, + "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.0, + "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2Fe1025a17-0ff7-bcb9-204c-656ec276b188", + "rowCount": 513, + }, + } + create-query-response-parameters-example: + value: + { + "data": + [ + [ + "DEMO_DATA_PILOT_TRAINING", + "Snowflake_BYOL", + null, + null, + "Boarded", + "2024-06-25T11:00:00+00:00", + "003SB0", + "AI202", + 2.0, + "12C", + "Business", + ], + [ + "DEMO_DATA_PILOT_TRAINING", + "Snowflake_BYOL", + null, + null, + "Boarded", + "2024-01-22T18:19:04+00:00", + "000061", + "AI652", + 14.0, + "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.0, + "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7", + "rowCount": 1288, + }, + } + get-query-status-response-example: + value: + { + "chunkCount": 1, + "completionStatus": "Finished", + "expirationTime": "seconds: 1738344542\n", + "progress": 1.0, + "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2F9c77528b-78b5-a08d-f443-c05dcb8305b7", + "rowCount": 1288, + } + get-query-rows-response-example: + value: + { + "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.0, + "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.0, + "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, + } + # search index + semantic-search-with-index-config-request-example: + value: + { + "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": [] + } + semantic-search-for-DMO-request-example: + value: + { + "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", + }, + ], + } + semantic-search-for-UDMO-request-example: + value: + { + "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", + }, + ], + } + get-semantic-response-example: + value: + { + "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, + } + get-search-index-configuration-response-example: + value: + { + "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-semantic-search-collection-output-example: + value: + { + "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, + } + get-hybrid-search-collection-output-example: + value: + { + "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, + } + hybrid-search-request-example: + value: + { + "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", + }, + } + semantic-search-output-example: + value: + { + "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, + } + get-hybrid-response-example: + value: + { + "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, + } + semantic-search-request-example: + value: + { + "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", + }, + ], + } + # segments + get-segments-output-example: + value: + { + "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, + } + create-daily-publish-segment-input-example: + value: + { + "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"] }, + }, + } + create-weekly-publish-segment-input-example: + value: + { + "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"] } }, + } + create-monthly-publish-segment-input-example: + value: + { + "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] } }, + } + create-daily-publish-segment-output-example: + value: + { + "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", + } + create-weekly-publish-segment-output-example: + value: + { + "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", + } + create-monthly-publish-segment-output-example: + value: + { + "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", + } + create-standard-segment-input-example: + value: + { + "developerName": "ConnectSegment20", + "displayName": "", + "description": "This is a connect API segment", + "segmentOnApiName": "", + "publishSchedule": "One", + "publishScheduleEndDate": "", + "publishScheduleStartDateTime": "", + "additionalMetadata": {}, + "lookalikeCriteria": {}, + "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", + } + create-daily-rapid-publish-segment-input-example: + value: + { + "description": "new_connectapi_refresh_Monthlyafterapex1", + "displayName": "new_connectapi_refresh_Monthlyafterapex1", + "segmentOnApiName": "ssot__Account__dlm", + "segmentType": "UI", + "publishScheduleStartDateTime": "2026-03-10T23:59:59.999Z", + "publishScheduleEndDateTime": "2026-03-20T23:59:59.999Z", + "publishScheduleInfo": + { + "interval": 12, + "frequency": "Weekly", + "daysOfWeek": { "daysOfWeek": ["Monday", "Tuesday", "Wednesday"] }, + "runFrom": { "hour": 9, "minute": 0, "timeZone": "UTC" }, + "runTo": { "hour": 13, "minute": 0, "timeZone": "UTC" }, + }, + } + create-segment-output-example: + value: + { + "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": "ONE", + "publishScheduleEndDate": "2025-04-02T00:00:00.000Z", + "publishScheduleStartDateTime": "2025-04-01T00:00:00.000Z", + "segmentOnApiName": "ind__dlm", + "segmentOnId": "0gjxx00000000eLAAQ", + "segmentStatus": "PROCESSING", + "segmentType": "DBT", + } + get-segment-output-example: + value: + { + "segments": + [ + { + "apiName": "TestSegment5", + "dataSpace": "default", + "description": "This is a connect API segment", + "displayName": "TestSegment5", + "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": "3HXxx0000004CH6GAM", + "marketSegmentId": "1sgxx0000000085AAA", + "publishInterval": "NO_REFRESH", + "segmentMembershipDmo": + { + "historyTable": "ind_SMH_1741713361451__dlm", + "latestTable": "ind_SM_1741713358904__dlm", + }, + "segmentOnApiName": "ind__dlm", + "segmentOnId": "0gjxx00000000eLAAQ", + "segmentStatus": "PROCESSING", + "segmentType": "DBT", + }, + ], + } + update-segment-input-example: + value: + { + "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", + } + update-segment-output-example: + value: + { + "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", + } + count-segment-input-example: + value: { "preferApproxCount": true } + count-segment-output-example: + value: { "errors": [{}], "segmentId": "1sgxx00000000MbAAI", "success": true } + deactivate-segment-output-example: + value: + { + "errors": [{}], + "segmentApiName": "TestFilter", + "segmentId": "1sgxx00000000UfAAI", + "success": true, + } + get-segment-members-output-example: + value: + { + "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, + } + publish-segment-output-example: + value: + { + "errors": [{}], + "jobId": "1f8f521f-0616-4bdf-a515-d95192475c95", + "partitionId": "1sgxx00000000Pp_6157146b-467e-4c61-a62e-bac2490ae6ce", + "publishStatus": "PUBLISHING", + "segmentId": "1sgxx00000000PpAAI", + "success": true, + } + # placeholder + example: + value: + { + "data": [{}], + "done": false, + "endTime": "", + "metadata": { "//": {} }, + "queryId": "", + "rowCount": 0, + "startTime": "", + } + clean-success: #basic error message + value: { "errors": [{ "errorCode": "", "message": "" }], "success": true } +tags: + - name: Activation Targets + description: | + 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` | + | [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}` | + + - name: Activations + description: | + 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` | + | [Get activation external platforms](https://developer.salesforce.com/docs/data/connectapi/references/spec#tag/Activations/paths/~1ssot~1activation-external-platforms/get) | `GET /ssot/activation-external-platforms` | + + - name: Calculated Insights + description: | + 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` | + + - name: Clean Rooms + description: | + 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` | + + - name: Connections + description: | + 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}` | + + - name: Connectors + description: | + 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}` | + + - name: Data Action Targets + description: | + 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` | + + - name: Data Actions + description: | + 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` | + + - name: Data Graphs + description: | + 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` | + + - name: Data Kits + description: | + 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` | + + - name: Data Lake Objects + description: | + 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}` | + + - name: Data Model Objects + description: | + 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` | + + - name: Data Spaces + description: | + 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 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}` | + + - name: Data Streams + description: | + 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` | + + - name: Data Transforms + description: | + 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` | + | [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` | + + - name: Document AI + description: | + 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` | + + - name: Identity Resolutions + description: | + 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` | + + - name: Insights + description: | + 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}` | + + - name: Machine Learning + description: | + 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}` | + + - name: Metadata + description: | + 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}` | + + - name: Private Network Routes + description: | + 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}` | + + - name: Profile + description: | + 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}` | + + - name: Query V1 & V2 + description: | + 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}` | + + - name: Query (Current) + description: | + 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` | + + - name: Search Index + description: | + 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}` | + + - name: Segments + description: | + 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` | + + - name: Universal ID Lookup + description: | + 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}` | diff --git a/public/specs/salesforce-data-360-ingestion.openapi.json b/public/specs/salesforce-data-360-ingestion.openapi.json new file mode 100644 index 00000000..6be80680 --- /dev/null +++ b/public/specs/salesforce-data-360-ingestion.openapi.json @@ -0,0 +1,382 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Salesforce Data 360 Ingestion API", + "version": "1.0.0", + "description": "Hand-written, source-mapped OpenAPI surface for Data 360 instance-host Ingestion API endpoints. The host is the instance_url returned by /services/a360/token, typically https://.c360a.salesforce.com. This spec intentionally covers the core streaming and bulk ingestion lifecycle only; it is safe registration scaffolding, not a claim of full vendor coverage.", + "x-sourceDocs": [ + "https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-ingestion-api.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-insert-records.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-records.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-create-a-job.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-all-jobs.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-get-job-info.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-upload-job-data.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-close-or-abort-a-job.html", + "https://developer.salesforce.com/docs/data/data-cloud-int/references/data-cloud-ingestionapi-ref/c360-a-api-delete-a-job.html" + ] + }, + "servers": [ + { + "url": "https://REPLACE-WITH-D360-INSTANCE-HOST.c360a.salesforce.com", + "description": "Data 360 instance host returned as instance_url from the a360 token exchange" + } + ], + "paths": { + "/api/v1/ingest/sources/{name}/{object-name}": { + "post": { + "operationId": "upsertRecords", + "summary": "Upsert streaming records", + "description": "Load new objects and update existing objects into a Data 360 data lake table using the streaming Ingestion API. Salesforce returns 202 Accepted and processes the data asynchronously.", + "tags": ["Streaming Ingestion"], + "parameters": [ + { "$ref": "#/components/parameters/IngestionConnectorName" }, + { "$ref": "#/components/parameters/IngestionObjectName" } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + ] + } + } + } + }, + "responses": { + "202": { "$ref": "#/components/responses/AcceptedAsync" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" } + } + }, + "delete": { + "operationId": "deleteRecords", + "summary": "Delete streaming records", + "description": "Delete up to 200 records from a data lake table using primary key IDs. For larger deletes, use the bulk ingestion job flow.", + "tags": ["Streaming Ingestion"], + "parameters": [ + { "$ref": "#/components/parameters/IngestionConnectorName" }, + { "$ref": "#/components/parameters/IngestionObjectName" }, + { + "name": "ids", + "in": "query", + "required": false, + "description": "Comma-delimited primary key IDs. IDs can also be supplied in the JSON request body.", + "schema": { "type": "string" } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { "type": "string" } + } + } + } + } + } + }, + "responses": { + "202": { "$ref": "#/components/responses/AcceptedAsync" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/ingest/jobs": { + "get": { + "operationId": "listJobs", + "summary": "Get all ingestion jobs", + "description": "Retrieves ingestion jobs, optionally filtered by state.", + "tags": ["Bulk Ingestion"], + "parameters": [ + { + "name": "limit", + "in": "query", + "required": false, + "description": "Number of records to return. Defaults to 20; maximum 100.", + "schema": { "type": "integer", "minimum": 1, "maximum": 100 } + }, + { + "name": "offset", + "in": "query", + "required": false, + "description": "Number of rows to skip before returning results.", + "schema": { "type": "integer", "minimum": 0 } + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "description": "Field used to order job results. Salesforce defaults to systemModstamp.", + "schema": { "type": "string" } + }, + { + "name": "states", + "in": "query", + "required": false, + "description": "Comma-delimited job states.", + "schema": { + "type": "string", + "example": "Open,UploadComplete,Failed,Aborted,JobComplete" + } + } + ], + "responses": { + "200": { + "description": "Job list", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/JobList" } + } + } + }, + "401": { "$ref": "#/components/responses/Error" } + } + }, + "post": { + "operationId": "createJob", + "summary": "Create a bulk ingestion job", + "description": "Creates a bulk ingestion job for upserting or deleting data. The job starts in Open state and can accept CSV uploads.", + "tags": ["Bulk Ingestion"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/CreateJobRequest" } + } + } + }, + "responses": { + "200": { + "description": "Created job", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Job" } + } + } + }, + "201": { + "description": "Created job", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Job" } + } + } + }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/ingest/jobs/{id}": { + "get": { + "operationId": "getJobInfo", + "summary": "Get ingestion job info", + "description": "Retrieves detailed information about a specified bulk ingestion job.", + "tags": ["Bulk Ingestion"], + "parameters": [{ "$ref": "#/components/parameters/JobId" }], + "responses": { + "200": { + "description": "Job information", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Job" } + } + } + }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + }, + "patch": { + "operationId": "closeOrAbortJob", + "summary": "Close or abort an ingestion job", + "description": "Update a job state to UploadComplete to close it, or Aborted to abort it. Closing a job enqueues uploaded data for processing.", + "tags": ["Bulk Ingestion"], + "parameters": [{ "$ref": "#/components/parameters/JobId" }], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["state"], + "properties": { + "state": { + "type": "string", + "enum": ["UploadComplete", "Aborted"] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Updated job", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Job" } + } + } + }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + }, + "delete": { + "operationId": "deleteJob", + "summary": "Delete an ingestion job", + "description": "Deletes job metadata and stored job data for jobs in terminal or upload-complete states.", + "tags": ["Bulk Ingestion"], + "parameters": [{ "$ref": "#/components/parameters/JobId" }], + "responses": { + "204": { "description": "Job deleted" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/ingest/jobs/{id}/batches": { + "put": { + "operationId": "uploadJobData", + "summary": "Upload CSV data for an ingestion job", + "description": "Uploads CSV data to a bulk ingestion job. A job can include up to 100 uploaded data files; close the job after uploads are complete.", + "tags": ["Bulk Ingestion"], + "parameters": [{ "$ref": "#/components/parameters/JobId" }], + "requestBody": { + "required": true, + "content": { + "text/csv": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "202": { "$ref": "#/components/responses/AcceptedAsync" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + } + }, + "components": { + "parameters": { + "IngestionConnectorName": { + "name": "name", + "in": "path", + "required": true, + "description": "Name of the Ingestion API data connector.", + "schema": { "type": "string" } + }, + "IngestionObjectName": { + "name": "object-name", + "in": "path", + "required": true, + "description": "Object name configured in the Ingestion API connector.", + "schema": { "type": "string" } + }, + "JobId": { + "name": "id", + "in": "path", + "required": true, + "description": "Bulk ingestion job ID.", + "schema": { "type": "string" } + } + }, + "schemas": { + "CreateJobRequest": { + "type": "object", + "required": ["object", "operation", "sourceName"], + "properties": { + "object": { + "type": "string", + "description": "Object type for the data being processed." + }, + "operation": { + "type": "string", + "enum": ["upsert", "delete"], + "description": "Processing operation for the job." + }, + "sourceName": { + "type": "string", + "description": "Name of the Ingestion API connector." + } + }, + "additionalProperties": true + }, + "Job": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "state": { + "type": "string", + "enum": ["Open", "UploadComplete", "InProgress", "JobComplete", "Failed", "Aborted"] + }, + "object": { "type": "string" }, + "operation": { "type": "string" }, + "sourceName": { "type": "string" }, + "createdDate": { "type": "string" }, + "systemModstamp": { "type": "string" } + }, + "additionalProperties": true + }, + "JobList": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { "$ref": "#/components/schemas/Job" } + }, + "done": { "type": "boolean" } + }, + "additionalProperties": true + }, + "Error": { + "type": "object", + "properties": { + "errorCode": { "type": "string" }, + "message": { "type": "string" } + }, + "additionalProperties": true + } + }, + "responses": { + "AcceptedAsync": { + "description": "Accepted for asynchronous processing" + }, + "Error": { + "description": "Salesforce error response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" } + } + } + } + } + } +} diff --git a/public/specs/salesforce-data-360-profile.openapi.json b/public/specs/salesforce-data-360-profile.openapi.json new file mode 100644 index 00000000..df0e56e3 --- /dev/null +++ b/public/specs/salesforce-data-360-profile.openapi.json @@ -0,0 +1,309 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Salesforce Data 360 Profile API", + "version": "1.0.0", + "description": "Hand-written, source-mapped OpenAPI surface for Data 360 instance-host Profile API endpoints. The host is the instance_url returned by /services/a360/token, typically https://.c360a.salesforce.com. This spec covers read/query profile operations documented in the Data 360 REST API reference.", + "x-sourceDocs": [ + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-call-overview.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-meta-dmname.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-child-dmname.html", + "https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/data-cloud-query-api-reference/c360a-api-profile-dmname-id-ci-ci-name.html" + ] + }, + "servers": [ + { + "url": "https://REPLACE-WITH-D360-INSTANCE-HOST.c360a.salesforce.com", + "description": "Data 360 instance host returned as instance_url from the a360 token exchange" + } + ], + "paths": { + "/api/v1/profile/metadata": { + "get": { + "operationId": "getProfileMetadata", + "summary": "Get metadata for all profiles", + "description": "Retrieves metadata for all accessible profile data model objects in a Data 360 instance.", + "tags": ["Profile Metadata"], + "responses": { + "200": { + "description": "Profile metadata list", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ProfileMetadataList" } + } + } + }, + "401": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/profile/metadata/{dataModelName}": { + "get": { + "operationId": "getProfileMetadataByDataModel", + "summary": "Get profile metadata for one data model", + "description": "Retrieves field, index, and relationship metadata for a specific profile data model object.", + "tags": ["Profile Metadata"], + "parameters": [{ "$ref": "#/components/parameters/DataModelName" }], + "responses": { + "200": { + "description": "Profile data model metadata", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ProfileMetadata" } + } + } + }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/profile/{dataModelName}": { + "get": { + "operationId": "getProfileData", + "summary": "Query profile data", + "description": "Queries profile data from a specific profile-category data model object using fields, filters, ordering, and pagination.", + "tags": ["Profile Data"], + "parameters": [ + { "$ref": "#/components/parameters/DataModelName" }, + { "$ref": "#/components/parameters/Fields" }, + { + "name": "filters", + "in": "query", + "required": false, + "description": "Filter criteria using AND equality syntax, for example [FirstName__c=John].", + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/Limit" }, + { "$ref": "#/components/parameters/Offset" }, + { "$ref": "#/components/parameters/OrderBy" } + ], + "responses": { + "200": { "$ref": "#/components/responses/ProfileDataResponse" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/profile/{dataModelName}/{Id}": { + "get": { + "operationId": "getProfileDataById", + "summary": "Get profile data by ID", + "description": "Retrieves a specific profile record by primary or secondary key lookup.", + "tags": ["Profile Data"], + "parameters": [ + { "$ref": "#/components/parameters/DataModelName" }, + { "$ref": "#/components/parameters/ProfileRecordId" }, + { "$ref": "#/components/parameters/Fields" }, + { + "name": "searchkey", + "in": "query", + "required": false, + "description": "Field to search by for secondary key lookup.", + "schema": { "type": "string" } + } + ], + "responses": { + "200": { "$ref": "#/components/responses/ProfileDataResponse" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}": { + "get": { + "operationId": "getProfileChildData", + "summary": "Get profile child data", + "description": "Retrieves child records related to a specific profile record through parent-child relationships.", + "tags": ["Profile Data"], + "parameters": [ + { "$ref": "#/components/parameters/DataModelName" }, + { "$ref": "#/components/parameters/ProfileRecordId" }, + { "$ref": "#/components/parameters/ChildDataModelName" }, + { "$ref": "#/components/parameters/Fields" }, + { "$ref": "#/components/parameters/Limit" }, + { "$ref": "#/components/parameters/Offset" }, + { "$ref": "#/components/parameters/OrderBy" }, + { + "name": "searchkey", + "in": "query", + "required": false, + "description": "Field to search by for related records.", + "schema": { "type": "string" } + } + ], + "responses": { + "200": { "$ref": "#/components/responses/ProfileDataResponse" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + }, + "/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}": { + "get": { + "operationId": "getProfileCalculatedInsightsData", + "summary": "Get profile calculated insights data", + "description": "Retrieves calculated insight attributes and metrics for a specific profile record.", + "tags": ["Profile Calculated Insights"], + "parameters": [ + { "$ref": "#/components/parameters/DataModelName" }, + { "$ref": "#/components/parameters/ProfileRecordId" }, + { + "name": "ci-name", + "in": "path", + "required": true, + "description": "Calculated insight API name.", + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/Fields" } + ], + "responses": { + "200": { "$ref": "#/components/responses/ProfileDataResponse" }, + "400": { "$ref": "#/components/responses/Error" }, + "401": { "$ref": "#/components/responses/Error" }, + "404": { "$ref": "#/components/responses/Error" } + } + } + } + }, + "components": { + "parameters": { + "DataModelName": { + "name": "dataModelName", + "in": "path", + "required": true, + "description": "Profile data model object API name, for example Individual__dlm.", + "schema": { "type": "string" } + }, + "ChildDataModelName": { + "name": "childDataModelName", + "in": "path", + "required": true, + "description": "Child data model object API name, for example ContactPointEmail__dlm.", + "schema": { "type": "string" } + }, + "ProfileRecordId": { + "name": "Id", + "in": "path", + "required": true, + "description": "Profile record ID or secondary key value.", + "schema": { "type": "string" } + }, + "Fields": { + "name": "fields", + "in": "query", + "required": false, + "description": "Comma-separated list of fields to include. Specify fields to retrieve more than 10 fields.", + "schema": { "type": "string" } + }, + "Limit": { + "name": "limit", + "in": "query", + "required": false, + "description": "Maximum records to return. Salesforce documents default 49,999 and response limit 4,999 for profile queries.", + "schema": { "type": "integer", "minimum": 1 } + }, + "Offset": { + "name": "offset", + "in": "query", + "required": false, + "description": "Rows to skip before returning results.", + "schema": { "type": "integer", "minimum": 0 } + }, + "OrderBy": { + "name": "orderby", + "in": "query", + "required": false, + "description": "Field to sort results by. Use - prefix for descending order.", + "schema": { "type": "string" } + } + }, + "schemas": { + "ProfileMetadata": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "displayName": { "type": "string" }, + "category": { "type": "string" }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "indexes": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + }, + "additionalProperties": true + }, + "ProfileMetadataList": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { "$ref": "#/components/schemas/ProfileMetadata" } + } + }, + "additionalProperties": true + }, + "ProfileData": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "done": { "type": "boolean" } + }, + "additionalProperties": true + }, + "Error": { + "type": "object", + "properties": { + "errorCode": { "type": "string" }, + "message": { "type": "string" } + }, + "additionalProperties": true + } + }, + "responses": { + "ProfileDataResponse": { + "description": "Profile records response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ProfileData" } + } + } + }, + "Error": { + "description": "Salesforce error response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Error" } + } + } + } + } + } +}