OBJECT

Library

link GraphQL Schema definition

1type Library {
2
3# Object creation timestamp. Does not change.
4createdDateTime: DateTime
5
6# Object modification timestamp.
7modifiedDateTime: DateTime
8
9# The object's unique ID
10id: ID!
11
12createdBy: String
13
14modifiedBy: String
15
16description: String
17
18name: String
19
20# Modular metadata in the form of key-value pairs
21properties: [Property]
22
23# Security settings for the asset container
24security: Security
25
26applicationId: ID!
27
28# Library version
29version: Int
30
31organizationId: ID
32
33libraryType: LibraryType
34
35libraryTypeId: ID
36
37coverImageUrl: String
38
39# Retrieve engine models for a library
40#
41# Arguments
42# id: Provide an ID to retrieve a specific engine model
43# libraryVersion: Provide a library version to retrieve engine
44# models associated with
45# a given version.
46# currentVersion: Set to true to retrieve engine models
47# associated with the current
48# library version.
49# trainStatus: Provide a training status to filter for engine
50# models by status.
51# engineId: Provide an engineId to filter for engine models by
52# engine.
53# lastModified: Set to true to retrieve the most recently
54# modified engine model.
55# offset: Provide an offset to skip to a certain element in the
56# result, for paging.
57# limit: Specify maximum number of results to retrieve in this
58# result. Page size.
59engineModels(
60id: ID,
61libraryVersion: Int,
62currentVersion: Boolean,
63trainStatus: LibraryEngineModelTrainStatus,
64engineId: ID,
65lastModified: Boolean,
66offset: Int,
67limit: Int
68): LibraryEngineModelList
69
70# Retrieve library model configurations
71configurations(limit: Int, offset: Int): LibraryConfigurationList
72
73# Retrieve dataset library tdos
74dataset: LibraryDataset
75
76# Arguments
77# id: Provide an ID to retrieve a single specific entity.
78entities(
79id: ID,
80ids: [ID!],
81isPublished: Boolean,
82identifierTypeId: ID,
83name: String,
84offset: Int,
85limit: Int,
86orderBy: LibraryEntityOrderBy,
87orderDirection: OrderDirection
88): EntityList
89
90# Retrieve collaborators for a library.
91#
92# Arguments
93# collaboratorOrgId: Provide an ID to retrieve collaborators
94# within a specific organization.
95collaborators(collaboratorOrgId: ID): LibraryCollaboratorList
96
97# Aggregated summary data about the library
98summary: LibrarySummary
99
100}