SPsphereon-opensource
ConnectorDataProducts

Create a connector data product descriptor

Creates or replaces a connector data product descriptor. The descriptor must reference an existing logical connection binding, matching physical connector instance, known dataset resource descriptors, at least one transfer type, and at least one catalog offer policy ref.

post/data/products

Request

Request body

Example request

{
  "descriptor": {
    "dataProductId": "dp-proof-status",
    "providerParty": {
      "partyId": "party-provider",
      "displayName": "Proof provider"
    },
    "physicalConnectorInstanceId": "8a7f09af-7ac9-4d96-91f9-a2a252f4aa4b",
    "logicalConnectionBindingId": "brand-a-proof-vault",
    "datasetResourceIds": [
      "41436f49-040c-4f5f-9c7f-657f43762e2b"
    ],
    "title": "Proof status product",
    "canonicalFieldScopes": [
      "proof.status"
    ],
    "distributionTransferTypes": [
      "HTTPS_PULL"
    ],
    "catalogOfferRefs": [
      {
        "offerId": "offer-proof-status",
        "policy": {
          "profileId": "dpv-odrl",
          "policyType": "OFFER",
          "policyUid": "policy-proof-status"
        }
      }
    ]
  }
}

Response

Connector data product descriptor created.

dataProductIdstring required

Stable identifier of a connector data product descriptor.

physicalConnectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

logicalConnectionBindingIdstring required

Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance.

datasetResourceIdsResourceDescriptorId[] required
titlestring required
descriptionstring
versionstring
canonicalFieldScopesstring[]
schemaRefsstring[]
freshnessstring
qualitystring
distributionTransferTypesstring[] required
residencystring
classificationstring
governanceScopestring

Example response

{
  "dataProductId": "dp-proof-status",
  "providerParty": {
    "partyId": "party-provider",
    "displayName": "Proof provider"
  },
  "physicalConnectorInstanceId": "8a7f09af-7ac9-4d96-91f9-a2a252f4aa4b",
  "logicalConnectionBindingId": "brand-a-proof-vault",
  "datasetResourceIds": [
    "41436f49-040c-4f5f-9c7f-657f43762e2b"
  ],
  "title": "Proof status product",
  "canonicalFieldScopes": [
    "proof.status"
  ],
  "distributionTransferTypes": [
    "HTTPS_PULL"
  ],
  "governanceScope": "proof-status",
  "catalogOfferRefs": [
    {
      "offerId": "offer-proof-status",
      "policy": {
        "profileId": "dpv-odrl",
        "policyType": "OFFER",
        "policyUid": "policy-proof-status"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.