Skip to main content

deletedRecords

Returns the ids of records deleted since the point that sinceCursor marks. The response does not include the contents of the deleted records.

The operation must select entities with at least one record type. It must also select records inside every record type that it selects.

A record type that the caller cannot read returns no records. The operation does not fail.

An operation with a missing, invalid, or expired cursor returns fullReloadRequired: true and no records.

Throws an error with code:

  • BAD_USER_INPUT if the operation does not select entities with at least one record type inside it.
  • BAD_USER_INPUT if a selected record type does not also select records.
  • BAD_USER_INPUT if the operation selects a record type other than EVENT without an eventIds value.
  • BAD_USER_INPUT if eventIds holds more than 1,000 values.
deletedRecords(
  eventIds: [ID!]! = 
  sinceCursor: String
): DeletedRecordResult!

Arguments​

deletedRecords.eventIds ● [ID!]! non-null scalar​

The events to return deletions for, as one or more event ids. Every record type except EVENT needs this argument, because EVENT has no parent event.

The operation ignores an id that does not refer to an accessible event. If the operation ignores every id, it returns no records.

deletedRecords.sinceCursor ● String scalar​

An opaque cursor that marks where the previous operation finished. It comes from the currentCursor of that operation. Do not build this cursor. Do not parse it. Omit it on the first operation.

A cursor is valid only for a later operation that selects the same record types and the same events. If you add an event, that event needs a full reload. Optional.

Type​

DeletedRecordResult object​

The result of one operation: the deletions found, and the cursor for the next operation.