List Pull Data Records

GET 
/v3/config/data-space/pull-data-records

Lists Pull Data Records, optionally filtered by Data Disclosure Agreement Template (Revision ID) and/or Data Disclosure Agreement Record (Revision ID).

Request

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client.

dataDisclosureAgreementTemplateRevisionId stringrequired

Filter by Data Disclosure Agreement Template Revision ID

dataDisclosureAgreementRecordRevisionId stringrequired

Filter by Data Disclosure Agreement Record Revision ID

Responses

200

Pull Data Records listed

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

pullDataRecords object[]
Array [
id stringrequired
ID of the Pull Data Record between a Data Source and Data Using Service
dataDisclosureAgreementTemplateRevisionId stringrequired
ID of the Data Disclosure Agreement Template Revision that defines data was pulled against
dataDisclosureAgreementRecordRevisionId stringrequired
ID of the Data Disclosure Agreement Record Revision that defines the agreement between the Data Source and Data Using Service
nonce stringrequired
Randomly generated nonce
createdAt intrequired
Timestamp of the Pull Data Record creation
token stringrequired
The Access Token used for pulling data
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "pullDataRecords": [
    {
      "id": "string",
      "dataDisclosureAgreementTemplateRevisionId": "string",
      "dataDisclosureAgreementRecordRevisionId": "string",
      "nonce": "string",
      "token": "string"
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...