OBJECT

Collection

link GraphQL Schema definition

1type Collection {
2
3id: ID!
4
5name: String!
6
7# A url to get the collection image
8imageUrl: String
9
10# A signed url to get the collection image. It will only be signed if it is an s3
11# url.
12signedImageUrl: String
13
14ownerId: ID
15
16description: String
17
18organization: Organization
19
20organizationId: ID!
21
22orgSharing: Boolean
23
24createdDateTime: DateTime
25
26modifiedDateTime: DateTime
27
28programCount: Int
29
30itemCount: Int
31
32typeId: ID
33
34isActive: Boolean
35
36# Folders that the colection is filed in.
37#
38# Arguments
39# offset: Provide an offset to skip to a certain element in the
40# result, for paging.
41# limit: Maximum number of results to retrieve in this query;
42# page size
43widgets(offset: Int, limit: Int, id: ID): WidgetList
44
45# Get a list of mentions filed in the collection
46#
47# Arguments
48# offset: Provide an offset to skip to a certain element in the
49# result, for paging.
50# limit: Maximum number of results to retrieve in this query;
51# page size
52mentions(offset: Int, limit: Int, id: ID): CollectionMentionList
53
54# Folders that the collection is filed in.
55# At present, a collection can only be filed in a single folder.
56folder: [Folder!]
57
58}