Query data agreements in the wallet
GET {{baseUrl}}/v1/data-agreements?data_agreement_id=<string>&delete_flag=<boolean>&include_fields=<string>&method_of_use=data-source&page=<integer>&page_size=<integer>&publish_flag=<boolean>&template_version=<integer>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
data_agreement_id | string | Data agreement identifier | |
delete_flag | string | Delete flag to query deleted data agreements | |
include_fields | string | Comma separated fields to be included in the response. | |
method_of_use | string | Method of use | |
page | string | Page number | |
page_size | string | Page size | |
publish_flag | string | Published flag to query published data agreements | |
template_version | string | Data agreement template version |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"data_agreement":{"@context":"\u003cstring\u003e","data_controller_name":"\u003cstring\u003e","data_policy":{"data_retention_period":"\u003cinteger\u003e","geographic_restriction":"\u003cstring\u003e","jurisdiction":"\u003cstring\u003e","policy_URL":"\u003cstring\u003e","storage_location":"\u003cstring\u003e","industry_sector":"\u003cstring\u003e"},"lawful_basis":"public_task","method_of_use":"data-using-service","personal_data":[{"attribute_description":"\u003cstring\u003e","attribute_name":"\u003cstring\u003e","attribute_category":"\u003cstring\u003e","attribute_id":"\u003cstring\u003e","attribute_sensitive":"\u003cboolean\u003e","restrictions":[{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"},{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"}]}],"purpose":"\u003cstring\u003e","purpose_description":"\u003cstring\u003e","data_controller_url":"\u003cstring\u003e","dpia":{"dpia_date":"\u003cstring\u003e","dpia_summary_url":"\u003cstring\u003e"},"template_id":"\u003cstring\u003e","template_version":"\u003cinteger\u003e"},"data_agreement_id":"\u003cstring\u003e","data_agreement_record_id":"\u003cstring\u003e","delete_flag":"false","method_of_use":"data-source","publish_flag":"true","state":"PREPARATION"},{"data_agreement":{"@context":"\u003cstring\u003e","data_controller_name":"\u003cstring\u003e","data_policy":{"data_retention_period":"\u003cinteger\u003e","geographic_restriction":"\u003cstring\u003e","jurisdiction":"\u003cstring\u003e","policy_URL":"\u003cstring\u003e","storage_location":"\u003cstring\u003e","industry_sector":"\u003cstring\u003e"},"lawful_basis":"legitimate_interest","method_of_use":"data-using-service","personal_data":[{"attribute_description":"\u003cstring\u003e","attribute_name":"\u003cstring\u003e","attribute_category":"\u003cstring\u003e","attribute_id":"\u003cstring\u003e","attribute_sensitive":"\u003cboolean\u003e","restrictions":[{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"},{"cred_def_id":"\u003cstring\u003e","schema_id":"\u003cstring\u003e"}]}],"purpose":"\u003cstring\u003e","purpose_description":"\u003cstring\u003e","data_controller_url":"\u003cstring\u003e","dpia":{"dpia_date":"\u003cstring\u003e","dpia_summary_url":"\u003cstring\u003e"},"template_id":"\u003cstring\u003e","template_version":"\u003cinteger\u003e"},"data_agreement_id":"\u003cstring\u003e","data_agreement_record_id":"\u003cstring\u003e","delete_flag":"true","method_of_use":"data-source","publish_flag":"false","state":"PREPARATION"}]