# DataProcessingAgreementsApi
All URIs are relative to https://api.mydatamyconsent.com
| Method | HTTP request | Description |
|---|---|---|
| createDataProcessingAgreement | POST /v1/data-agreements | Create a data processing agreement. |
| deleteDataProcessingAgreementById | DELETE /v1/data-agreements/{id} | Delete a data processing agreement. This will not delete a published or a agreement in use with consents. |
| getDataProcessingAgreementById | GET /v1/data-agreements/{id} | Get data processing agreement by id. |
| getDataProcessingAgreements | GET /v1/data-agreements | Get paginated data processing agreements. |
| terminateDataProcessingAgreementById | PUT /v1/data-agreements/{id}/terminate | Terminate a data processing agreement. |
| updateDataProcessingAgreement | PUT /v1/data-agreements/{id} | Update a data processing agreement. |
# createDataProcessingAgreement
DataProcessingAgreement createDataProcessingAgreement(createDataProcessingAgreement)
Create a data processing agreement.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
CreateDataProcessingAgreement createDataProcessingAgreement = new CreateDataProcessingAgreement(); // CreateDataProcessingAgreement | Create data processing agreement payload
try {
DataProcessingAgreement result = apiInstance.createDataProcessingAgreement(createDataProcessingAgreement);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#createDataProcessingAgreement");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| createDataProcessingAgreement | CreateDataProcessingAgreement | Create data processing agreement payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
# deleteDataProcessingAgreementById
deleteDataProcessingAgreementById(id)
Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Agreement id.
try {
apiInstance.deleteDataProcessingAgreementById(id);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#deleteDataProcessingAgreementById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Agreement id. |
# Return type
null (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 404 | Not Found | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
# getDataProcessingAgreementById
DataProcessingAgreement getDataProcessingAgreementById(id)
Get data processing agreement by id.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Agreement id.
try {
DataProcessingAgreement result = apiInstance.getDataProcessingAgreementById(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#getDataProcessingAgreementById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Agreement id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 500 | Server Error | - |
| 400 | Bad Request | - |
| 404 | Not Found | - |
# getDataProcessingAgreements
DataProcessingAgreementPaginatedList getDataProcessingAgreements(pageNo, pageSize)
Get paginated data processing agreements.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
Integer pageNo = 1; // Integer | Page number.
Integer pageSize = 25; // Integer | Number of items to return.
try {
DataProcessingAgreementPaginatedList result = apiInstance.getDataProcessingAgreements(pageNo, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#getDataProcessingAgreements");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pageNo | Integer | Page number. | [optional] [default to 1] |
| pageSize | Integer | Number of items to return. | [optional] [default to 25] |
# Return type
DataProcessingAgreementPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
# terminateDataProcessingAgreementById
terminateDataProcessingAgreementById(id)
Terminate a data processing agreement.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Agreement id.
try {
apiInstance.terminateDataProcessingAgreementById(id);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#terminateDataProcessingAgreementById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Agreement id. |
# Return type
null (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 404 | Not Found | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
# updateDataProcessingAgreement
DataProcessingAgreement updateDataProcessingAgreement(id, updateDataProcessingAgreement)
Update a data processing agreement.
# Example
// Import classes:
import com.mydatamyconsent.ApiClient;
import com.mydatamyconsent.ApiException;
import com.mydatamyconsent.Configuration;
import com.mydatamyconsent.models.*;
import com.mydatamyconsent.api.DataProcessingAgreementsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mydatamyconsent.com");
DataProcessingAgreementsApi apiInstance = new DataProcessingAgreementsApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Agreement id.
UpdateDataProcessingAgreement updateDataProcessingAgreement = new UpdateDataProcessingAgreement(); // UpdateDataProcessingAgreement | Update data processing agreement payload
try {
DataProcessingAgreement result = apiInstance.updateDataProcessingAgreement(id, updateDataProcessingAgreement);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataProcessingAgreementsApi#updateDataProcessingAgreement");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Agreement id. | |
| updateDataProcessingAgreement | UpdateDataProcessingAgreement | Update data processing agreement payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 404 | Not Found | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |