GraphQL RepositoriesreportSharingClientRelation

`entities.reportSharingClientRelation`

Read report sharing client relation records with the reportSharingClientRelation repository, and change them with the report sharing client relation mutations. Same records as the REST ReportSharingClientRelations entity.

Example: first three report sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { reportSharingClientRelation { … } }.

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.	ReportSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ReportSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ReportSharingClientRelationFilterInput, orderBy: [ReportSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ReportSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: ReportSharingClientRelationFilterInput, orderBy: [ReportSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ReportSharingClientRelationEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

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.

ReportSharingClientRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Share of a report with an individual user, with the access level granted.

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.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`client`	ClientEntity	User granted shared access to the report.
`report`	ReportEntity	Report being shared.
`clientId`	ID!	Id of the user.
`reportId`	ID!	Id of the shared report.
`role`	SharingRoleEnum	Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it.
`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.

ReportSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [ReportSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of ReportSharingClientRelation records.

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

ReportSharingClientRelationEntityEdge object node: ReportSharingClientRelationEntity, cursor: String!

A Relay edge containing a ReportSharingClientRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ReportSharingClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ReportSharingClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ReportSharingClientRelationFilterInput	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.
`clientId`	EntityFilterStringField	Id of the user.
`reportId`	EntityFilterStringField	Id of the shared report.
`role`	SharingRoleEnumFilterInput	Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User granted shared access to the report. Matches records where a related record meets these conditions.
`report`	ReportFilterInput	Report being shared. Matches records where a related record meets these conditions.

ReportSharingClientRelationOrderByInput input Asc or Desc per field

Sorting of ReportSharingClientRelation 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.
`client`	[ClientOrderByNestedInput!]	User granted shared access to the report. Sorts by fields of the related record, listed in order of priority.
`report`	[ReportOrderByNestedInput!]	Report being shared. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`reportId`	OrderByEnum	Id of the shared report.
`role`	OrderByEnum	Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it.
`revision`	OrderByEnum	Revision when entity was lastly changed.