# \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(ctx).CreateDataProcessingAgreement(createDataProcessingAgreement).Execute()

Create a data processing agreement.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    createDataProcessingAgreement := *openapiclient.NewCreateDataProcessingAgreement("Version_example", "Body_example", "AttachmentUrl_example") // CreateDataProcessingAgreement | Create data processing agreement payload

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.CreateDataProcessingAgreement(context.Background()).CreateDataProcessingAgreement(createDataProcessingAgreement).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.CreateDataProcessingAgreement``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateDataProcessingAgreement`: DataProcessingAgreement
    fmt.Fprintf(os.Stdout, "Response from `DataProcessingAgreementsApi.CreateDataProcessingAgreement`: %v\n", resp)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiCreateDataProcessingAgreementRequest struct via the builder pattern

Name	Type	Description	Notes
createDataProcessingAgreement	CreateDataProcessingAgreement	Create data processing agreement payload

# Return type

DataProcessingAgreement

# Authorization

No authorization required

# HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# DeleteDataProcessingAgreementById

DeleteDataProcessingAgreementById(ctx, id).Execute()

Delete a data processing agreement. This will not delete a published or a agreement in use with consents.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agreement id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.DeleteDataProcessingAgreementById(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.DeleteDataProcessingAgreementById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Agreement id.

# Other Parameters

Other parameters are passed through a pointer to a apiDeleteDataProcessingAgreementByIdRequest struct via the builder pattern

Name	Type	Description	Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetDataProcessingAgreementById

DataProcessingAgreement GetDataProcessingAgreementById(ctx, id).Execute()

Get data processing agreement by id.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agreement id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.GetDataProcessingAgreementById(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.GetDataProcessingAgreementById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDataProcessingAgreementById`: DataProcessingAgreement
    fmt.Fprintf(os.Stdout, "Response from `DataProcessingAgreementsApi.GetDataProcessingAgreementById`: %v\n", resp)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Agreement id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetDataProcessingAgreementByIdRequest struct via the builder pattern

Name	Type	Description	Notes

# Return type

DataProcessingAgreement

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetDataProcessingAgreements

DataProcessingAgreementPaginatedList GetDataProcessingAgreements(ctx).PageNo(pageNo).PageSize(pageSize).Execute()

Get paginated data processing agreements.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.GetDataProcessingAgreements(context.Background()).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.GetDataProcessingAgreements``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDataProcessingAgreements`: DataProcessingAgreementPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DataProcessingAgreementsApi.GetDataProcessingAgreements`: %v\n", resp)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiGetDataProcessingAgreementsRequest struct via the builder pattern

Name	Type	Description	Notes
pageNo	int32	Page number.	[default to 1]
pageSize	int32	Number of items to return.	[default to 25]

# Return type

DataProcessingAgreementPaginatedList

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# TerminateDataProcessingAgreementById

TerminateDataProcessingAgreementById(ctx, id).Execute()

Terminate a data processing agreement.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agreement id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.TerminateDataProcessingAgreementById(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.TerminateDataProcessingAgreementById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Agreement id.

# Other Parameters

Other parameters are passed through a pointer to a apiTerminateDataProcessingAgreementByIdRequest struct via the builder pattern

Name	Type	Description	Notes

# Return type

(empty response body)

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# UpdateDataProcessingAgreement

DataProcessingAgreement UpdateDataProcessingAgreement(ctx, id).UpdateDataProcessingAgreement(updateDataProcessingAgreement).Execute()

Update a data processing agreement.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Agreement id.
    updateDataProcessingAgreement := *openapiclient.NewUpdateDataProcessingAgreement("Version_example", "Body_example", "AttachmentUrl_example") // UpdateDataProcessingAgreement | Update data processing agreement payload

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataProcessingAgreementsApi.UpdateDataProcessingAgreement(context.Background(), id).UpdateDataProcessingAgreement(updateDataProcessingAgreement).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataProcessingAgreementsApi.UpdateDataProcessingAgreement``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateDataProcessingAgreement`: DataProcessingAgreement
    fmt.Fprintf(os.Stdout, "Response from `DataProcessingAgreementsApi.UpdateDataProcessingAgreement`: %v\n", resp)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Agreement id.

# Other Parameters

Other parameters are passed through a pointer to a apiUpdateDataProcessingAgreementRequest struct via the builder pattern

Name	Type	Description	Notes

updateDataProcessingAgreement | UpdateDataProcessingAgreement | Update data processing agreement payload |

# Return type

DataProcessingAgreement

# Authorization

No authorization required

# HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]