GraphQL RepositoriesfieldPermission

`entities.fieldPermission`

Read field permission records with the fieldPermission repository, and change them with the field permission mutations. Same records as the REST FieldPermissions entity.

Example: first three field permission recordsGraphQLcURL

query FirstFieldPermissions {
  entities {
    fieldPermission {
      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 FirstFieldPermissions { entities { fieldPermission { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { fieldPermission { … } }.

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.	FieldPermissionEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[FieldPermissionEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: FieldPermissionFilterInput, orderBy: [FieldPermissionOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[FieldPermissionEntity!]!
QUERY	`getByCriteria`(filter: FieldPermissionFilterInput, orderBy: [FieldPermissionOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	FieldPermissionEntityConnection
QUERY	`getPublished`(limit: Int, offset: Int, filter: FieldPermissionFilterInput, orderBy: [FieldPermissionOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[FieldPermissionEntity!]!
QUERY	`getDrafts`(filter: FieldPermissionFilterInput, orderBy: [FieldPermissionOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[FieldPermissionEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	FieldPermissionEntity!

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.

FieldPermissionEntity object 14 fields: isDeleteProtected, hasDraft, id, …

Access a user role has to a custom field: full access, read-only or hidden.

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.
`field`	FieldEntity	Custom field this permission applies to.
`masterRight`	MasterRightEntity	User role granted (or restricted) on the field.
`fieldId`	ID!	Id of the custom field.
`masterRightId`	ID!	Id of the user role.
`permissionLevel`	AccessLevelFieldEnum	Access the user role gets to the custom field: full access (view and edit), read-only, or hidden.
`isPublished`	Boolean	True when the permission override is published; false while it exists only as an unpublished draft.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

FieldPermissionEntityConnection object pageInfo: PageInfo!, edges: [FieldPermissionEntityEdge]!, totalCount: Int

Paginated list of FieldPermission records.

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

FieldPermissionEntityEdge object node: FieldPermissionEntity, cursor: String!

A Relay edge containing a FieldPermissionEntity and its cursor.

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

AccessLevelFieldEnumFilterInput input eq: [AccessLevelFieldEnum!], NOT: AccessLevelFieldEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[AccessLevelFieldEnum!]	Matches any of the listed values.
`NOT`	AccessLevelFieldEnumFilterInput	Matches values that do not meet this condition.

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

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

Input field	Type	Description
`OR`	[FieldPermissionFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[FieldPermissionFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	FieldPermissionFilterInput	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.
`fieldId`	EntityFilterStringField	Id of the custom field.
`masterRightId`	EntityFilterStringField	Id of the user role.
`permissionLevel`	AccessLevelFieldEnumFilterInput	Access the user role gets to the custom field: full access (view and edit), read-only, or hidden.
`isPublished`	Boolean	True when the permission override is published; false while it exists only as an unpublished draft.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`entityName`	String	Name of an entity, for example Account. Matches field permissions for fields of that entity.
`field`	FieldFilterInput	Custom field this permission applies to. Matches records where a related record meets these conditions.
`masterRight`	MasterRightFilterInput	User role granted (or restricted) on the field. Matches records where a related record meets these conditions.

FieldPermissionOrderByInput input Asc or Desc per field

Sorting of FieldPermission 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.
`field`	[FieldOrderByNestedInput!]	Custom field this permission applies to. Sorts by fields of the related record, listed in order of priority.
`masterRight`	[MasterRightOrderByNestedInput!]	User role granted (or restricted) on the field. Sorts by fields of the related record, listed in order of priority.
`fieldId`	OrderByEnum	Id of the custom field.
`masterRightId`	OrderByEnum	Id of the user role.
`permissionLevel`	OrderByEnum	Access the user role gets to the custom field: full access (view and edit), read-only, or hidden.
`isPublished`	OrderByEnum	True when the permission override is published; false while it exists only as an unpublished draft.
`revision`	OrderByEnum	Revision when entity was lastly changed.

AccessLevelFieldEnum enum FullAccess, Readonly, NoAccess

Level of access to a single field.

Value	Description
`FullAccess`	The field can be viewed and edited.
`Readonly`	The field can be viewed but not edited.
`NoAccess`	The field is hidden.