1 of 3

Manage Projects and Purposes

and can also be created and managed using the V2 API.

Section Contents

Manage Projects

Projects API reference guide

This page details how to use the projects API to query projects and the data sources associated with them in Immuta.

Projects workflow

Create a project.
.
.
.
.
.
.

Create a project

POST /project

Create the project.

Required Immuta permission: CREATE_PROJECT

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will create a new project.

Example request payload

This example payload will create a new project named API Project.

Example response

Search projects

Method

Path

Purpose

Search all projects

GET /project

Search for projects.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request gets a list of all of the projects.

Response example

Search for projects by ID

GET /project/{projectId}

Get the project with the given ID.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the project object for the project with the ID 2.

Example response

Manage projects

Method

Path

Purpose

Update project by ID

PUT /project/{projectId}

Update the project with the given ID.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will update the project with the project ID 2.

Example request payload

This example payload will update the project to be named Documentation Project.

Example response

View project activity by project ID

GET /project/{projectId}/activity

Get all of the recent activity for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets one activity for the project with the project ID 2.

Example response

View the state of an equalized project

GET /project/{projectId}/checkEqualizationState

Get current state of an equalized project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the state of project equalization of the project with the project ID 2.

Example response

Manage project members

Method

Path

Purpose

View project members

GET /project/{projectId}/members

Get all of the members for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This request gets all of the members of the project with the project ID 2.

Example response

Check the members' equalized entitlements

POST /project/{projectId}/checkEqualizedAuths

Check that all members meet the provided equalized entitlements.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This request with the payload below will check if the requesting user is in the "View Masked Values" group.

Payload example

Response example

Add a member to a project

POST /project/{projectId}/members

Add a member to the project.

Requirement: GOVERNANCE permission or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Example request

This example request with the payload below will add a new member to the project with the project ID 1.

Example request payload

Example response

Update a project member

PUT /project/{projectId}/members/{subscriptionId}

Update a member of the project.

Requirement: GOVERNANCE permission or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request with the payload below will update the user with the subscription ID 2 to be a subscriber of the project with the project ID 3.

Payload example

Response example

Manage project data sources

Method

Path

Purpose

View project data sources by project ID

GET project/{projectId}/dataSources

Get all of the data sources for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the data source details for all of the data sources of the project with the project ID 2.

Example response

Remove data sources from a project

DELETE /project/{projectId}/dataSources

Remove data sources from the project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request deletes the data source with the ID 8 from the project with the project ID 2.

Example response

Add data sources to a project

POST /project/{projectId}/dataSources

Adds data sources to a project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will add the data source with the data source ID 1 to the project with the project ID 1.

Example request payload

This example payload will add the data source with the data source ID 2 to the project.

Example response

Update the reason for adding a data source

PUT /project/{projectId}/dataSources/{dataSourceId}

Updates the reason for adding a data source to a project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Request example

This example request with the payload below will update the reason that the data source with the data source ID 1 was added to the project with the project ID 1.

Response example

None.

Use projects

Method

Path

Purpose

Unsubscribe from a project

DELETE /project/{projectId}/unsubscribe

Unsubscribe from a project.

Requirement: You must be a member of the project

Query parameters

Attribute

Description

Required

Request example

This example request unsubscribes the user from the project with the project ID 5.

Select the current project to act under

POST /project/current/{projectId}

Set the current project ID the current user is acting under.

Requirement: You must be a member of the project

Query parameters

Attribute

Description

Required

Request example

This example request sets the current project to act under as the project with the project ID 1.

Acknowledge the project restrictions

POST /project/{projectId}/members/{subscriptionId}/acknowledge

Acknowledge all the restrictions on this project.

Requirement: You must be a member of the project to acknowledge for yourself or have the GOVERNANCE or PROJECT_MANAGEMENT permission to acknowledge on behalf of another user

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request acknowledges all of the purposes in the project with the project ID 1.

Payload example

Response example

Delete project by ID

DELETE /project/{projectId}

Delete the project with the given ID.

Requirement: You must be the owner of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request will delete the project with the project ID 4.

Example response

Manage Purposes

Governance API reference guide

This page describes the governance endpoint of the Immuta API and its request and response parameters used to manage purposes.

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Governance workflow

Create a purpose

POST /governance/purpose

Create a purpose.

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request with the payload below creates a new purpose.

Payload example

Response example

Search purposes

Method

Path

Purpose

Search all purposes

GET /governance/purpose

Search for purposes.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request returns a list of all of the purposes.

Response example

Search purposes by ID

GET /governance/purpose/{purposeId}

Get a purpose by ID.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request returns information on the purpose with the ID 1, including its sub-purposes.

Response example

Update a purpose

PUT /governance/purpose/{purposeId}

Update a purpose.

Required Immuta permission: GOVERNANCE

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request with the payload below will update the description of the purpose with the ID 8.

Payload example

Response example

Delete a purpose

DELETE /governance/purpose/{purposeId}

Delete the purpose with the given ID and its associated sub-purposes.

Required Immuta permission: GOVERNANCE

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request deletes the purpose with the ID 8.

Response example

{ "purposes": [ { "id": 1, "name": "Re-identification Prohibited", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.423Z", "updatedAt": "2021-09-30T00:36:25.215Z" }, { "id": 3, "name": "Re-identification Prohibited.CCPA", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.443Z", "updatedAt": "2021-09-30T00:36:25.250Z" }, { "id": 2, "name": "Re-identification Prohibited.Safe Harbor Method", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose health information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.434Z", "updatedAt": "2021-09-30T00:36:25.234Z" }, { "id": 4, "name": "Use Case Outside De-identification", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. In the event that I discover risks that I believe could lead to unauthorized access, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.452Z", "updatedAt": "2021-09-30T00:36:25.270Z" } ], "count": 4 }

{ "name": "Re-identification Prohibited", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "id": 1, "createdAt": "2021-08-16T20:25:44.423Z", "updatedAt": "2021-09-30T00:36:25.215Z", "addedBy": "Immuta System Account", "projectCount": 1, "projects": [ 1 ], "subpurposes": [ { "id": 3, "name": "Re-identification Prohibited.CCPA", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.443Z", "updatedAt": "2021-09-30T00:36:25.250Z", "projectCount": 0, "projects": [], "addedBy": "Immuta System Account" }, { "id": 2, "name": "Re-identification Prohibited.Safe Harbor Method", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose health information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-08-16T20:25:44.434Z", "updatedAt": "2021-09-30T00:36:25.234Z", "addedBy": "Immuta System Account", "projectCount": 0, "projects": [] } ] }

Manage Projects

Projects API reference guide

This page details how to use the projects API to query projects and the data sources associated with them in Immuta.

Projects workflow

Create a project.
.
.
.
.
.
.

Create a project

POST /project

Create the project.

Required Immuta permission: CREATE_PROJECT

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will create a new project.

Example request payload

This example payload will create a new project named API Project.

Example response

Search projects

Method

Path

Purpose

Search all projects

GET /project

Search for projects.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request gets a list of all of the projects.

Response example

Search for projects by ID

GET /project/{projectId}

Get the project with the given ID.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the project object for the project with the ID 2.

Example response

Manage projects

Method

Path

Purpose

Update project by ID

PUT /project/{projectId}

Update the project with the given ID.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will update the project with the project ID 2.

Example request payload

This example payload will update the project to be named Documentation Project.

Example response

View project activity by project ID

GET /project/{projectId}/activity

Get all of the recent activity for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets one activity for the project with the project ID 2.

Example response

View the state of an equalized project

GET /project/{projectId}/checkEqualizationState

Get current state of an equalized project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the state of project equalization of the project with the project ID 2.

Example response

Manage project members

Method

Path

Purpose

View project members

GET /project/{projectId}/members

Get all of the members for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This request gets all of the members of the project with the project ID 2.

Example response

Check the members' equalized entitlements

POST /project/{projectId}/checkEqualizedAuths

Check that all members meet the provided equalized entitlements.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This request with the payload below will check if the requesting user is in the "View Masked Values" group.

Payload example

Response example

Add a member to a project

POST /project/{projectId}/members

Add a member to the project.

Requirement: GOVERNANCE permission or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Example request

This example request with the payload below will add a new member to the project with the project ID 1.

Example request payload

Example response

Update a project member

PUT /project/{projectId}/members/{subscriptionId}

Update a member of the project.

Requirement: GOVERNANCE permission or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request with the payload below will update the user with the subscription ID 2 to be a subscriber of the project with the project ID 3.

Payload example

Response example

Manage project data sources

Method

Path

Purpose

View project data sources by project ID

GET project/{projectId}/dataSources

Get all of the data sources for a given project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be a member of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example gets the data source details for all of the data sources of the project with the project ID 2.

Example response

Remove data sources from a project

DELETE /project/{projectId}/dataSources

Remove data sources from the project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request deletes the data source with the ID 8 from the project with the project ID 2.

Example response

Add data sources to a project

POST /project/{projectId}/dataSources

Adds data sources to a project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request with the payload below will add the data source with the data source ID 1 to the project with the project ID 1.

Example request payload

This example payload will add the data source with the data source ID 2 to the project.

Example response

Update the reason for adding a data source

PUT /project/{projectId}/dataSources/{dataSourceId}

Updates the reason for adding a data source to a project.

Requirement: PROJECT_MANAGEMENT permission, GOVERNANCE permission, or you must be the owner of the project

Query parameters

Attribute

Description

Required

Request example

This example request with the payload below will update the reason that the data source with the data source ID 1 was added to the project with the project ID 1.

Response example

None.

Use projects

Method

Path

Purpose

Unsubscribe from a project

DELETE /project/{projectId}/unsubscribe

Unsubscribe from a project.

Requirement: You must be a member of the project

Query parameters

Attribute

Description

Required

Request example

This example request unsubscribes the user from the project with the project ID 5.

Select the current project to act under

POST /project/current/{projectId}

Set the current project ID the current user is acting under.

Requirement: You must be a member of the project

Query parameters

Attribute

Description

Required

Request example

This example request sets the current project to act under as the project with the project ID 1.

Acknowledge the project restrictions

POST /project/{projectId}/members/{subscriptionId}/acknowledge

Acknowledge all the restrictions on this project.

Requirement: You must be a member of the project to acknowledge for yourself or have the GOVERNANCE or PROJECT_MANAGEMENT permission to acknowledge on behalf of another user

Query parameters

Attribute

Description

Required

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Request example

This example request acknowledges all of the purposes in the project with the project ID 1.

Payload example

Response example

Delete project by ID

DELETE /project/{projectId}

Delete the project with the given ID.

Requirement: You must be the owner of the project

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

Example request

This example request will delete the project with the project ID 4.

Example response

{ "hits": [ { "id": 8, "name": "Improving Employee Onboarding and Retention", "status": "open", "description": null, "deleted": false, "updatedAt": "2021-07-14T23:14:46.210Z", "subscriptionPolicy": null, "createdAt": "2021-07-14T23:13:53.752Z", "filterId": 8, "subscriptionType": "manual", "isEqualized": false, "acknowledgeRequired": false, "subscriptionStatus": "not_subscribed", "purposeCount": 1, "hasDeletedPurposes": false, "workspace": null, "type": null, "allowMaskedJoins": false }, { "id": 4, "name": "Medical Records", "status": "open", "description": "This project contains all data sources under the schema, medical_records, from [email protected]:1433/example.", "deleted": false, "updatedAt": "2021-06-22T23:24:58.766Z", "subscriptionPolicy": null, "createdAt": "2021-06-22T23:24:58.766Z", "filterId": 4, "subscriptionType": "manual", "isEqualized": false, "acknowledgeRequired": false, "subscriptionStatus": "owner", "purposeCount": 0, "hasDeletedPurposes": false, "workspace": null, "type": "Schema", "allowMaskedJoins": false }, { "id": 6, "name": "sample123", "status": "open", "description": null, "deleted": false, "updatedAt": "2021-07-12T21:32:37.020Z", "subscriptionPolicy": null, "createdAt": "2021-07-12T21:32:37.012Z", "filterId": 6, "subscriptionType": "manual", "isEqualized": false, "acknowledgeRequired": false, "subscriptionStatus": "not_subscribed", "purposeCount": 1, "hasDeletedPurposes": false, "workspace": null, "type": null, "allowMaskedJoins": false }, { "id": 2, "name": "test", "status": "open", "description": null, "deleted": false, "updatedAt": "2021-07-19T20:48:00.758Z", "subscriptionPolicy": null, "createdAt": "2021-05-19T22:50:44.190Z", "filterId": 2, "subscriptionType": "manual", "isEqualized": false, "acknowledgeRequired": false, "subscriptionStatus": "owner", "purposeCount": 2, "hasDeletedPurposes": false, "workspace": null, "type": null, "allowMaskedJoins": false }, { "id": 3, "name": "Tpc", "status": "open", "description": "This project contains all data sources under the schema, tpc, from [email protected]:1433/example.", "deleted": false, "updatedAt": "2021-05-20T16:29:09.679Z", "subscriptionPolicy": null, "createdAt": "2021-05-20T16:29:09.679Z", "filterId": 3, "subscriptionType": "manual", "isEqualized": false, "acknowledgeRequired": false, "subscriptionStatus": "owner", "purposeCount": 0, "hasDeletedPurposes": false, "workspace": null, "type": "Schema", "allowMaskedJoins": false } ], "facets": {}, "count": 5 }

{ "id": 2, "projectKey": "test", "name": "test", "status": "open", "description": null, "documentation": "# test\n\n12345", "deleted": true, "allowMaskedJoins": true, "subscriptionType": "manual", "subscriptionPolicy": null, "equalization": null, "workspace": null, "snowflake": null, "type": null, "schema": null, "createdBy": 2, "updatedBy": 2, "createdAt": "2021-05-19T22:50:44.190Z", "updatedAt": "2021-07-29T18:30:04.066Z", "schemaEvolutionId": null, "subscribedAsUser": true, "subscriptionId": 5, "acknowledgeRequired": false, "subscriptionStatus": "owner", "requestedState": "owner", "approved": true, "subscriptionExpiration": null, "filterId": 2, "purposeCount": null, "purposes": [ { "id": 8, "name": "Analyzing Onboarding and Job Satisfaction", "acknowledgement": null, "description": "Data can only be accessed for analyzing the effectiveness of current onboarding practices and trends in employee job satisfaction reasons for data access must be approved by a compliance committee.", "addedByProfile": 2, "displayAcknowledgement": true, "deleted": false, "systemGenerated": false, "createdAt": "2021-07-07T19:56:06.360Z", "updatedAt": "2021-07-07T19:56:06.360Z", "createdBy": 2 }, { "id": 4, "name": "Use Case Outside De-identification", "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. In the event that I discover risks that I believe could lead to unauthorized access, I agree to immediately notify the project owner or governance team and take immediate action t address and mitigate such risks.", "description": null, "addedByProfile": 1, "displayAcknowledgement": true, "deleted": false, "systemGenerated": true, "createdAt": "2021-05-19T20:32:03.437Z", "updatedAt": "2021-07-28T14:17:22.690Z", "createdBy": 2 } ], "stagedPurposes": [], "tags": [] }

{ "count": 3, "dataSources": [ { "addedBy": "John Doe", "dataSourceName": "Fake Medical Claims 2017", "policyHandlerType": "Builder", "addedOn": "2021-06-25T19:11:03.230Z", "dataSourceId": 8, "addedByProfile": 2, "deleted": false, "subscriptionType": "policy", "subscriptionStatus": "owner", "subscriptionPolicy": { "type": "subscription", "exceptions": { "operator": "or", "conditions": [ { "type": "groups", "group": { "name": "HR Department" } }, { "type": "authorizations", "authorization": { "auth": "Manager", "value": "Receiving Surveys" } } ] }, "shareResponsibility": false, "automaticSubscription": true }, "connectionString": "[email protected]:1433/example", "blobHandlerType": "Snowflake" }, { "addedBy": "John Doe", "dataSourceName": "Tpc Randomized", "policyHandlerType": "Builder", "addedOn": "2021-06-25T22:26:38.170Z", "dataSourceId": 6, "addedByProfile": 2, "deleted": false, "subscriptionType": "policy", "subscriptionStatus": "owner", "subscriptionPolicy": { "type": "subscription", "exceptions": { "operator": "and", "conditions": [ { "type": "groups", "group": { "name": "HR" } } ] }, "shareResponsibility": false, "automaticSubscription": true }, "connectionString": "[email protected]:1433/example", "blobHandlerType": "Azure Synapse Analytics" }, { "addedBy": "John Doe", "dataSourceName": "Tpc Web Sales", "policyHandlerType": "None", "addedOn": "2021-06-25T19:11:03.226Z", "dataSourceId": 7, "addedByProfile": 2, "deleted": false, "subscriptionType": "manual", "subscriptionStatus": "owner", "subscriptionPolicy": null, "connectionString": "[email protected]:1433/example", "blobHandlerType": "Azure Synapse Analytics" } ] }

Manage Projects and Purposes

hashtagSection Contents

Manage Projects

hashtagProjects workflow

hashtagCreate a project

hashtagPayload parameters

hashtagResponse parameters

hashtagExample request

hashtagExample request payload

hashtagExample response

hashtagSearch projects

hashtagSearch all projects

hashtagQuery parameters

hashtagResponse parameters

hashtagRequest example

hashtagResponse example

hashtagSearch for projects by ID

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagManage projects

hashtagUpdate project by ID

hashtagQuery parameters

hashtagPayload parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagView project activity by project ID

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagView the state of an equalized project

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagManage project members

hashtagView project members

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagCheck the members' equalized entitlements

hashtagQuery parameters

hashtagPayload parameters

hashtagResponse parameters

hashtagRequest example

hashtagResponse example

hashtagAdd a member to a project

hashtagQuery parameters

hashtagPayload parameters

hashtagExample request

hashtagExample response

hashtagUpdate a project member

hashtagQuery parameters

hashtagPayload parameters

hashtagResponse parameters

hashtagRequest example

hashtagResponse example

hashtagManage project data sources

hashtagView project data sources by project ID

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagRemove data sources from a project

hashtagQuery parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagAdd data sources to a project

hashtagQuery parameters

hashtagPayload parameters

hashtagResponse parameters

hashtagExample request

hashtagExample response

hashtagUpdate the reason for adding a data source

hashtagQuery parameters

Section Contents

Projects workflow

Create a project

Payload parameters

Response parameters

Example request

Example request payload

Example response

Search projects

Search all projects

Query parameters

Response parameters

Request example

Response example

Search for projects by ID

Query parameters

Response parameters

Example request

Example response

Manage projects

Update project by ID

Query parameters

Payload parameters

Response parameters

Example request

Example response

View project activity by project ID

Query parameters

Response parameters

Example request

Example response

View the state of an equalized project

Query parameters

Response parameters

Example request

Example response

Manage project members

View project members

Query parameters

Response parameters

Example request

Example response

Check the members' equalized entitlements

Query parameters

Payload parameters

Response parameters

Request example

Response example

Add a member to a project

Query parameters

Payload parameters

Example request

Example response

Update a project member

Query parameters

Payload parameters

Response parameters

Request example

Response example

Manage project data sources

View project data sources by project ID

Query parameters

Response parameters

Example request

Example response

Remove data sources from a project

Query parameters

Response parameters

Example request

Example response

Add data sources to a project

Query parameters

Payload parameters

Response parameters

Example request

Example response

Update the reason for adding a data source

Query parameters

Request example

Response example