Table of Contents

Interface IPIIDataAnonymizationApi

Namespace: Casewhere.Gdpr.Runtime
Assembly: Casewhere.Gdpr.Runtime.dll

Provides methods for anonymizing the data of a given user.

public interface IPIIDataAnonymizationApi : IDslApi

Implements

IDslApi

Extension Methods

ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<IPIIDataAnonymizationApi>(IPIIDataAnonymizationApi)

Methods

AnonymizeTask(Guid)

Anonymize data base on anonymization task id

AnonymizationTask AnonymizeTask(Guid taskId)

Parameters

taskId Guid

The task Id

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var exampleTaskId = Guid.Parse("00000000-0000-0000-0000-000000000000");
var task = anonymizationApi.AnonymizeTask(exampleTaskId);

CreateAndAnonymizeTask(string)

Create anonymization task and anonymize data for a given user

AnonymizationTask CreateAndAnonymizeTask(string userIdentifier)

Parameters

userIdentifier string

Data of a given user

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var task = anonymizationApi.CreateAndAnonymizeTask("Enter CPR number like 28392839 here");

CreateAndAnonymizeTaskForCases(params Guid[])

Create anonymization task and anonymize data those closed cases.

AnonymizationTask CreateAndAnonymizeTaskForCases(params Guid[] caseIds)

Parameters

caseIds Guid[]

List closed case id

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var requestedCaseIds = new Guid[]
{
    Guid.Parse("CFF3124C-707E-4650-AB3F-C7474947CED9")
};
var task = anonymizationApi.CreateAndAnonymizeTaskForCases(requestedCaseIds);

CreateAndAnonymizeTaskForDataObjects(params string[])

Create anonymization task and anonymize data with some specific data object Ids in a case (or different cases).

AnonymizationTask CreateAndAnonymizeTaskForDataObjects(params string[] dataObjectIds)

Parameters

dataObjectIds string[]

List data object id

Returns

AnonymizationTask

Task that contains the whole anonymization created.

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var requestedDOIds = new string[]
{
    "CWCourse/c2a9aeab-197f-4e50-8782-ae0d002dba9b"
};
var task = anonymizationApi.CreateAndAnonymizeTaskForDataObjects(requestedDOIds);

CreateTask(string)

Create anonymization task for a given user

AnonymizationTask CreateTask(string userIdentifier)

Parameters

userIdentifier string

Data of a given user

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var task = anonymizationApi.CreateTask("Enter CPR number like 28392839 here");

CreateTaskForCases(params Guid[])

Create anonymization task with closed cases.

AnonymizationTask CreateTaskForCases(params Guid[] caseIds)

Parameters

caseIds Guid[]

List closed case id

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var requestedCaseIds = new Guid[]
{
    Guid.Parse("CFF3124C-707E-4650-AB3F-C7474947CED9")
};
var task = anonymizationApi.CreateTaskForCases(requestedCaseIds);

CreateTaskForDataObjects(params string[])

Create anonymization task with some specific data object Ids in a case (or different cases).

AnonymizationTask CreateTaskForDataObjects(params string[] dataObjectIds)

Parameters

dataObjectIds string[]

List data object id

Returns

AnonymizationTask

Task that contains the whole anonymization created.

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var requestedDOIds = new string[]
{
    "CWCourse/c2a9aeab-197f-4e50-8782-ae0d002dba9b"
};
var task = anonymizationApi.CreateTaskForDataObjects(requestedDOIds);

GetTask(Guid)

Get anonymization task base on its id

AnonymizationTask GetTask(Guid taskId)

Parameters

taskId Guid

The task Id

Returns

AnonymizationTask

Task that contains the whole anonymization progress

Examples

var anonymizationApi = ctx.Use<IPIIDataAnonymizationApi>();
var exampleTaskId = Guid.Parse("00000000-0000-0000-0000-000000000000");
var task = anonymizationApi.GetTask(exampleTaskId);