GraphQL RepositoriesreportFolder

`entities.reportFolder`

Read report folder records with the reportFolder repository, and change them with the report folder mutations. Same records as the REST ReportFolders entity.

Example: first three report folder recordsGraphQLcURL

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

Queries

Fields of entities { reportFolder { … } }.

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.	ReportFolderEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ReportFolderEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ReportFolderFilterInput, orderBy: [ReportFolderOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ReportFolderEntity!]!
QUERY	`getByCriteria`(filter: ReportFolderFilterInput, orderBy: [ReportFolderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ReportFolderEntityConnection
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.

ReportFolderEntity object 10 fields: isDeleteProtected, id, isDeleted, …

Folder that organizes reports; folders can be nested.

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.
`parentReportFolder`	ReportFolderEntity	Parent report folder, when this folder is nested. Empty for top-level folders.
`name`	String!	Name of the entity and its default text representation.
`parentReportFolderId`	ID	Id of the parent folder, or empty for top-level folders.
`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.

ReportFolderEntityConnection object pageInfo: PageInfo!, edges: [ReportFolderEntityEdge]!, totalCount: Int

Paginated list of ReportFolder records.

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

ReportFolderEntityEdge object node: ReportFolderEntity, cursor: String!

A Relay edge containing a ReportFolderEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ReportFolderFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ReportFolderFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ReportFolderFilterInput	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.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`parentReportFolderId`	EntityFilterStringField	Id of the parent folder, or empty for top-level folders.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`parentReportFolder`	ReportFolderFilterInput	Parent report folder, when this folder is nested. Empty for top-level folders. Matches records where a related record meets these conditions.

ReportFolderOrderByInput input Asc or Desc per field

Sorting of ReportFolder 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.
`parentReportFolder`	[ReportFolderOrderByNestedInput!]	Parent report folder, when this folder is nested. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority.
`name`	OrderByEnum	Name of the entity and its default text representation.
`parentReportFolderId`	OrderByEnum	Id of the parent folder, or empty for top-level folders.
`revision`	OrderByEnum	Revision when entity was lastly changed.