Skip to content

You are viewing documentation for Immuta version 2021.5.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Create Purposes API Examples

Audience: Data Engineers

Content Summary: This page contains example request payloads for creating purposes.

Basic Purpose

name: A basic purpose

Advanced Purpose

name: Use Purposes
acknowledgement: You promise to be good
description: For use with projects to do policy adjustments
kAnonNoiseReduction: Medium

Sub-Purpose

name: Purpose Hierarchy
acknowledgement: The root acknowledgement
subpurposes:
  - name: Purpose Hierarchy.Child 1
    acknowledgement: Override the root acknowledgement
  - name: Purpose Hierarchy.Child 2
  - name: Purpose Hierarchy.Child 1.Grandchild 1
  - name: Purpose Hierarchy.Child 1.Grandchild 2
  - name: Purpose Hierarchy.Child 2.Grandchild 1
  - name: Purpose Hierarchy.Child 2.Grandchild 2