Skip to content

DataProcessingAgreementsApi.md

Latest commit

 

History

History
283 lines (200 loc) · 8.04 KB

DataProcessingAgreementsApi.md

File metadata and controls

283 lines (200 loc) · 8.04 KB
Raw

MyDataMyConsent::DataProcessingAgreementsApi

All URIs are relative to https://api.mydatamyconsent.com

Method HTTP request Description
v1_data_agreements_get GET /v1/data-agreements Get paginated data processing agreements.
v1_data_agreements_id_delete DELETE /v1/data-agreements/{id} Delete a data processing agreement this will not delete a published or a agreement in use with consents.
v1_data_agreements_id_get GET /v1/data-agreements/{id} Get data processing agreement by id.
v1_data_agreements_id_terminate_put PUT /v1/data-agreements/{id}/terminate Terminate a data processing agreement by id.

v1_data_agreements_get

v1_data_agreements_get(opts)

Get paginated data processing agreements.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
opts = {
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get paginated data processing agreements.
  result = api_instance.v1_data_agreements_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_get: #{e}"
end

Using the v1_data_agreements_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_data_agreements_get_with_http_info(opts)

begin
  # Get paginated data processing agreements.
  data, status_code, headers = api_instance.v1_data_agreements_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfDataProcessingAgreements>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
page_no Integer [optional]
page_size Integer [optional]

Return type

PaginatedListOfDataProcessingAgreements

Authorization

OAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

v1_data_agreements_id_delete

Boolean v1_data_agreements_id_delete(id)

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

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = 'id_example' # String | 

begin
  # Delete a data processing agreement this will not delete a published or a agreement in use with consents.
  result = api_instance.v1_data_agreements_id_delete(id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_delete: #{e}"
end

Using the v1_data_agreements_id_delete_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Boolean, Integer, Hash)> v1_data_agreements_id_delete_with_http_info(id)

begin
  # Delete a data processing agreement this will not delete a published or a agreement in use with consents.
  data, status_code, headers = api_instance.v1_data_agreements_id_delete_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Boolean
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_delete_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String

Return type

Boolean

Authorization

OAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

v1_data_agreements_id_get

v1_data_agreements_id_get(id)

Get data processing agreement by id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = 'id_example' # String | 

begin
  # Get data processing agreement by id.
  result = api_instance.v1_data_agreements_id_get(id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_get: #{e}"
end

Using the v1_data_agreements_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_data_agreements_id_get_with_http_info(id)

begin
  # Get data processing agreement by id.
  data, status_code, headers = api_instance.v1_data_agreements_id_get_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DataProcessingAgreement>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String

Return type

DataProcessingAgreement

Authorization

OAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

v1_data_agreements_id_terminate_put

Boolean v1_data_agreements_id_terminate_put(id)

Terminate a data processing agreement by id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = 'id_example' # String | 

begin
  # Terminate a data processing agreement by id.
  result = api_instance.v1_data_agreements_id_terminate_put(id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_terminate_put: #{e}"
end

Using the v1_data_agreements_id_terminate_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Boolean, Integer, Hash)> v1_data_agreements_id_terminate_put_with_http_info(id)

begin
  # Terminate a data processing agreement by id.
  data, status_code, headers = api_instance.v1_data_agreements_id_terminate_put_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Boolean
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling DataProcessingAgreementsApi->v1_data_agreements_id_terminate_put_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String

Return type

Boolean

Authorization

OAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8