Returns mapping of vendors and purposes with legal bases on the vendor list associated with the property.

📘

For each vendor, the response will only include purposes that have a configured legal basis (Consent, Legitimate Interest, Disclosure Only). Any purposes that are Not Applicable will not be returned in the response.

Additionally, vendors will need at least one purpose with a configured legal basis to be returned in the response.


Command

//Input getVendorPurposeMapping in browser console
window._sp_.gdpr.getVendorPurposeMapping((vendorPurposeMapping, success) => console.log(vendorPurposeMapping));

Response

[
  {
    "categories": [
      {
        "type": "CONSENT",
        "_id": "1234e01e32bd4d27654b5678"
      }
    ],
    "vendorId": "abcd2fbeb8e05c306f2aefgh"
  }
]
schema:
    description: Returned response to vendor purpose mapping
    type: array
    items:
      type: object
      properties:
        categories:
          type: array
          description: Details purposes configured for each vendor
          items:
            type: object
            properties:
              type:
                type: string
                description: Legal basis configured for purpose
              _id:
                type: string
                description: Unique ID for purpose
        vendorId:
          type: string
          description: Unique ID for a vendor