Get Personal Data Related Data Entries

GET 
/v2/personal-data/related-data-entries

Gets a list of related data entries filtered by specific resource id and resource type.

You can use pagination with this resource. For more information, see pagination.

note

• This request is only accessible to client_credentials token users with Seller Admin, Support and IT roles.
• Non client_credentials token users cannot access this endpoint. See Permissions.
• This request requires a filter for resource_type and resource_id.

Filtering

The following operator and attributes are required for filtering erasure requests.

Operator	Description
eq	Checks whether the values of two operands are equal. If the values are equal, the condition is true.

Attribute	Type	Operator	Example
resource_type	string	eq	eq(resource_type,customer)
resource_id	string	eq	eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)

Request

Query Parameters

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int64

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

filter string

Filter attributes. For more information, see the Filtering section.

Responses

200

OK

application/json

Schema

Schema

data RelatedDataEntry[]
Array [
resource_type string
The type of a related data entry.
resource_id uuid
The ID of a related data entry.
type string
The type of the object. Always equal to related_data_entry.
]
meta object

results objectrequired

total integer

Total number of results for the entire collection.

page objectrequired

limit integer

The maximum number of records for all pages.

offset integer

The current offset by number of pages.

current integer

The current number of pages.

total integer

The total number of records for the entire collection.

links object

current urirequired

Always the current page.

first urirequired

Always the first page.

last urirequired

Always null if there is only one page.

next stringnullrequired

Always null if there is only one page.

prev stringnullrequired

Always null if the user is on the first page.

Example (from schema)

{
  "data": [
    {
      "resource_type": "user-authentication-info",
      "resource_id": "00000000-0000-1000-8000-111111111112",
      "type": "string"
    }
  ],
  "meta": {
    "results": {
      "total": 1
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {}
}

getLogs

{
  "data": [
    {
      "resource_id": "00000000-0000-1000-8000-111111111112",
      "type": "related_data_entry",
      "resource_type": "user-authentication-info"
    }
  ],
  "meta": {
    "page": {
      "limit": 20,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[offset]=0&page[limit]=20",
    "first": "https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[limit]=20&page[offset]=0",
    "last": "https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[offset]=0&page[limit]=20",
    "next": "null",
    "prev": "null"
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-filter

Required filter missing

{
  "errors": [
    {
      "detail": "bad filter: resource_id and resource_type are the filter fields that are both mandatory and only they are allowed",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...