GraphQL RepositoriesfieldSequence

`entities.fieldSequence`

Read field sequence records with the fieldSequence repository, and change them with the field sequence mutations. Same records as the REST FieldSequences entity.

Example: first three field sequence recordsGraphQLcURL

query FirstFieldSequences {
  entities {
    fieldSequence {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstFieldSequences { entities { fieldSequence { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { fieldSequence { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	FieldSequenceEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[FieldSequenceEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: FieldSequenceFilterInput, orderBy: [FieldSequenceOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[FieldSequenceEntity!]!
QUERY	`getByCriteria`(filter: FieldSequenceFilterInput, orderBy: [FieldSequenceOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	FieldSequenceEntityConnection
QUERY	`getPublished`(limit: Int, offset: Int, filter: FieldSequenceFilterInput, orderBy: [FieldSequenceOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[FieldSequenceEntity!]!
QUERY	`getDrafts`(filter: FieldSequenceFilterInput, orderBy: [FieldSequenceOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[FieldSequenceEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	FieldSequenceEntity!

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

FieldSequenceEntity object 12 fields: isDeleteProtected, hasDraft, id, …

Numbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`hasDraft`	Boolean	True when the record has unpublished draft changes, including pending translation changes, that can be published.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`filter`	JSONString	Optional filter restricting which records this sequence applies to. Empty means the sequence applies to all records.
`pattern`	String!	Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}").
`sequenceSetId`	ID!	Identifier grouping all sequences (across entity types) that share the same auto-numbering pattern.
`sortOrder`	Int	Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used.
`isPublished`	Boolean	True when the sequence is published; false while it exists only as an unpublished draft.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

FieldSequenceEntityConnection object pageInfo: PageInfo!, edges: [FieldSequenceEntityEdge]!, totalCount: Int

Paginated list of FieldSequence records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[FieldSequenceEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

FieldSequenceEntityEdge object node: FieldSequenceEntity, cursor: String!

A Relay edge containing a FieldSequenceEntity and its cursor.

Field	Type	Description
`node`	FieldSequenceEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

FieldSequenceFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for FieldSequence records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[FieldSequenceFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[FieldSequenceFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	FieldSequenceFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`pattern`	EntityFilterStringField	Pattern template used to generate auto-numbered values (e.g. "{prefix}{year}-{####}").
`sequenceSetId`	EntityFilterStringField	Identifier grouping all sequences (across entity types) that share the same auto-numbering pattern.
`sortOrder`	EntityFilterNumberField	Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used.
`isPublished`	Boolean	True when the sequence is published; false while it exists only as an unpublished draft.

FieldSequenceOrderByInput input Asc or Desc per field

Sorting of FieldSequence records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`sortOrder`	OrderByEnum	Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used.
`isPublished`	OrderByEnum	True when the sequence is published; false while it exists only as an unpublished draft.