Actions75
- Compliance Report Actions
- Consent And Preference Actions
- Data Manager Actions
- Add Preference Into Your Configuration Tree
- Add Purpose Into Your Configuration Tree
- Create Preference
- Create Purpose
- Delete Preference
- Delete Purpose
- Delete Selected Preference
- Delete Selected Purpose
- Get Available Regulations and Related Information
- Get Configuration Tree
- Get Preference
- Get Purpose
- Get Vendor
- List Preferences
- List Purposes
- List User Rights
- List Vendors
- Update Preference
- Update Purpose
- Privacy Request Actions
- Widget Actions
- Create Authentication Provider
- Create Consent Notice
- Create Widget
- Delete Widget
- Get Archived Widget
- Get Current Draft Configuration For Notice
- Get Custom Theme
- Get Deployment
- Get Entity
- Get Widget
- List Archived Widget
- List Custom Themes
- List Deployments
- List Entities
- List Widgets
- Publish Current Draft Configuration For Notice
- Publish Widget
- Set Default Authentication Provider
- Update Component
- Update Current Draft Configuration For Notice
- Update Custom Theme
- Update Entity
- Update Multiple Components
- Update Multiple Entities
- Update Widget
Data Manager → Get Purpose
AI-generatedOverview
This node operation retrieves detailed information about a specific purpose within the Data Manager resource of the Didomi API. It is useful for scenarios where you need to fetch metadata or configuration details about a particular purpose related to user data management and privacy compliance.
Use Case Examples
- Fetch details of a purpose by its ID to understand its attributes and associated regulations.
- Retrieve a purpose's information to display or process it within a privacy management workflow.
Properties
| Name | Meaning |
|---|---|
| Purpose ID | The unique identifier of the purpose to retrieve. This is required to specify which purpose's details to fetch. |
| Query Parameters | Optional parameters to refine or modify the request, such as filtering or pagination options. |
Output
JSON
id- The unique identifier of the retrieved purpose.name- The name of the purpose.description- A detailed description of the purpose.status- The current status of the purpose.regulations- Regulations associated with the purpose.created_at- Timestamp when the purpose was created.updated_at- Timestamp when the purpose was last updated.
Dependencies
- Didomi API credentials (API Key and API Secret)
Troubleshooting
- Ensure the Purpose ID is provided; otherwise, the node will throw an error indicating the missing Purpose ID.
- Verify that the Didomi API credentials (API Key and API Secret) are correctly set and valid to avoid authentication errors.
- Check the network connectivity and API endpoint availability if requests fail.
- If the API returns an error, review the error message for details and adjust the input parameters accordingly.