BenchPrep GraphQL API API Reference
Welcome to BenchPrep GraphQL API documentation.
Its schema can be fetched using introspection query and can be used for generating code, documentations, tests etc.
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
Please start looking by checking out our GraphQL Guides and supported operations
API Endpoints
Development Server:
http://benchprep.localhost/api/graphql
Integration Server:
https://integration.benchprep.com/api/graphql
Staging Server:
https://staging.benchprep.com/api/graphql
Production Server:
https://benchprep.com/api/graphql
Terms of Service: https://benchprep.com/terms
Contact: support@benchprep.com
Version: 0.1.0
Queries
BenchPrep's exposed queries
Request branchPlans
Returns list of BranchPlans
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query branchPlans($filters: BranchPlanFilter, $sort: BranchPlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branchPlans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query branchPlans($filters: BranchPlanFilter, $sort: BranchPlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branchPlans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlans": {
"totalCount": "integer"
}
}
}
Request branches
Returns specific Branches
.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query branches($filters: BranchFilter, $sort: BranchSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branches(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"parentBranchId": "string",
"rootOnly": "boolean",
"excludedBranchId": "string",
"treeByBranchId": "string",
"treeByBranchIdExcludingSelf": "string",
"canHaveChildren": "boolean",
"query": "string",
"ancestorsByBranchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query branches($filters: BranchFilter, $sort: BranchSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branches(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"parentBranchId": "string",
"rootOnly": "boolean",
"excludedBranchId": "string",
"treeByBranchId": "string",
"treeByBranchIdExcludingSelf": "string",
"canHaveChildren": "boolean",
"query": "string",
"ancestorsByBranchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branches": {
"totalCount": "integer"
}
}
}
Request branding
Returns specific Branding
.
Example
Request Content-Types:
application/json
Query
query branding{
branding{
brandableId
brandableType
colorLogoUrl
emailLogoUrl
faviconUrl
id
mobileIconUrl
primaryColor
secondaryColor
whiteLogoUrl
}
}
Try it now
query branding{
branding{
brandableId
brandableType
colorLogoUrl
emailLogoUrl
faviconUrl
id
mobileIconUrl
primaryColor
secondaryColor
whiteLogoUrl
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branding": {
"brandableId": "string",
"brandableType": "string",
"colorLogoUrl": "string",
"emailLogoUrl": "string",
"faviconUrl": "string",
"id": "string",
"mobileIconUrl": "string",
"primaryColor": "string",
"secondaryColor": "string",
"whiteLogoUrl": "string"
}
}
}
Request certificates
Returns list of Certificate
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query certificates($filters: CertificateFilter, $sort: CertificateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
certificates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query certificates($filters: CertificateFilter, $sort: CertificateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
certificates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"certificates": {
"totalCount": "integer"
}
}
}
Request contentPackages
Returns list of ContentPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query contentPackages($filters: ContentPackageFilter, $sort: ContentPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"state": "string",
"excludedIds": [
"string"
],
"hasStudyPlan": "boolean",
"hasCertificates": "boolean",
"hasExams": "boolean",
"bank": "boolean",
"hasExternalPackages": "boolean",
"enrolledFor": "number",
"courseType": "string",
"hasMilestones": "boolean",
"isRecognitionIssuing": "boolean",
"hasRecognitions": "boolean",
"branchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"ltiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
},
"notLtiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query contentPackages($filters: ContentPackageFilter, $sort: ContentPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"state": "string",
"excludedIds": [
"string"
],
"hasStudyPlan": "boolean",
"hasCertificates": "boolean",
"hasExams": "boolean",
"bank": "boolean",
"hasExternalPackages": "boolean",
"enrolledFor": "number",
"courseType": "string",
"hasMilestones": "boolean",
"isRecognitionIssuing": "boolean",
"hasRecognitions": "boolean",
"branchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"ltiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
},
"notLtiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentPackages": {
"totalCount": "integer"
}
}
}
Request contentTypes
Returns list of ContentType
s.
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query contentTypes($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentTypes(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query contentTypes($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentTypes(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentTypes": {
"totalCount": "integer"
}
}
}
Request currentTenant
Returns information about the CurrentTenant
(resolver).
Example
Request Content-Types:
application/json
Query
query currentTenant{
currentTenant{
bigCommerceSsoEnabled
id
name
publicUrl
slug
}
}
Try it now
query currentTenant{
currentTenant{
bigCommerceSsoEnabled
id
name
publicUrl
slug
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentTenant": {
"bigCommerceSsoEnabled": "boolean",
"id": "string",
"name": "string",
"publicUrl": "string",
"slug": "string"
}
}
}
Request currentUser
Returns information about the currently authenticated CurrentUser
(resolver).
Example
Request Content-Types:
application/json
Query
query currentUser{
currentUser{
createdAt
email
id
name
permissionSlugs
roleSlugs
state
}
}
Try it now
query currentUser{
currentUser{
createdAt
email
id
name
permissionSlugs
roleSlugs
state
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentUser": {
"email": "string",
"id": "string",
"name": "string",
"permissionSlugs": [
"string"
],
"roleSlugs": [
"string"
],
"state": "string"
}
}
}
Request currentUserRole
Returns information about the currently authenticated UserRole
.
Example
Request Content-Types:
application/json
Query
query currentUserRole{
currentUserRole{
accessContext
accessContextId
accessContextType
applicableAccessContexts
id
permissionSlugs(filter: $filter)
properties
roleSlug
userId
}
}
Try it now
query currentUserRole{
currentUserRole{
accessContext
accessContextId
accessContextType
applicableAccessContexts
id
permissionSlugs(filter: $filter)
properties
roleSlug
userId
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentUserRole": {
"accessContextId": "string",
"accessContextType": "string",
"applicableAccessContexts": [
null
],
"id": "string",
"permissionSlugs": [
"string"
],
"roleSlug": "string",
"userId": "string"
}
}
}
Request developerTokens
Returns list of DeveloperTokens
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query developerTokens($sort: DeveloperTokenSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
developerTokens(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query developerTokens($sort: DeveloperTokenSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
developerTokens(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokens": {
"totalCount": "integer"
}
}
}
Request domains
Returns registered Domains
(resolver) to the current tenant.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query domains($filters: DomainFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
domains(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query domains($filters: DomainFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
domains(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"domains": {
"totalCount": "integer"
}
}
}
Request enrollments
Returns list of Enrollment
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query enrollments($filters: EnrollmentFilter, $sort: EnrollmentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
enrollments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query enrollments($filters: EnrollmentFilter, $sort: EnrollmentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
enrollments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollments": {
"totalCount": "integer"
}
}
}
Request examResults
Returns list of ExamResult
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query examResults($filters: ExamResultFilter, $sort: ExamResultSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
examResults(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": [
"string"
],
"examId": "string",
"examName": "string",
"contentPackageId": "string",
"query": "string",
"withDeleted": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query examResults($filters: ExamResultFilter, $sort: ExamResultSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
examResults(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": [
"string"
],
"examId": "string",
"examName": "string",
"contentPackageId": "string",
"query": "string",
"withDeleted": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"examResults": {
"totalCount": "integer"
}
}
}
Request exams
Returns list of Exam
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query exams($filters: ExamFilter, $sort: ExamSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
exams(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query exams($filters: ExamFilter, $sort: ExamSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
exams(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"exams": {
"totalCount": "integer"
}
}
}
Request externalPackages
Returns list of ExternalPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query externalPackages($filters: ExternalPackageFilter, $sort: ExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
externalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"withoutContentPackages": "boolean",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query externalPackages($filters: ExternalPackageFilter, $sort: ExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
externalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"withoutContentPackages": "boolean",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"externalPackages": {
"totalCount": "integer"
}
}
}
Request groups
Returns specific Groups
.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query groups($filters: GroupFilter, $sort: GroupSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
groups(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string",
"memberId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query groups($filters: GroupFilter, $sort: GroupSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
groups(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string",
"memberId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groups": {
"totalCount": "integer"
}
}
}
Request integrations
Returns list of Integration
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query integrations($filters: IntegrationFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
integrations(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"type": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query integrations($filters: IntegrationFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
integrations(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"type": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrations": {
"totalCount": "integer"
}
}
}
Request learningHubEvents
Returns list of LearningHubEvent
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningHubEvents($filters: LearningHubEventFilter, $sort: LearningHubEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"deliveryType": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningHubEvents($filters: LearningHubEventFilter, $sort: LearningHubEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"deliveryType": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEvents": {
"totalCount": "integer"
}
}
}
Request learningHubPages
Returns list of LearningHubPage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningHubPages($sort: LearningHubPageSortOrderFilter, $filters: LearningHubPageFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubPages(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningHubPages($sort: LearningHubPageSortOrderFilter, $filters: LearningHubPageFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubPages(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPages": {
"totalCount": "integer"
}
}
}
Request learningPaths
Returns list of LearningPath
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningPaths($filters: LearningPathFilter, $sort: LearningPathSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningPaths(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningPaths($filters: LearningPathFilter, $sort: LearningPathSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningPaths(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningPaths": {
"totalCount": "integer"
}
}
}
Request licenses
Returns list of License
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query licenses($filters: LicenseFilter, $sort: LicenseSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
licenses(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"branchPlanIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query licenses($filters: LicenseFilter, $sort: LicenseSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
licenses(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"branchPlanIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenses": {
"totalCount": "integer"
}
}
}
Request locales
Returns specific Locales
setup.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query locales($filters: LocaleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
locales(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"language": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query locales($filters: LocaleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
locales(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"language": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"locales": {
"totalCount": "integer"
}
}
}
Request loginTrackings
Returns list of LoginTracking
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query loginTrackings($sort: LoginTrackingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
loginTrackings(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query loginTrackings($sort: LoginTrackingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
loginTrackings(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"loginTrackings": {
"totalCount": "integer"
}
}
}
Request ltiDeployments
Returns list of LtiDeployments
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query ltiDeployments($filters: LtiDeploymentFilter, $sort: LtiDeploymentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiDeployments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"toolId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query ltiDeployments($filters: LtiDeploymentFilter, $sort: LtiDeploymentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiDeployments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"toolId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeployments": {
"totalCount": "integer"
}
}
}
Request ltiTools
Returns list of LtiTool
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query ltiTools($filters: LtiToolFilter, $sort: LtiToolSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiTools(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"branchId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query ltiTools($filters: LtiToolFilter, $sort: LtiToolSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiTools(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"branchId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiTools": {
"totalCount": "integer"
}
}
}
Request messages
Returns list of Message
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query messages($filters: MessageFilter, $sort: MessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
messages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query messages($filters: MessageFilter, $sort: MessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
messages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messages": {
"totalCount": "integer"
}
}
}
Request milestones
Returns list of Milestone
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query milestones($filters: MilestoneFilter, $sort: MilestoneSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
milestones(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query milestones($filters: MilestoneFilter, $sort: MilestoneSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
milestones(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"milestones": {
"totalCount": "integer"
}
}
}
Request permissions
Returns list of Permission
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query permissions($filters: PermissionFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
permissions(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query permissions($filters: PermissionFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
permissions(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"permissions": {
"totalCount": "integer"
}
}
}
Request plans
Returns list of Plans
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query plans($filters: PlanFilter, $sort: PlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
plans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query plans($filters: PlanFilter, $sort: PlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
plans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"plans": {
"totalCount": "integer"
}
}
}
Request productCategories
Returns list of ProductCategory
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query productCategories($filters: ProductCategoryFilter, $sort: ProductCategorySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategories(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"childOnly": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query productCategories($filters: ProductCategoryFilter, $sort: ProductCategorySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategories(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"childOnly": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productCategories": {
"totalCount": "integer"
}
}
}
Request productCategoryAssignments
Returns list of ProductCategoryAssignment
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query productCategoryAssignments($filters: ProductCategoryAssignmentFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategoryAssignments(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"forCategorizable": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query productCategoryAssignments($filters: ProductCategoryAssignmentFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategoryAssignments(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"forCategorizable": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productCategoryAssignments": {
"totalCount": "integer"
}
}
}
Request recognitionTypes
Returns list of RecognitionType
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query recognitionTypes($filters: RecognitionTypeFilter, $sort: RecognitionTypeSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitionTypes(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query recognitionTypes($filters: RecognitionTypeFilter, $sort: RecognitionTypeSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitionTypes(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitionTypes": {
"totalCount": "integer"
}
}
}
Request recognitions
Returns list of Recognition
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query recognitions($filters: RecognitionFilter, $sort: RecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query recognitions($filters: RecognitionFilter, $sort: RecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitions": {
"totalCount": "integer"
}
}
}
Request roles
Returns list of Role
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query roles($sort: RoleSortOrderFilter, $filters: RoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
roles(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
],
"notSlugs": [
"string"
],
"query": "string",
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query roles($sort: RoleSortOrderFilter, $filters: RoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
roles(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
],
"notSlugs": [
"string"
],
"query": "string",
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"roles": {
"totalCount": "integer"
}
}
}
Request studyTasks
Returns list of StudyTask
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query studyTasks($filters: StudyTaskFilter, $sort: StudyTaskSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
studyTasks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query studyTasks($filters: StudyTaskFilter, $sort: StudyTaskSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
studyTasks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"studyTasks": {
"totalCount": "integer"
}
}
}
Request subscriptions
Returns list of Subscription
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query subscriptions($filters: SubscriptionFilter, $sort: SubscriptionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
subscriptions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"planIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query subscriptions($filters: SubscriptionFilter, $sort: SubscriptionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
subscriptions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"planIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"subscriptions": {
"totalCount": "integer"
}
}
}
Request urlRegistrations
Returns list of UrlRegistration
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query urlRegistrations($filters: UrlRegistrationFilter, $sort: UrlRegistrationSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
urlRegistrations(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"liveEventId": "string",
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query urlRegistrations($filters: UrlRegistrationFilter, $sort: UrlRegistrationSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
urlRegistrations(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"liveEventId": "string",
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"urlRegistrations": {
"totalCount": "integer"
}
}
}
Request userExternalPackages
Returns list of UserExternalPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userExternalPackages($filters: UserExternalPackageFilter, $sort: UserExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userExternalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"externalPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userExternalPackages($filters: UserExternalPackageFilter, $sort: UserExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userExternalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"externalPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userExternalPackages": {
"totalCount": "integer"
}
}
}
Request userRecognitions
Returns list of UserRecognition
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userRecognitions($filters: UserRecognitionFilter, $sort: UserRecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRecognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userRecognitions($filters: UserRecognitionFilter, $sort: UserRecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRecognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRecognitions": {
"totalCount": "integer"
}
}
}
Request userRoles
Returns list of UserRole
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userRoles($filters: UserRoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRoles(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"userId": "string",
"containedUserIds": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userRoles($filters: UserRoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRoles(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"userId": "string",
"containedUserIds": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoles": {
"totalCount": "integer"
}
}
}
Request users
Returns list of User
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query users($filters: UserFilter, $sort: UserSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
users(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"excludedIds": [
"string"
],
"email": "string",
"name": "string",
"query": "string",
"branchId": "string",
"withoutBranch": "boolean",
"roleSlug": "string",
"withoutRole": "boolean",
"withoutBranchPlanLicense": "string",
"confirmationStatus": "string",
"managersBranchId": "string",
"groupId": "string",
"groupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"notGroupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"withoutGroup": "boolean",
"managersGroupId": "string",
"createdAfter": "number",
"createdBefore": "number"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query users($filters: UserFilter, $sort: UserSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
users(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"excludedIds": [
"string"
],
"email": "string",
"name": "string",
"query": "string",
"branchId": "string",
"withoutBranch": "boolean",
"roleSlug": "string",
"withoutRole": "boolean",
"withoutBranchPlanLicense": "string",
"confirmationStatus": "string",
"managersBranchId": "string",
"groupId": "string",
"groupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"notGroupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"withoutGroup": "boolean",
"managersGroupId": "string",
"createdAfter": "number",
"createdBefore": "number"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"users": {
"totalCount": "integer"
}
}
}
Request vouchers
Returns list of Voucher
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query vouchers($filters: VoucherFilter, $sort: VoucherSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
vouchers(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"planIds": [
"string"
],
"branchPlanIds": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query vouchers($filters: VoucherFilter, $sort: VoucherSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
vouchers(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"planIds": [
"string"
],
"branchPlanIds": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"vouchers": {
"totalCount": "integer"
}
}
}
Request webhookDeliveries
Returns list of WebhookDeliveries
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhookDeliveries($filters: WebhookDeliveryFilter, $sort: WebhookDeliverySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookDeliveries(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"webhookIds": [
"string"
],
"webhookEventIds": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhookDeliveries($filters: WebhookDeliveryFilter, $sort: WebhookDeliverySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookDeliveries(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"webhookIds": [
"string"
],
"webhookEventIds": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookDeliveries": {
"totalCount": "integer"
}
}
}
Request webhookEvents
Returns list of WebhooksEvents
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhookEvents($filters: WebhookEventFilter, $sort: WebhookEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"eventType": "string",
"startDate": "object",
"endDate": "object"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhookEvents($filters: WebhookEventFilter, $sort: WebhookEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"eventType": "string",
"startDate": "object",
"endDate": "object"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookEvents": {
"totalCount": "integer"
}
}
}
Request webhooks
Returns list of Webhooks
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhooks($filters: WebhookFilter, $sort: WebhookSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhooks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"enabled": "boolean",
"eventType": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhooks($filters: WebhookFilter, $sort: WebhookSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhooks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"enabled": "boolean",
"eventType": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhooks": {
"totalCount": "integer"
}
}
}
Mutations
BenchPrep's exposed mutations
Modification branchAssignUsers
Assign Users to Branch
Parameters for BranchAssignUsersMutation
Example
Request Content-Types:
application/json
Query
mutation branchAssignUsers($input: BranchAssignUsersInput!){
branchAssignUsers(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"branchId": "string",
"userIds": [
"string"
]
}
}
Try it now
mutation branchAssignUsers($input: BranchAssignUsersInput!){
branchAssignUsers(input: $input){
clientMutationId
success
}
}
{
"input": {
"branchId": "string",
"userIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchAssignUsers": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchCreate
Create Branch
resource.
Parameters for BranchCreateMutation
Example
Request Content-Types:
application/json
Query
mutation branchCreate($input: BranchCreateInput!){
branchCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"parentBranchId": "string"
}
}
Try it now
mutation branchCreate($input: BranchCreateInput!){
branchCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"parentBranchId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchDelete
Delete Branch
resource.
Parameters for BranchDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation branchDelete($input: BranchDeleteInput!){
branchDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation branchDelete($input: BranchDeleteInput!){
branchDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchPlanCoursesUpdate
Update BranchPlan
resource's courses.
Parameters for BranchPlanUpdateCoursesMutation
Example
Request Content-Types:
application/json
Query
mutation branchPlanCoursesUpdate($input: BranchPlanUpdateCoursesInput!){
branchPlanCoursesUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
],
"updateExistingUsers": "boolean"
}
}
Try it now
mutation branchPlanCoursesUpdate($input: BranchPlanUpdateCoursesInput!){
branchPlanCoursesUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
],
"updateExistingUsers": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlanCoursesUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchPlanCreate
Create BranchPlan
resource.
Parameters for BranchPlanCreateMutation
Example
Request Content-Types:
application/json
Query
mutation branchPlanCreate($input: BranchPlanCreateInput!){
branchPlanCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"branchId": "string",
"validFrom": "object",
"validTo": "object",
"duration": "string",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"enableInBrowse": "boolean",
"contentPackageIds": [
"string"
]
}
}
Try it now
mutation branchPlanCreate($input: BranchPlanCreateInput!){
branchPlanCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"branchId": "string",
"validFrom": "object",
"validTo": "object",
"duration": "string",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"enableInBrowse": "boolean",
"contentPackageIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlanCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchPlanUpdate
Update BranchPlan
resource.
Parameters for BranchPlanUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation branchPlanUpdate($input: BranchPlanUpdateInput!){
branchPlanUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"enableInBrowse": "boolean",
"validFrom": "object",
"validTo": "object",
"duration": "number",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"durationUnit": "string"
}
}
Try it now
mutation branchPlanUpdate($input: BranchPlanUpdateInput!){
branchPlanUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"enableInBrowse": "boolean",
"validFrom": "object",
"validTo": "object",
"duration": "number",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"durationUnit": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlanUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchUpdate
Update Branch
resource.
Parameters for BranchUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation branchUpdate($input: BranchUpdateInput!){
branchUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"slug": "string"
}
}
Try it now
mutation branchUpdate($input: BranchUpdateInput!){
branchUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"slug": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification brandingDelete
Delete Branding
resource.
Parameters for DeleteMutation
Example
Request Content-Types:
application/json
Query
mutation brandingDelete($input: BrandingDeleteInput!){
brandingDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"brandableId": "string",
"brandableType": "string"
}
}
Try it now
mutation brandingDelete($input: BrandingDeleteInput!){
brandingDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"brandableId": "string",
"brandableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"brandingDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification colorUpdate
Update Color
branding resource.
Parameters for ColorUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation colorUpdate($input: ColorUpdateInput!){
colorUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"primaryColor": "string",
"secondaryColor": "string",
"brandableId": "string",
"brandableType": "string"
}
}
Try it now
mutation colorUpdate($input: ColorUpdateInput!){
colorUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"primaryColor": "string",
"secondaryColor": "string",
"brandableId": "string",
"brandableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"colorUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification contentPackageDeactivationDateUpdate
Update deactivation date on ContentPackage
resource
Parameters for ContentPackageUpdateDeactivationDateMutation
Example
Request Content-Types:
application/json
Query
mutation contentPackageDeactivationDateUpdate($input: ContentPackageUpdateDeactivationDateInput!){
contentPackageDeactivationDateUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"deactivatedAt": "object"
}
}
Try it now
mutation contentPackageDeactivationDateUpdate($input: ContentPackageUpdateDeactivationDateInput!){
contentPackageDeactivationDateUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"deactivatedAt": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentPackageDeactivationDateUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenCreate
Create DeveloperToken
resource.
Parameters for DeveloperTokenCreateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenCreate($input: DeveloperTokenCreateInput!){
developerTokenCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string"
}
}
Try it now
mutation developerTokenCreate($input: DeveloperTokenCreateInput!){
developerTokenCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenDeactivate
Deactivate DeveloperToken
resource.
Parameters for DeveloperTokenDeactivateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenDeactivate($input: DeveloperTokenDeactivateInput!){
developerTokenDeactivate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation developerTokenDeactivate($input: DeveloperTokenDeactivateInput!){
developerTokenDeactivate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenDeactivate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenUpdate
Update DeveloperToken
resource.
Parameters for DeveloperTokenUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenUpdate($input: DeveloperTokenUpdateInput!){
developerTokenUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string"
}
}
Try it now
mutation developerTokenUpdate($input: DeveloperTokenUpdateInput!){
developerTokenUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification enrollmentReset
Reset Enrollment
resource.
Parameters for EnrollmentResetMutation
Example
Request Content-Types:
application/json
Query
mutation enrollmentReset($input: EnrollmentResetMutationInput!){
enrollmentReset(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation enrollmentReset($input: EnrollmentResetMutationInput!){
enrollmentReset(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollmentReset": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification enrollmentUpdate
Update Enrollment
resource.
Parameters for EnrollmentUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation enrollmentUpdate($input: EnrollmentUpdateInput!){
enrollmentUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"additionalResets": "number"
}
}
Try it now
mutation enrollmentUpdate($input: EnrollmentUpdateInput!){
enrollmentUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"additionalResets": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollmentUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification examResultReset
Reset ExamResult
resource.
Parameters for ExamResultResetMutation
Example
Request Content-Types:
application/json
Query
mutation examResultReset($input: ExamResultResetMutationInput!){
examResultReset(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation examResultReset($input: ExamResultResetMutationInput!){
examResultReset(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"examResultReset": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification featureAccessUpdate
Update FeatureAccess
resource.
Parameters for FeatureAccessUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation featureAccessUpdate($input: FeatureAccessUpdateInput!){
featureAccessUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"slug": "string",
"allowed": "boolean",
"controllableId": "string",
"controllableType": "string"
}
}
Try it now
mutation featureAccessUpdate($input: FeatureAccessUpdateInput!){
featureAccessUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"slug": "string",
"allowed": "boolean",
"controllableId": "string",
"controllableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"featureAccessUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification featureConfigurationUpdate
Update FeatureConfiguration
resource.
Parameters for FeatureConfigurationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation featureConfigurationUpdate($input: FeatureConfigurationUpdateInput!){
featureConfigurationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"slug": "string",
"controllableId": "string",
"controllableType": "string",
"configuration": "object"
}
}
Try it now
mutation featureConfigurationUpdate($input: FeatureConfigurationUpdateInput!){
featureConfigurationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"slug": "string",
"controllableId": "string",
"controllableType": "string",
"configuration": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"featureConfigurationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupCreate
Group
resource.
Parameters for GroupCreateMutation
Example
Request Content-Types:
application/json
Query
mutation groupCreate($input: GroupCreateInput!){
groupCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"branchId": "string",
"externalId": "string",
"description": "string"
}
}
Try it now
mutation groupCreate($input: GroupCreateInput!){
groupCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"branchId": "string",
"externalId": "string",
"description": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupMembershipUpdate
Update Group
resource membership
Parameters for GroupMembershipUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation groupMembershipUpdate($input: GroupMembershipUpdateInput!){
groupMembershipUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"groupId": "string",
"userIdsToAdd": [
"string"
],
"userIdsToRemove": [
"string"
]
}
}
Try it now
mutation groupMembershipUpdate($input: GroupMembershipUpdateInput!){
groupMembershipUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"groupId": "string",
"userIdsToAdd": [
"string"
],
"userIdsToRemove": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupMembershipUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupUpdate
Update Group
resource.
Parameters for GroupUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation groupUpdate($input: GroupUpdateInput!){
groupUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"externalSystemId": "string",
"description": "string"
}
}
Try it now
mutation groupUpdate($input: GroupUpdateInput!){
groupUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"externalSystemId": "string",
"description": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupsCreate
Queue asynchronous process to create multiple Group
resources.
Parameters for GroupsCreateMutation
Example
Request Content-Types:
application/json
Query
mutation groupsCreate($input: GroupsCreateInput!){
groupsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
Variables
{
"input": {
"fileName": "string",
"dataFormat": "string",
"groups": [
{
"name": "string",
"branchSlug": "string",
"externalId": "string",
"description": "string"
}
]
}
}
Try it now
mutation groupsCreate($input: GroupsCreateInput!){
groupsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
{
"input": {
"fileName": "string",
"dataFormat": "string",
"groups": [
{
"name": "string",
"branchSlug": "string",
"externalId": "string",
"description": "string"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupsCreate": {
"clientMutationId": "string",
"success": "boolean",
"uploadStatus": "string"
}
}
}
Modification integrationCreate
Create Integration
resource.
Parameters for IntegrationCreateMutation
Example
Request Content-Types:
application/json
Query
mutation integrationCreate($input: IntegrationCreateInput!){
integrationCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"type": "string",
"accountName": "string",
"clientId": "string",
"clientSecret": "string",
"accessToken": "string",
"storeHash": "string"
}
}
Try it now
mutation integrationCreate($input: IntegrationCreateInput!){
integrationCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"type": "string",
"accountName": "string",
"clientId": "string",
"clientSecret": "string",
"accessToken": "string",
"storeHash": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification integrationDelete
Delete Integration
resource.
Parameters for IntegrationDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation integrationDelete($input: IntegrationDeleteMutationInput!){
integrationDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation integrationDelete($input: IntegrationDeleteMutationInput!){
integrationDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification integrationUpdate
Update Integration
resource.
Parameters for IntegrationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation integrationUpdate($input: IntegrationUpdateInput!){
integrationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"accountName": "string"
}
}
Try it now
mutation integrationUpdate($input: IntegrationUpdateInput!){
integrationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"accountName": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learnableConfigurationUpdate
Update Learnable Configuration
from a content package
Parameters for LearnableConfigurationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learnableConfigurationUpdate($input: LearnableConfigurationUpdateInput!){
learnableConfigurationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"learnableType": "string",
"learnableId": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
}
}
Try it now
mutation learnableConfigurationUpdate($input: LearnableConfigurationUpdateInput!){
learnableConfigurationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"learnableType": "string",
"learnableId": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learnableConfigurationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventCreate
Create LearningHubEvent
resource.
Parameters for LearningHubEventCreateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventCreate($input: LearningHubEventCreateInput!){
learningHubEventCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"description": "string",
"startDate": "object",
"endDate": "object",
"deliveryType": "string",
"hostEmail": "string",
"learnableConfiguration": {
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
},
"isRecognitionIssuing": "boolean",
"url": "string"
}
}
Try it now
mutation learningHubEventCreate($input: LearningHubEventCreateInput!){
learningHubEventCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"description": "string",
"startDate": "object",
"endDate": "object",
"deliveryType": "string",
"hostEmail": "string",
"learnableConfiguration": {
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
},
"isRecognitionIssuing": "boolean",
"url": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventDelete
Delete LearningHubEvent
resource.
Parameters for LearningHubEventDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventDelete($input: LearningHubEventDeleteInput!){
learningHubEventDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation learningHubEventDelete($input: LearningHubEventDeleteInput!){
learningHubEventDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventUpdate
Update LearningHubEvent
resource.
Parameters for LearningHubEventUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventUpdate($input: LearningHubEventUpdateInput!){
learningHubEventUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"hostEmail": "string",
"url": "string",
"recordingLink": "string",
"startDate": "object",
"endDate": "object"
}
}
Try it now
mutation learningHubEventUpdate($input: LearningHubEventUpdateInput!){
learningHubEventUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"hostEmail": "string",
"url": "string",
"recordingLink": "string",
"startDate": "object",
"endDate": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageCreate
Create LearningHubPage
resource.
Parameters for LearningHubPageCreateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageCreate($input: LearningHubPageCreateInput!){
learningHubPageCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"pageType": "string",
"html": "string"
}
}
Try it now
mutation learningHubPageCreate($input: LearningHubPageCreateInput!){
learningHubPageCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"pageType": "string",
"html": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageDelete
Delete LearningHubPage
resource.
Parameters for LearningHubPageDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageDelete($input: LearningHubPageDeleteInput!){
learningHubPageDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation learningHubPageDelete($input: LearningHubPageDeleteInput!){
learningHubPageDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageUpdate
Update LearningHubPage
resource.
Parameters for LearningHubPageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageUpdate($input: LearningHubPageUpdateInput!){
learningHubPageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
}
Try it now
mutation learningHubPageUpdate($input: LearningHubPageUpdateInput!){
learningHubPageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPagesReorder
Reorder all LearningHubPage
resources.
Parameters for LearningHubPagesReorderMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPagesReorder($input: LearningHubPagesReorderInput!){
learningHubPagesReorder(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"learningHubPages": [
{
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
]
}
}
Try it now
mutation learningHubPagesReorder($input: LearningHubPagesReorderInput!){
learningHubPagesReorder(input: $input){
clientMutationId
success
}
}
{
"input": {
"learningHubPages": [
{
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPagesReorder": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseCreate
Create License
resource.
Parameters for LicenseCreateMutation
Example
Request Content-Types:
application/json
Query
mutation licenseCreate($input: LicenseCreateInput!){
licenseCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userIds": [
"string"
],
"branchPlanId": "string",
"planId": "string",
"seatExclusion": "boolean"
}
}
Try it now
mutation licenseCreate($input: LicenseCreateInput!){
licenseCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"userIds": [
"string"
],
"branchPlanId": "string",
"planId": "string",
"seatExclusion": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseRemove
Invalidate License
resource.
Parameters for LicenseRemoveMutation
Example
Request Content-Types:
application/json
Query
mutation licenseRemove($input: LicenseRemoveMutationInput!){
licenseRemove(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation licenseRemove($input: LicenseRemoveMutationInput!){
licenseRemove(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseRemove": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseUpdate
Update License
resource.
Parameters for LicenseUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation licenseUpdate($input: LicenseUpdateInput!){
licenseUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"validUntil": "object"
}
}
Try it now
mutation licenseUpdate($input: LicenseUpdateInput!){
licenseUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"validUntil": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification localeUpdate
Update Locale
resource.
Parameters for LocaleUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation localeUpdate($input: LocaleUpdateInput!){
localeUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "number",
"overrides": "object"
}
}
Try it now
mutation localeUpdate($input: LocaleUpdateInput!){
localeUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "number",
"overrides": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"localeUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentCoursesUpdate
Update LtiDeployment
resource's courses.
Parameters for LtiDeploymentUpdateCoursesMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentCoursesUpdate($input: LtiDeploymentUpdateCoursesInput!){
ltiDeploymentCoursesUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
]
}
}
Try it now
mutation ltiDeploymentCoursesUpdate($input: LtiDeploymentUpdateCoursesInput!){
ltiDeploymentCoursesUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentCoursesUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentCreate
Create LtiDeployment
resource.
Parameters for LtiDeploymentCreateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentCreate($input: LtiDeploymentCreateInput!){
ltiDeploymentCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"toolId": "string",
"branchId": "string",
"enableNrps": "boolean",
"contentPackageIds": [
"string"
]
}
}
Try it now
mutation ltiDeploymentCreate($input: LtiDeploymentCreateInput!){
ltiDeploymentCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"toolId": "string",
"branchId": "string",
"enableNrps": "boolean",
"contentPackageIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentDelete
Delete LtiDeployment
resource.
Parameters for LtiDeploymentDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentDelete($input: LtiDeploymentDeleteInput!){
ltiDeploymentDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation ltiDeploymentDelete($input: LtiDeploymentDeleteInput!){
ltiDeploymentDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentUpdate
Update Deployment
resource.
Parameters for LtiDeploymentUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentUpdate($input: LtiDeploymentUpdateInput!){
ltiDeploymentUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"branchId": "string",
"enableNrps": "boolean",
"ltiContextClaimType": "string"
}
}
Try it now
mutation ltiDeploymentUpdate($input: LtiDeploymentUpdateInput!){
ltiDeploymentUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"branchId": "string",
"enableNrps": "boolean",
"ltiContextClaimType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolCreate
Create LtiTool
resource.
Parameters for LtiToolCreateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolCreate($input: LtiToolCreateInput!){
ltiToolCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"branchId": "string"
}
}
Try it now
mutation ltiToolCreate($input: LtiToolCreateInput!){
ltiToolCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"branchId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolDelete
Delete LtiTool
resource.
Parameters for LtiToolDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolDelete($input: LtiToolDeleteInput!){
ltiToolDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation ltiToolDelete($input: LtiToolDeleteInput!){
ltiToolDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolUpdate
Update LtiTool
resource.
Parameters for LtiToolUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolUpdate($input: LtiToolUpdateInput!){
ltiToolUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"clientId": "string",
"keysetUrl": "string",
"oauth2Url": "string",
"oauth2Aud": "string",
"platformOidcAuthUrl": "string",
"roleMapping": "object"
}
}
Try it now
mutation ltiToolUpdate($input: LtiToolUpdateInput!){
ltiToolUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"clientId": "string",
"keysetUrl": "string",
"oauth2Url": "string",
"oauth2Aud": "string",
"platformOidcAuthUrl": "string",
"roleMapping": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification marketingPageUpdate
Update MarketingPage
branding resource.
Parameters for MarketingPageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation marketingPageUpdate($input: PageComponentInput!){
marketingPageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"variables": "object",
"html": "string",
"isDefault": "boolean"
}
}
Try it now
mutation marketingPageUpdate($input: PageComponentInput!){
marketingPageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"variables": "object",
"html": "string",
"isDefault": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"marketingPageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageCreate
Create Message
resource.
Parameters for MessageCreateMutation
Example
Request Content-Types:
application/json
Query
mutation messageCreate($input: MessageCreateInput!){
messageCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"title": "string",
"body": "string",
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Try it now
mutation messageCreate($input: MessageCreateInput!){
messageCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"title": "string",
"body": "string",
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageDelete
Delete Message
resource.
Parameters for MessageDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation messageDelete($input: MessageDeleteInput!){
messageDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation messageDelete($input: MessageDeleteInput!){
messageDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageUpdate
Update Message
resource.
Parameters for MessageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation messageUpdate($input: MessageUpdateInput!){
messageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"title": "string",
"body": "string",
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Try it now
mutation messageUpdate($input: MessageUpdateInput!){
messageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"title": "string",
"body": "string",
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification planCreate
Create Plan
resource.
Parameters for PlanCreateMutation
Example
Request Content-Types:
application/json
Query
mutation planCreate($input: PlanCreateInput!){
planCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "string",
"finalAccessDate": "string",
"firstActivationDate": "object",
"kind": "string",
"contentPackageIds": [
"string"
],
"planType": "string"
}
}
Try it now
mutation planCreate($input: PlanCreateInput!){
planCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "string",
"finalAccessDate": "string",
"firstActivationDate": "object",
"kind": "string",
"contentPackageIds": [
"string"
],
"planType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"planCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification planUpdate
Update Plan
resource.
Parameters for PlanUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation planUpdate($input: PlanUpdateInput!){
planUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "number",
"finalAccessDate": "string",
"firstActivationDate": "string"
}
}
Try it now
mutation planUpdate($input: PlanUpdateInput!){
planUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "number",
"finalAccessDate": "string",
"firstActivationDate": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"planUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification productCategoryAssignmentsUpdate
Update ProductCategoryAssignment
resource for a product.
Parameters for ProductCategoryAssignmentsUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation productCategoryAssignmentsUpdate($input: ProductCategoryAssignmentsUpdateInput!){
productCategoryAssignmentsUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"categorizableId": "string",
"categorizableType": "string",
"productCategoryIds": [
"string"
]
}
}
Try it now
mutation productCategoryAssignmentsUpdate($input: ProductCategoryAssignmentsUpdateInput!){
productCategoryAssignmentsUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"categorizableId": "string",
"categorizableType": "string",
"productCategoryIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productCategoryAssignmentsUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification recognitionTypeCreate
Create RecognitionType
resource.
Parameters for RecognitionTypeCreateMutation
Example
Request Content-Types:
application/json
Query
mutation recognitionTypeCreate($input: RecognitionTypeCreateInput!){
recognitionTypeCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"awardType": "string"
}
}
Try it now
mutation recognitionTypeCreate($input: RecognitionTypeCreateInput!){
recognitionTypeCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"awardType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitionTypeCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification recognitionTypeDelete
Delete RecognitionType
resource.
Parameters for RecognitionTypeDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation recognitionTypeDelete($input: RecognitionTypeDeleteInput!){
recognitionTypeDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation recognitionTypeDelete($input: RecognitionTypeDeleteInput!){
recognitionTypeDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitionTypeDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification recognitionTypeUpdate
Update RecognitionType
resource.
Parameters for RecognitionTypeUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation recognitionTypeUpdate($input: RecognitionTypeUpdateInput!){
recognitionTypeUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string"
}
}
Try it now
mutation recognitionTypeUpdate($input: RecognitionTypeUpdateInput!){
recognitionTypeUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitionTypeUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification roleCreate
Create Role
resource.
Parameters for RoleCreateMutation
Example
Request Content-Types:
application/json
Query
mutation roleCreate($input: RoleCreateInput!){
roleCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"slug": "string",
"name": "string",
"permissionSlugs": [
"string"
],
"description": "string"
}
}
Try it now
mutation roleCreate($input: RoleCreateInput!){
roleCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"slug": "string",
"name": "string",
"permissionSlugs": [
"string"
],
"description": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"roleCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification roleDelete
Delete Role
resource.
Parameters for RoleDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation roleDelete($input: RoleDeleteMutationInput!){
roleDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation roleDelete($input: RoleDeleteMutationInput!){
roleDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"roleDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification roleUpdate
Update Role
resource.
Parameters for RoleUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation roleUpdate($input: RoleUpdateInput!){
roleUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"description": "string",
"permissionSlugs": [
"string"
]
}
}
Try it now
mutation roleUpdate($input: RoleUpdateInput!){
roleUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"description": "string",
"permissionSlugs": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"roleUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification standardTagCreate
Create StandardTag
resource.
Parameters for StandardTagCreateMutation
Example
Request Content-Types:
application/json
Query
mutation standardTagCreate($input: StandardTagCreateInput!){
standardTagCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"code": "string",
"parentId": "string",
"displayOnWebapp": "boolean",
"displayOnLearningHub": "boolean"
}
}
Try it now
mutation standardTagCreate($input: StandardTagCreateInput!){
standardTagCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"code": "string",
"parentId": "string",
"displayOnWebapp": "boolean",
"displayOnLearningHub": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"standardTagCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification standardTagDelete
Delete StandardTag
resource.
Parameters for StandardTagDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation standardTagDelete($input: StandardTagDeleteInput!){
standardTagDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation standardTagDelete($input: StandardTagDeleteInput!){
standardTagDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"standardTagDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification standardTagUpdate
Update StandardTag
resource.
Parameters for StandardTagUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation standardTagUpdate($input: StandardTagUpdateInput!){
standardTagUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"code": "string",
"parentId": "string",
"displayOnWebapp": "boolean",
"displayOnLearningHub": "boolean"
}
}
Try it now
mutation standardTagUpdate($input: StandardTagUpdateInput!){
standardTagUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"code": "string",
"parentId": "string",
"displayOnWebapp": "boolean",
"displayOnLearningHub": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"standardTagUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification subscriptionCreate
Deprecated by VoucherRedemption
mutation
Create Subscription
resource.
Parameters for SubscriptionCreateMutation
Example
Request Content-Types:
application/json
Query
mutation subscriptionCreate($input: SubscriptionCreateInput!){
subscriptionCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userId": "string",
"voucherToken": "string"
}
}
Try it now
mutation subscriptionCreate($input: SubscriptionCreateInput!){
subscriptionCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"userId": "string",
"voucherToken": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"subscriptionCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userActivate
Activate User
resource.
Parameters for UserActivateMutation
Example
Request Content-Types:
application/json
Query
mutation userActivate($input: UserActivateMutationInput!){
userActivate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation userActivate($input: UserActivateMutationInput!){
userActivate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userActivate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userCreate
Create User
resource.
Parameters for UserCreateMutation
Example
Request Content-Types:
application/json
Query
mutation userCreate($input: UserCreateInput!){
userCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"email": "string",
"sisId": "string",
"password": "string",
"passwordConfirmation": "string"
}
}
Try it now
mutation userCreate($input: UserCreateInput!){
userCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"email": "string",
"sisId": "string",
"password": "string",
"passwordConfirmation": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userDeactivate
Deactivate User
resource.
Parameters for UserDeactivateMutation
Example
Request Content-Types:
application/json
Query
mutation userDeactivate($input: UserDeactivateMutationInput!){
userDeactivate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation userDeactivate($input: UserDeactivateMutationInput!){
userDeactivate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userDeactivate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRemoveGroups
Remove User
from all associated Group
s.
Parameters for UserRemoveGroupsMutation
Example
Request Content-Types:
application/json
Query
mutation userRemoveGroups($input: UserRemoveGroupsInput!){
userRemoveGroups(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation userRemoveGroups($input: UserRemoveGroupsInput!){
userRemoveGroups(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRemoveGroups": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRoleCreate
Create UserRole
resource.
Parameters for UserRoleCreateMutation
Example
Request Content-Types:
application/json
Query
mutation userRoleCreate($input: UserRoleCreateInput!){
userRoleCreate(input: $input){
clientMutationId
creationGuard
success
}
}
Variables
{
"input": {
"userId": "string",
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
}
}
Try it now
mutation userRoleCreate($input: UserRoleCreateInput!){
userRoleCreate(input: $input){
clientMutationId
creationGuard
success
}
}
{
"input": {
"userId": "string",
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoleCreate": {
"clientMutationId": "string",
"creationGuard": "string",
"success": "boolean"
}
}
}
Modification userRoleDelete
Delete UserRole
resource.
Parameters for UserRoleDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation userRoleDelete($input: UserRoleDeleteMutationInput!){
userRoleDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation userRoleDelete($input: UserRoleDeleteMutationInput!){
userRoleDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoleDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRoleUpdate
Update UserRole
resource.
Parameters for UserRoleUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation userRoleUpdate($input: UserRoleUpdateInput!){
userRoleUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"properties": "object"
}
}
Try it now
mutation userRoleUpdate($input: UserRoleUpdateInput!){
userRoleUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"properties": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoleUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRolesCreate
Create multiple UserRole
resources in bulk.
Parameters for UserRolesCreateMutation
Example
Request Content-Types:
application/json
Query
mutation userRolesCreate($input: UserRolesCreateInput!){
userRolesCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"roleSlug": "string",
"userIds": [
"string"
],
"accessContextType": "string",
"accessContextId": "string"
}
}
Try it now
mutation userRolesCreate($input: UserRolesCreateInput!){
userRolesCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"roleSlug": "string",
"userIds": [
"string"
],
"accessContextType": "string",
"accessContextId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRolesCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRolesDelete
Delete multiple UserRole
resources in bulk.
Parameters for UserRolesDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation userRolesDelete($input: UserRolesDeleteMutationInput!){
userRolesDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userIds": [
"string"
],
"roleSlug": "string",
"clientMutationId": "string"
}
}
Try it now
mutation userRolesDelete($input: UserRolesDeleteMutationInput!){
userRolesDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"userIds": [
"string"
],
"roleSlug": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRolesDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRolesDeleteByAccessContext
Delete multiple UserRole
resources in bulk by AccessContext
Parameters for UserRolesDeleteByAccessContextMutation
Example
Request Content-Types:
application/json
Query
mutation userRolesDeleteByAccessContext($input: UserRolesDeleteByAccessContextInput!){
userRolesDeleteByAccessContext(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userId": "string",
"accessContextType": "string",
"accessContextId": "string"
}
}
Try it now
mutation userRolesDeleteByAccessContext($input: UserRolesDeleteByAccessContextInput!){
userRolesDeleteByAccessContext(input: $input){
clientMutationId
success
}
}
{
"input": {
"userId": "string",
"accessContextType": "string",
"accessContextId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRolesDeleteByAccessContext": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userRolesDeleteById
Delete multiple UserRole
resources in bulk by ID
Parameters for UserRolesDeleteByIdMutation
Example
Request Content-Types:
application/json
Query
mutation userRolesDeleteById($input: UserRolesDeleteByIdMutationInput!){
userRolesDeleteById(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"ids": [
"string"
]
}
}
Try it now
mutation userRolesDeleteById($input: UserRolesDeleteByIdMutationInput!){
userRolesDeleteById(input: $input){
clientMutationId
success
}
}
{
"input": {
"ids": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRolesDeleteById": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification userUpdate
Update User
resource.
Parameters for UserUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation userUpdate($input: UserUpdateInput!){
userUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"email": "string",
"password": "string",
"passwordConfirmation": "string",
"sisId": "string",
"extendedTimeAccommodation": "boolean"
}
}
Try it now
mutation userUpdate($input: UserUpdateInput!){
userUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"email": "string",
"password": "string",
"passwordConfirmation": "string",
"sisId": "string",
"extendedTimeAccommodation": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification usersBulkDeactivate
Deactivate multiple User
resources.
Parameters for BulkDeactivateMutation
Example
Request Content-Types:
application/json
Query
mutation usersBulkDeactivate($input: UsersBulkDeactivateInput!){
usersBulkDeactivate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userIds": [
"string"
]
}
}
Try it now
mutation usersBulkDeactivate($input: UsersBulkDeactivateInput!){
usersBulkDeactivate(input: $input){
clientMutationId
success
}
}
{
"input": {
"userIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"usersBulkDeactivate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification usersCreate
Queue asynchronous process to create multiple User
resources.
Parameters for UsersCreateMutation
Example
Request Content-Types:
application/json
Query
mutation usersCreate($input: UsersCreateInput!){
usersCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
Variables
{
"input": {
"fileName": "string",
"dataFormat": "string",
"users": [
{
"name": "string",
"email": "string",
"password": "string",
"sisId": "string"
}
],
"branchId": "string",
"groupId": "string",
"role": {
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
},
"branchPlanId": "string"
}
}
Try it now
mutation usersCreate($input: UsersCreateInput!){
usersCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
{
"input": {
"fileName": "string",
"dataFormat": "string",
"users": [
{
"name": "string",
"email": "string",
"password": "string",
"sisId": "string"
}
],
"branchId": "string",
"groupId": "string",
"role": {
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
},
"branchPlanId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"usersCreate": {
"clientMutationId": "string",
"success": "boolean",
"uploadStatus": "string"
}
}
}
Modification usersGroupAssign
Assign multiple User
resources to Groups
.
Parameters for UsersGroupAssignMutation
Example
Request Content-Types:
application/json
Query
mutation usersGroupAssign($input: UsersGroupAssignInput!){
usersGroupAssign(input: $input){
clientMutationId
success
uploadStatus
}
}
Variables
{
"input": {
"fileName": "string",
"dataFormat": "string",
"users": [
{
"userId": "string",
"groupId": "string"
}
]
}
}
Try it now
mutation usersGroupAssign($input: UsersGroupAssignInput!){
usersGroupAssign(input: $input){
clientMutationId
success
uploadStatus
}
}
{
"input": {
"fileName": "string",
"dataFormat": "string",
"users": [
{
"userId": "string",
"groupId": "string"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"usersGroupAssign": {
"clientMutationId": "string",
"success": "boolean",
"uploadStatus": "string"
}
}
}
Modification voucherCreate
Create Voucher
resource.
Parameters for VoucherCreateMutation
Example
Request Content-Types:
application/json
Query
mutation voucherCreate($input: VoucherCreateInput!){
voucherCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"planId": "string",
"branchPlanId": "string",
"count": "number",
"maxUseCount": "number",
"token": "string"
}
}
Try it now
mutation voucherCreate($input: VoucherCreateInput!){
voucherCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"planId": "string",
"branchPlanId": "string",
"count": "number",
"maxUseCount": "number",
"token": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"voucherCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification voucherRedemption
Redeem a Voucher
on behalf of a User.
Parameters for VoucherRedemptionMutation
Example
Request Content-Types:
application/json
Query
mutation voucherRedemption($input: VoucherRedemptionInput!){
voucherRedemption(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userId": "string",
"voucherToken": "string"
}
}
Try it now
mutation voucherRedemption($input: VoucherRedemptionInput!){
voucherRedemption(input: $input){
clientMutationId
success
}
}
{
"input": {
"userId": "string",
"voucherToken": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"voucherRedemption": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification voucherUpdate
Update Voucher
resource.
Parameters for VoucherUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation voucherUpdate($input: VoucherUpdateInput!){
voucherUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"maxUseCount": "number"
}
}
Try it now
mutation voucherUpdate($input: VoucherUpdateInput!){
voucherUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"maxUseCount": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"voucherUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification webhookCreate
Create Webhook
resource.
Parameters for WebhookCreateMutation
Example
Request Content-Types:
application/json
Query
mutation webhookCreate($input: WebhookCreateInput!){
webhookCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"url": "string",
"enabled": "boolean",
"eventType": "string",
"contentLocation": "string",
"customHeaders": "object",
"formatter": "string"
}
}
Try it now
mutation webhookCreate($input: WebhookCreateInput!){
webhookCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"url": "string",
"enabled": "boolean",
"eventType": "string",
"contentLocation": "string",
"customHeaders": "object",
"formatter": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification webhookResendDelivery
Resend delivery for a WebhookDelivery
resource.
Parameters for WebhookResendDeliveryMutation
Example
Request Content-Types:
application/json
Query
mutation webhookResendDelivery($input: WebhookResendDeliveryMutationInput!){
webhookResendDelivery(input: $input){
clientMutationId
deliveryJobInProgress
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation webhookResendDelivery($input: WebhookResendDeliveryMutationInput!){
webhookResendDelivery(input: $input){
clientMutationId
deliveryJobInProgress
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookResendDelivery": {
"clientMutationId": "string",
"deliveryJobInProgress": "boolean",
"success": "boolean"
}
}
}
Modification webhookTest
Trigger a test event for a Webhook
resource.
Parameters for WebhookTestMutation
Example
Request Content-Types:
application/json
Query
mutation webhookTest($input: WebhookTestMutationInput!){
webhookTest(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation webhookTest($input: WebhookTestMutationInput!){
webhookTest(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookTest": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification webhookUpdate
Update Webhook
resource.
Parameters for WebhookUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation webhookUpdate($input: WebhookUpdateInput!){
webhookUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"url": "string",
"enabled": "boolean",
"eventType": "string",
"contentLocation": "string",
"customHeaders": "object"
}
}
Try it now
mutation webhookUpdate($input: WebhookUpdateInput!){
webhookUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"url": "string",
"enabled": "boolean",
"eventType": "string",
"contentLocation": "string",
"customHeaders": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Schema Definitions
AccessContext:
An AccessContext specifies the logical grouping of resources to which a UserRole has access
Example
AccessContextEnum: string
-
objectBranch
-
Permission has access to Branch context.
-
objectContentPackage
-
Permission has access to ContentPackage context.
-
objectGroup
-
Permission has access to Group context.
-
objectSystem
-
Permission has access to System context.
-
objectTenant
-
Permission has access to Tenant context.
AccessTokenRedemption: object
Represents information about a Voucher redemption
-
createdAt:
object
-
Timestamp when the Voucher was redeemed.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the
AccessTokenRedemption
. -
- return:
-
arguments:
object
-
-
license:
object
-
License
associated with theAccessTokenRedemption
. -
- return:
-
arguments:
object
-
-
user:
object
-
User
associated with theAccessTokenRedemption
. -
- return:
-
arguments:
object
-
Example
{
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
AccessTokenRedemptionFilter: object
Input fields for voucher search
- userQuery:
-
Smart search across User ID, SIS ID, name, and email
Example
{
"userQuery": "string"
}
AccessTokenRedemptionSortAttributes: string
-
objectid
-
Sort by ID
-
objectuser_id
-
Sort by the User ID
-
objectcreated_at
-
Sort by time of redmeption
AccessTokenRedemptionSortOrderFilter: object
- order:
- by:
Example
{
"order": "string",
"by": "string"
}
AccessTokenRedemptionsConnection: object
The connection type for AccessTokenRedemption.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
AccessTokenRedemptionsEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {}
}
}
}
}
}
}
}
}
}
}
}
}
}
BannerMessage: object
Represents information about a Banner Message.
-
body:
object
-
The body for the BannerMessage.
-
- return:
-
arguments:
object
-
-
contentPackage:
object
-
ContentPackage of the BannerMessage.
-
- return:
-
arguments:
object
-
-
contentPackageId:
object
-
ID of the Content Package where the BannerMessage should show in webapp.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Creation date of the BannerMessage.
-
- return:
-
arguments:
object
-
-
destinations:
object
-
Applications the message was sent to.
-
- return:
-
arguments:
object
-
-
endDate:
object
-
The end date for the BannerMessage.
-
- return:
-
arguments:
object
-
-
eventTrigger:
object
-
The EventTrigger that subscribes to events for an automated BannerMessage delivery.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the BannerMessage.
-
- return:
-
arguments:
object
-
-
name:
object
-
The name of the BannerMessage.
-
- return:
-
arguments:
object
-
-
startDate:
object
-
The start date for the BannerMessage.
-
- return:
-
arguments:
object
-
-
state:
object
-
The activation state of the BannerMessage.
-
- return:
-
arguments:
object
-
-
userSegment:
object
-
The UserSegment specifying to which users this BannerMessage will be delivered.
-
- return:
-
arguments:
object
-
Example
{
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {}
}
}
}
BannerMessageConnection: object
The connection type for BannerMessage.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string"
}
}
]
}
}
}
}
}
}
]
}
}
BannerMessageCreateInput: object
- name:
- body:
- startDate:
- endDate:
- destinations:
- contentPackageId:
- userSegment:
- eventTrigger:
Example
{
"name": "string",
"body": "string",
"startDate": "object",
"endDate": "object",
"destinations": [
"string"
],
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
BannerMessageCreateMutationPayload: object
Autogenerated return type of BannerMessageCreateMutation
-
bannerMessage:
object
-
BannerMessage
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"bannerMessage": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string"
}
}
]
}
}
}
}
}
}
BannerMessageDeleteMutationPayload: object
Autogenerated return type of BannerMessageDeleteMutation
-
bannerMessage:
object
-
BannerMessage
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"bannerMessage": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string"
}
}
]
}
}
}
}
}
}
BannerMessageEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string"
}
}
]
}
}
}
}
}
}
BannerMessageFilter: object
Input fields for BannerMessage search
- ids:
-
Search by IDs
- query:
-
Smart search by ID, Body and Name
- state:
-
Filter banner messages by state
- destination:
-
Filter banner messages by destination
Example
{
"ids": [
"string"
],
"query": "string",
"state": "string",
"destination": "string"
}
BannerMessageSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by Name
-
objectstart_date
-
Sort by Start Date
-
objectend_date
-
Sort by End Date
-
objectcreated_at
-
Sort by Created At
-
objectstate
-
Sort by State
BannerMessageUpdateInput: object
- id:
- name:
- body:
- destinations:
- contentPackageId:
- startDate:
- endDate:
- eventTrigger:
Example
{
"id": "string",
"name": "string",
"body": "string",
"destinations": [
"string"
],
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
BannerMessageUpdateMutationPayload: object
Autogenerated return type of BannerMessageUpdateMutation
-
bannerMessage:
object
-
BannerMessage
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"bannerMessage": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string"
}
}
]
}
}
}
}
}
}
BasePlanInterface: object
Represents agreement on what a BasePlan must have
-
activatedLicenseCount:
object
-
Number of associated licenses that were activated
-
- return:
-
arguments:
object
-
-
activeLicenseCount:
object
-
Number of licenses that have learner activity
-
- return:
-
arguments:
object
-
-
availableSeatCount:
object
-
Number of seats available to be used
-
- return:
-
arguments:
object
-
-
duration:
object
-
Duration of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
durationUnit:
object
-
Duration units
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External ID of BasePlanInterface
-
- return:
-
arguments:
object
-
-
finalAccessDate:
object
-
Final date when all learner access gets cut off
-
- return:
-
arguments:
object
-
-
finalAdminAccessDate:
object
-
Final date when all admin access gets cut off
-
- return:
-
arguments:
object
-
-
firstActivationDate:
object
-
First date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
lastActivationDate:
object
-
Last date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
licenseCount:
object
-
Number of associated licenses
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the
BasePlanInterface
. -
- return:
-
arguments:
object
-
-
seatCount:
object
-
Number of seats
-
- return:
-
arguments:
object
-
-
seatCountType:
object
-
Type of the seating
-
- return:
-
arguments:
object
-
-
usedSeatCount:
object
-
Number of seats used
-
- return:
-
arguments:
object
-
-
validFrom:
object
-
Date from which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
-
validTo:
object
-
Date until which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
Example
{
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"durationUnit": {
"return": "string",
"arguments": {}
},
"externalId": {
"return": "string",
"arguments": {}
},
"finalAccessDate": {
"return": "object",
"arguments": {}
},
"finalAdminAccessDate": {
"return": "object",
"arguments": {}
},
"firstActivationDate": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"lastActivationDate": {
"return": "object",
"arguments": {}
},
"licenseCount": {
"return": "number",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"seatCount": {
"return": "number",
"arguments": {}
},
"seatCountType": {
"return": "string",
"arguments": {}
},
"usedSeatCount": {
"return": "number",
"arguments": {}
},
"validFrom": {
"return": "object",
"arguments": {}
},
"validTo": {
"return": "object",
"arguments": {}
}
}
Branch: object
Represents information for branches for a tenant.
-
appliedBranding:
object
-
The Branding applied to Users in this Branch. This may fall back to a Branch ancestor's Branding or Tenant's Branding if this Branch's
branding
is null. -
- return:
-
arguments:
object
-
-
branding:
object
-
The Branding record associated to the Branch.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the Branch was created.
-
- return:
-
arguments:
object
-
-
deletionGuard:
object
-
Indicates why the Branch cannot be deleted if it cannot be deleted. If the Branch can be deleted, then this field returns null.
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External ID of the Branch.
-
- return:
-
arguments:
object
-
-
featureAccesses:
object
-
List of current
BranchFeatureAccess
s for the branch. -
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Branch.
-
- return:
-
arguments:
object
-
-
isParent:
object
-
Indicates if the Branch is a parent to other Branches.
-
- return:
-
arguments:
object
-
-
isSynced:
object
-
Indicates if the Branch is associated with a legacy B2B hierarchy.
-
- return:
-
arguments:
object
-
-
legacyHierarchyNodeId:
object
-
ID of the legacy B2B hierarchy node.
-
- return:
-
arguments:
object
-
-
legacyHierarchyNodeType:
object
-
Type of the legacy B2B hierarchy node.
-
- return:
-
arguments:
object
-
-
loginUrl:
object
-
Login URL with Branch branding.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Branch.
-
- return:
-
arguments:
object
-
-
parentBranchId:
object
-
ID of the Branch of the parent.
-
- return:
-
arguments:
object
-
-
slug:
object
-
A unique slug used to generate URLs specific to the Branch
-
- return:
-
arguments:
object
-
-
voucherRedemptionUrl:
object
-
URL for Voucher redemption with Branch specific branding and membership behavior.
-
- return:
-
arguments:
object
-
Example
{
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
}
}
}
}
BranchAssignUsersMutationPayload: object
Autogenerated return type of BranchAssignUsersMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
results:
object
-
Contains Array of
User
resources participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"results": {
"return": [
{
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {}
}
}
}
}
}
}
}
]
}
}
BranchAssignUsersResult: object
-
errors:
object
-
Array of
RecordError
errors from the service response. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates successfull service response.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
resource response for the mutation. -
- return:
-
arguments:
object
-
Example
{
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
BranchConnection: object
The connection type for Branch.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {}
}
}
}
}
}
]
}
}
BranchCreateMutationPayload: object
Autogenerated return type of BranchCreateMutation
-
branch:
object
-
Branch
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
BranchDeleteMutationPayload: object
Autogenerated return type of BranchDeleteMutation
-
branch:
object
-
Branch
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
BranchDeletionGuardErrorEnum: string
-
objectcontains_branch_plan
-
This Branch or one of its descendants has an associated BranchPlan. This Branch cannot be deleted.
-
objectcontains_group
-
This Branch or one of its descendants has an associated Group. This Branch cannot be deleted.
BranchEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {}
}
}
}
}
}
BranchFilter: object
Input fields for branch search
- ids:
-
Search by IDs
- parentBranchId:
-
Search by parent branch ID
- rootOnly:
-
Search only for branches that do not have a parent
- excludedBranchId:
-
Exclude branch that matches ID and all its descendant branches
- treeByBranchId:
-
Search branch that matches ID and all its descendant branches
- treeByBranchIdExcludingSelf:
-
Search all descendant branches, excluding branch with ID from results
- canHaveChildren:
-
Return Branches with depth less than 10.
- query:
-
Smart search by ID, Name and External ID
- ancestorsByBranchId:
-
Search branch that matches ID and its ancestors
Example
{
"ids": [
"string"
],
"parentBranchId": "string",
"rootOnly": "boolean",
"excludedBranchId": "string",
"treeByBranchId": "string",
"treeByBranchIdExcludingSelf": "string",
"canHaveChildren": "boolean",
"query": "string",
"ancestorsByBranchId": "string"
}
BranchPlan: object
Represents information about a contract of a Branch
.
-
activatedLicenseCount:
object
-
Number of associated licenses that were activated
-
- return:
-
arguments:
object
-
-
activeLicenseCount:
object
-
Number of licenses that have learner activity
-
- return:
-
arguments:
object
-
-
availableSeatCount:
object
-
Number of seats available to be used
-
- return:
-
arguments:
object
-
-
branch:
object
-
Branch
(resolver) associated with the BranchPlan. -
- return:
-
arguments:
object
-
-
branchId:
object
-
ID of the associated Branch
-
- return:
-
arguments:
object
-
-
concurrentUserLimit:
object
-
Number of users concurrently allowed to access the platform.
-
- return:
-
arguments:
object
-
-
contentPackages:
object
-
List of
ContentPackage
s (resolver) permitted by the BranchPlan. -
- return:
-
arguments:
object
-
-
duration:
object
-
Duration of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
durationUnit:
object
-
Duration units
-
- return:
-
arguments:
object
-
-
enableInBrowse:
object
-
Indicates if the associated resources are browsable in Learning Hub
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External ID of BasePlanInterface
-
- return:
-
arguments:
object
-
-
finalAccessDate:
object
-
Final date when all learner access gets cut off
-
- return:
-
arguments:
object
-
-
finalAdminAccessDate:
object
-
Final date when all admin access gets cut off
-
- return:
-
arguments:
object
-
-
firstActivationDate:
object
-
First date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
isSynced:
object
-
Indicates if the BranchPlan is associated with a legacy InstitutionContract.
-
- return:
-
arguments:
object
-
-
lastActivationDate:
object
-
Last date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
licenseCount:
object
-
Number of associated licenses
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the
BasePlanInterface
. -
- return:
-
arguments:
object
-
-
seatCount:
object
-
Number of seats
-
- return:
-
arguments:
object
-
-
seatCountType:
object
-
Type of the seating
-
- return:
-
arguments:
object
-
-
status:
object
-
Status of the BranchPlan
-
- return:
-
arguments:
object
-
-
usedSeatCount:
object
-
Number of seats used
-
- return:
-
arguments:
object
-
-
validFrom:
object
-
Date from which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
-
validTo:
object
-
Date until which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
Example
{
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
}
}
BranchPlanConnection: object
The connection type for BranchPlan.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {}
}
}
}
}
}
}
}
]
}
}
BranchPlanCreateInput: object
- name:
- externalId:
- branchId:
- validFrom:
- validTo:
- duration:
- seatCountType:
- firstActivationDate:
- lastActivationDate:
- finalAccessDate:
- finalAdminAccessDate:
- seatCount:
- concurrentUserLimit:
- enableInBrowse:
- contentPackageIds:
Example
{
"name": "string",
"externalId": "string",
"branchId": "string",
"validFrom": "object",
"validTo": "object",
"duration": "string",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"enableInBrowse": "boolean",
"contentPackageIds": [
"string"
]
}
BranchPlanCreateMutationPayload: object
Autogenerated return type of BranchPlanCreateMutation
-
branchPlan:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {}
}
}
}
}
}
}
}
BranchPlanEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {}
}
}
}
}
}
}
}
BranchPlanSortAttributes: string
-
objectactivated_license_count
-
Sort by activated license count
-
objectexternal_id
-
Sort by external ID
-
objectid
-
Sort by ID
-
objectlicense_count
-
Sort by license count
-
objectname
-
Sort by name
-
objectseat_count
-
Sort by seat count
-
objectstatus
-
Sort by status
-
objectused_seat_count
-
Sort by used seat count
-
objectvalid_from
-
Sort by valid from
-
objectvalid_to
-
Sort by valid to
BranchPlanUpdateCoursesMutationPayload: object
Autogenerated return type of BranchPlanUpdateCoursesMutation
-
branchPlan:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {}
}
}
}
}
}
}
}
BranchPlanUpdateInput: object
- id:
- name:
- externalId:
- enableInBrowse:
- validFrom:
- validTo:
- duration:
- seatCountType:
- firstActivationDate:
- lastActivationDate:
- finalAccessDate:
- finalAdminAccessDate:
- seatCount:
- concurrentUserLimit:
- durationUnit:
Example
{
"id": "string",
"name": "string",
"externalId": "string",
"enableInBrowse": "boolean",
"validFrom": "object",
"validTo": "object",
"duration": "number",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"durationUnit": "string"
}
BranchPlanUpdateMutationPayload: object
Autogenerated return type of BranchPlanUpdateMutation
-
branchPlan:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {}
}
}
}
}
}
}
}
BranchUpdateMutationPayload: object
Autogenerated return type of BranchUpdateMutation
-
branch:
object
-
Branch
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
Branding: object
Represents information for how a brandable resource is branded.
-
brandableId:
object
-
The ID of the Brandable that the branding is associated with
-
- return:
-
arguments:
object
-
-
brandableType:
object
-
The type of the Brandable (eg.
Tenant
,Branch
orGroup
) that the branding is associated with -
- return:
-
arguments:
object
-
-
colorLogoUrl:
object
-
The URL for the color logo.
-
- return:
-
arguments:
object
-
-
emailLogoUrl:
object
-
The URL for the email logo.
-
- return:
-
arguments:
object
-
-
faviconUrl:
object
-
The URL for the favicon.
-
- return:
-
arguments:
object
-
-
footer:
object
-
Footer of the Branding using
PageComponentType
. -
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Branding.
-
- return:
-
arguments:
object
-
-
marketingPage:
object
-
Marketing page of the Branding using
PageComponentType
. -
- return:
-
arguments:
object
-
-
mobileIconUrl:
object
-
The URL for the mobile icon.
-
- return:
-
arguments:
object
-
-
primaryColor:
object
-
Primary color of the Branding.
-
- return:
-
arguments:
object
-
-
secondaryColor:
object
-
Secondary color of the Branding.
-
- return:
-
arguments:
object
-
-
whiteLogoUrl:
object
-
The URL for the white logo.
-
- return:
-
arguments:
object
-
Example
{
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
}
BulkDeactivateMutationPayload: object
Autogenerated return type of BulkDeactivateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
CertificateConnection: object
The connection type for Certificate.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
CertificateEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
Client: object
Represents information about a client for an enrollment
-
id:
object
-
ID of the Client.
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
}
}
ColorUpdateMutationPayload: object
Autogenerated return type of ColorUpdateMutation
-
branding:
object
-
Branding
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
null
]
}
}
]
}
}
ContentLocation: object
Represents information about a EventTrigger content location.
-
id:
object
-
ID of the content location model.
-
- return:
-
arguments:
object
-
-
name:
object
-
The name of the content location model.
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
ContentPackage: object
Represents information about a content package of the platform
-
bannerImageUrl:
object
-
URL of the image to display for the ContentPackage in the catalog.
-
- return:
-
arguments:
object
-
-
collaboratorEmails:
object
-
Array of the emails of collaborators of the ContentPackage.
-
- return:
-
arguments:
object
-
-
courseType:
object
-
User portal ContentPackage or ascend/engage ContentPackage.
-
- return:
-
arguments:
object
-
-
deactivatedAt:
object
-
Timestamp of the date when the ContentPackage was/is to be deactivated
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the ContentPackage.
-
- return:
-
arguments:
object
-
-
enrollmentsCount:
object
-
Number of enrollments for the ContentPackage.
-
- return:
-
arguments:
object
-
-
featureAccesses:
object
-
Array of the
ContentPackageFeatureAccess
resources for the ContentPackage. -
- return:
-
arguments:
object
-
-
features:
object
-
Content count summary for the ContentPackage
-
- return:
-
arguments:
object
-
-
graderCategories:
object
-
Array of categories used for grading assignments
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the ContentPackage.
-
- return:
-
arguments:
object
-
-
isRecognitionIssuing:
object
-
Boolean indicator of whether the ContentPackage issues recognitions
-
- return:
-
arguments:
object
-
-
lastBuildAt:
object
-
Timestamp of the date when ContentPackage was last built.
-
- return:
-
arguments:
object
-
-
learnableConfiguration:
object
-
LearnableConfiguration
for the ContentPackage -
- return:
-
arguments:
object
-
-
navigationItems:
object
-
Array of NavigationItems displayed for the ContentPackage
-
- return:
-
arguments:
object
-
-
reviewRating:
object
-
Average review rating of the ContentPackage.
-
- return:
-
arguments:
object
-
-
reviewRatingCount:
object
-
Count of reviews of the ContentPackage.
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the ContentPackage.
-
- return:
-
arguments:
object
-
-
state:
object
-
Status of the ContentPackage: published, conversion or retired.
-
- return:
-
arguments:
object
-
-
title:
object
-
Title of the ContentPackage.
-
- return:
-
arguments:
object
-
Example
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {
"return": "object",
"arguments": {}
},
"graderCategories": {
"return": [
"string"
]
}
}
ContentPackageConnection: object
The connection type for ContentPackage.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {}
}
]
}
}
}
}
]
}
}
ContentPackageCourse: string
The content packages' course types
-
objectasset_based_course
-
Asset-Based Course
-
objectbenchprep_course
-
BenchPrep Course
ContentPackageEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {}
}
}
}
ContentPackageFilter: object
Input fields for content package search
- ids:
-
Search by IDs
- query:
-
Smart search across ID and title
- state:
-
Current state of the content package
- excludedIds:
-
Exclude IDs
- hasStudyPlan:
-
Return content packages that have study tasks
- hasCertificates:
-
Return content packages that have certificates and 'user_certificates' feature access allowed
- hasExams:
-
Return content packages that have exams
- bank:
-
Return content packages that are or are not banks
- hasExternalPackages:
-
Return content packages that are benchprep_course and have external packages
- enrolledFor:
-
Return enrolled content packages for the given user ID
- courseType:
-
Search by Course Type
- hasMilestones:
-
Return content packages that have milestones
- isRecognitionIssuing:
-
Return content packages based on ability to issue recognitions or not
- hasRecognitions:
-
Return content packages that have recognitions
- branchPlanIdPlusContentPackageIds:
-
Return content packages for the given branch plan ID, plus additional content package IDs
- notBranchPlanIdPlusContentPackageIds:
-
Return content packages not for the given branch plan ID, plus additional content package IDs
- ltiDeploymentIdPlusContentPackageIds:
-
Return content packages for the given LTI deployment ID, plus additional content package IDs
- notLtiDeploymentIdPlusContentPackageIds:
-
Return content packages not for the given LTI deployment ID, plus additional content package IDs
Example
{
"ids": [
"string"
],
"query": "string",
"state": "string",
"excludedIds": [
"string"
],
"hasStudyPlan": "boolean",
"hasCertificates": "boolean",
"hasExams": "boolean",
"bank": "boolean",
"hasExternalPackages": "boolean",
"enrolledFor": "number",
"courseType": "string",
"hasMilestones": "boolean",
"isRecognitionIssuing": "boolean",
"hasRecognitions": "boolean",
"branchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"ltiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
},
"notLtiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
}
}
ContentPackageSortAttributes: string
-
objectid
-
Sort by ID
-
objecttitle
-
Sort by title
-
objectcourse_type
-
Sort by course_type
-
objectstate
-
Sort by state
ContentPackageState: string
The content package's valid states
-
objectdraft
-
Draft content packages
-
objectconversion
-
Conversion content packages
-
objectpublished
-
Published content packages
-
objectretired
-
Retired content packages
-
objectdeactivated
-
Deactivated content packages
ContentPackageUpdateDeactivationDateInput: object
- id:
- deactivatedAt:
Example
{
"id": "string",
"deactivatedAt": "object"
}
ContentPackageUpdateDeactivationDateMutationPayload: object
Autogenerated return type of ContentPackageUpdateDeactivationDateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
contentPackage:
object
-
Content package participating in the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {}
}
}
}
ContentType: object
Represents information about a content type
-
id:
object
-
Unique identifier ID
-
- return:
-
arguments:
object
-
-
label:
object
-
The friendly identification of this content type
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
}
}
ContentTypeConnection: object
The connection type for ContentType.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
ContentTypeEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
ControllableTypesEnum: string
-
objectTenant
-
FeatureAccess can be controlled by the Tenant controllable type.
-
objectContentPackage
-
FeatureAccess can be controlled by the ContentPackage controllable type.
-
objectInstitution
-
FeatureAccess can be controlled by the Institution controllable type.
-
objectDistrict
-
FeatureAccess can be controlled by the District controllable type.
-
objectAdministrativeDivision
-
FeatureAccess can be controlled by the AdministrativeDivision controllable type.
-
objectBranch
-
FeatureAccess can be controlled by the Branch controllable type.
CurrentTenant: object
Represents information about the current tenant of the platform. No permissions are required to read information about the current tenant, as long as you are authenticated.
-
appliedBranding:
object
-
The Branding applied to Users in this Tenant.
-
- return:
-
arguments:
object
-
-
bigCommerceSsoEnabled:
object
-
BigCommerce SAML SSO Setup and Enabled
-
- return:
-
arguments:
object
-
-
featureAccesses:
object
-
List of current
TenantFeatureAccess
s for the CurrentTenant. -
- return:
-
arguments:
object
-
- filter:
-
id:
object
-
ID of the CurrentTenant.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the CurrentTenant.
-
- return:
-
arguments:
object
-
-
publicUrl:
object
-
Public URL of the CurrentTenant.
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the CurrentTenant.
-
- return:
-
arguments:
object
-
Example
{
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"bigCommerceSsoEnabled": {
"return": "boolean",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string"
}
}
]
}
}
CurrentUser: object
Represents information about the currently authenticated user. No permissions are required to read information about the current user, as long as you are authenticated.
-
createdAt:
object
-
Timestamp when the CurrentUser was created.
-
- return:
-
arguments:
object
-
-
email:
object
-
Email address of the CurrentUser.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the CurrentUser.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the CurrentUser.
-
- return:
-
arguments:
object
-
-
permissionSlugs:
object
-
A list of the CurrentUser's permission slugs.
-
- return:
-
arguments:
object
-
-
permissions:
object
-
A list of
Permission
s of the CurrentUser's. -
- return:
-
arguments:
object
-
-
roleSlugs:
object
-
A list of the CurrentUser's role slugs.
-
- return:
-
arguments:
object
-
-
state:
object
-
Active/inactive status of the CurrentUser's account.
-
- return:
-
arguments:
object
-
-
statuses:
object
-
Various statuses associated with the CurrentUser
-
- return:
-
arguments:
object
-
-
tenant:
object
-
CurrentTenant
the CurrentUser belongs to. -
- return:
-
arguments:
object
-
-
userRoles:
object
-
UserRole
s of the CurrentUser. -
- return:
-
arguments:
object
-
-
visibleBannerMessages:
object
-
A list of
BannerMessage
s that are visible to the CurrentUser. -
- return:
-
arguments:
object
-
- filters:
Example
{
"createdAt": {
"return": "object",
"arguments": {}
},
"email": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionSlugs": {
"return": [
"string"
],
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"roleSlugs": {
"return": [
"string"
],
"arguments": {}
},
"state": {
"return": "string",
"arguments": {}
},
"statuses": {
"return": {
"csvImportLock": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
},
"tenant": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {}
}
}
}
}
}
}
}
CurrentUserBannerMessage: object
Represents information about the currently authenticated User's visible BannerMessages.
-
body:
object
-
The body for the BannerMessage.
-
- return:
-
arguments:
object
-
-
contentPackage:
object
-
ContentPackage of the BannerMessage.
-
- return:
-
arguments:
object
-
-
contentPackageId:
object
-
ID of the Content Package where the BannerMessage should show in webapp.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Creation date of the BannerMessage.
-
- return:
-
arguments:
object
-
-
destinations:
object
-
Applications the message was sent to.
-
- return:
-
arguments:
object
-
-
endDate:
object
-
The end date for the BannerMessage.
-
- return:
-
arguments:
object
-
-
eventTrigger:
object
-
The EventTrigger that subscribes to events for an automated BannerMessage delivery.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the BannerMessage.
-
- return:
-
arguments:
object
-
-
name:
object
-
The name of the BannerMessage.
-
- return:
-
arguments:
object
-
-
startDate:
object
-
The start date for the BannerMessage
-
- return:
-
arguments:
object
-
-
state:
object
-
The activation state of the BannerMessage.
-
- return:
-
arguments:
object
-
-
userSegment:
object
-
The UserSegment specifying to which users this BannerMessage will be delivered.
-
- return:
-
arguments:
object
-
Example
{
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {}
}
}
}
CurrentUserStatuses: object
Represents information about the various statuses of the currently authenticated user.
-
csvImportLock:
object
-
Indicates if csv data imports are currently locked.
-
- return:
-
arguments:
object
-
Example
{
"csvImportLock": {
"return": "boolean",
"arguments": {}
}
}
CurrentUserUserRole: object
Represents information about the currently authenticated User's UserRoles
-
accessContext:
object
-
The AccessContext associated to the CurrentUser's UserRole
-
- return:
-
arguments:
object
-
-
accessContextId:
object
-
Access context ID of the UserRole.
-
- return:
-
arguments:
object
-
-
accessContextType:
object
-
Access context type of the UserRole.
-
- return:
-
arguments:
object
-
-
applicableAccessContexts:
object
-
Array of scopes to which the
UserRole
can be applied. -
- return:
-
arguments:
object
-
-
id:
object
-
ID of the UserRole.
-
- return:
-
arguments:
object
-
-
permissionSlugs:
object
-
A list of the UserRole's permission slugs.
-
- return:
-
arguments:
object
-
- filter:
-
properties:
object
-
Set of configuration values for the specific user role
-
- return:
-
arguments:
object
-
-
role:
object
-
Role
(resolver) associated with UserRole. -
- return:
-
arguments:
object
-
-
roleSlug:
object
-
Role slug of the UserRole.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with UserRole. -
- return:
-
arguments:
object
-
-
userId:
object
-
User ID for the UserRole.
-
- return:
-
arguments:
object
-
Example
{
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"permissionSlugs": {
"return": [
"string"
],
"arguments": {
"filter": [
"string"
]
}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
}
}
}
DeleteMutationPayload: object
Autogenerated return type of DeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
DestinationTypeEnum: string
-
objectblueprint
-
objectboost
-
objectconsole
-
objectlearning_hub
-
objectwebapp
DeveloperToken: object
-
active:
object
-
Indicates if the DeveloperToken is active.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Creation date of the DeveloperToken.
-
- return:
-
arguments:
object
-
-
expiresAt:
object
-
Expiry date of the DeveloperToken.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the DeveloperToken.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the DeveloperToken.
-
- return:
-
arguments:
object
-
-
revokedAt:
object
-
Revocation date of the DeveloperToken.
-
- return:
-
arguments:
object
-
-
token:
object
-
The value of the DeveloperToken. This is only available upon first generation and is not stored directly.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with DeveloperToken. -
- return:
-
arguments:
object
-
-
userId:
object
-
User ID for the DeveloperToken.
-
- return:
-
arguments:
object
-
Example
{
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean"
}
}
}
}
}
}
}
}
}
}
DeveloperTokenConnection: object
The connection type for DeveloperToken.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {}
}
}
}
}
}
}
}
}
}
}
]
}
}
DeveloperTokenCreateMutationPayload: object
Autogenerated return type of DeveloperTokenCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
developerToken:
object
-
DeveloperToken
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"developerToken": {
"return": {
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
DeveloperTokenDeactivateMutationPayload: object
Autogenerated return type of DeveloperTokenDeactivateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
developerToken:
object
-
DeveloperToken
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"developerToken": {
"return": {
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
DeveloperTokenEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
DeveloperTokenSortAttributes: string
-
objectid
-
Sort by ID
-
objectactive
-
Sort by whether the DeveloperToken is active
-
objectcreated_at
-
Sort by createdAt
-
objectexpires_at
-
Sort by expiresAt
-
objectname
-
Sort by name
-
objectrevoked_at
-
Sort by revokedAt
-
objectuser_id
-
Sort by User ID
DeveloperTokenUpdateMutationPayload: object
Autogenerated return type of DeveloperTokenUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
developerToken:
object
-
DeveloperToken
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"developerToken": {
"return": {
"active": {
"return": "boolean",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"expiresAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"revokedAt": {
"return": "object",
"arguments": {}
},
"token": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
Domain: object
Registered masked Domain
-
expirationDate:
object
-
Timestamp of the X509 Certificate not_after field.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Domain.
-
- return:
-
arguments:
object
-
-
lastUpdated:
object
-
Timestamp of when the Domain was last updated.
-
- return:
-
arguments:
object
-
-
url:
object
-
Registered URL of the Domain.
-
- return:
-
arguments:
object
-
Example
{
"expirationDate": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"lastUpdated": {
"return": "object",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
}
DomainEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"expirationDate": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"lastUpdated": {
"return": "object",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
DomainFilter: object
Input fields for domain search
- ids:
-
Search by IDs
Example
{
"ids": [
"string"
]
}
DomainsConnection: object
The connection type for Domain.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"expirationDate": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"lastUpdated": {
"return": "object",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"expirationDate": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"lastUpdated": {
"return": "object",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
Enrollment: object
Represents information about a user's enrollment in a course
-
additionalResets:
object
-
Additional exam resets assigned for the enrollment.
-
- return:
-
arguments:
object
-
-
baseExamResetLimit:
object
-
The default number of exam resets for the enrollment.
-
- return:
-
arguments:
object
-
-
clients:
object
-
Client
s (resolver) associated with the Enrollment. -
- return:
-
arguments:
object
-
-
contentPackageId:
object
-
ID of the enrolled content package.
-
- return:
-
arguments:
object
-
-
contentPackageTitle:
object
-
Title of the enrolled content package.
-
- return:
-
arguments:
object
-
-
enrolledUntil:
object
-
Timestamp of the date until which the user has access to the content package.
-
- return:
-
arguments:
object
-
-
examResetsAllowed:
object
-
Indicates if the enrollment's content package allows exam resets.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Enrollment.
-
- return:
-
arguments:
object
-
-
npsRating:
object
-
Net Promoter Score provided by the user.
-
- return:
-
arguments:
object
-
-
status:
object
-
The user's current
EnrollmentStatus
(active/inactive) in the content package. -
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with the Enrollment. -
- return:
-
arguments:
object
-
Example
{
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
EnrollmentAssociationConnection: object
The connection type for Enrollment.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
EnrollmentConnection: object
The connection type for Enrollment.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
EnrollmentEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
EnrollmentResetMutationPayload: object
Autogenerated return type of EnrollmentResetMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
enrollment:
object
-
Enrollment
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"enrollment": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
EnrollmentSortAttributes: string
-
objectid
-
Sort by ID
-
objectstatus
-
Sort by status
-
objectcontent_package_title
-
Sort by content package title
-
objectcontent_package_id
-
Sort by content package ID
-
objectnps_rating
-
Sort by NPS Rating
-
objectenrolled_until
-
Sort by the date until which the user is enrolled in the course
-
objectuser_id
-
Sort by the user ID on the enrollment
-
objectuser_sis_id
-
Sort by the SIS ID on the enrollment's user
EnrollmentStatus: string
-
objectactive
-
User has access to the course
-
objectinactive
-
User does not have access to the course
EnrollmentUpdateMutationPayload: object
Autogenerated return type of EnrollmentUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
enrollment:
object
-
Enrollment
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"enrollment": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
EventTrigger: object
-
contentLocation:
object
-
The ContentLocation that matches (with wildcards) the ContentLocation on the Event.
-
- return:
-
arguments:
object
-
-
contentLocationModels:
object
-
Information about content location models.
-
- return:
-
arguments:
object
-
-
enabled:
object
-
Indicates whether the EventTrigger should be handled or ignored.
-
- return:
-
arguments:
object
-
-
eventType:
object
-
The EventType that matches the EventType on the Event.
-
- return:
-
arguments:
object
-
-
userSegment:
object
-
The UserSegment specifying to which Users EventTrigger will be filtered.
-
- return:
-
arguments:
object
-
Example
{
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"userSegment": {
"return": {
"componentTypes": {
"return": [
"string"
],
"arguments": {}
},
"components": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {}
}
}
}
}
}
Exam: object
Represents information about an exam
-
contentLocation:
object
-
Content location of the Exam.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Exam.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Exam.
-
- return:
-
arguments:
object
-
Example
{
"contentLocation": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
ExamConnection: object
The connection type for Exam.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"contentLocation": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
ExamEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
ExamResult: object
Represents information about an ExamResult
-
answersCount:
object
-
The number of attempted questions that a user answered
-
- return:
-
arguments:
object
-
-
clientCreatedAt:
object
-
Timestamp of when the user starts the exam
-
- return:
-
arguments:
object
-
-
completedAt:
object
-
Timestamp of when the exam result is completed
-
- return:
-
arguments:
object
-
-
contentPackageId:
object
-
ID of the ExamResult's content package
-
- return:
-
arguments:
object
-
-
contentPackageTitle:
object
-
Title of the ExamResult's content package
-
- return:
-
arguments:
object
-
-
deletedAt:
object
-
Timestamp of when the exam result is reset
-
- return:
-
arguments:
object
-
-
examId:
object
-
Exam ID of the ExamResult
-
- return:
-
arguments:
object
-
-
examName:
object
-
Exam name of the ExamResult
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the ExamResult.
-
- return:
-
arguments:
object
-
-
percentageCorrect:
object
-
score
-
- return:
-
arguments:
object
-
-
questionsCount:
object
-
The number of questions assigned to the exam
-
- return:
-
arguments:
object
-
-
state:
object
-
The exam result's current
ExamResultState
(started, paused or complete) -
- return:
-
arguments:
object
-
-
userId:
object
-
User ID of the ExamResult
-
- return:
-
arguments:
object
-
Example
{
"answersCount": {
"return": "number",
"arguments": {}
},
"clientCreatedAt": {
"return": "object",
"arguments": {}
},
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"deletedAt": {
"return": "object",
"arguments": {}
},
"examId": {
"return": "string",
"arguments": {}
},
"examName": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"percentageCorrect": {
"return": "number",
"arguments": {}
},
"questionsCount": {
"return": "number",
"arguments": {}
},
"state": {
"return": "string",
"arguments": {}
},
"userId": {
"return": "string",
"arguments": {}
}
}
ExamResultConnection: object
The connection type for ExamResult.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"answersCount": {
"return": "number",
"arguments": {}
},
"clientCreatedAt": {
"return": "object",
"arguments": {}
},
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"deletedAt": {
"return": "object",
"arguments": {}
},
"examId": {
"return": "string",
"arguments": {}
},
"examName": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"percentageCorrect": {
"return": "number",
"arguments": {}
},
"questionsCount": {
"return": "number",
"arguments": {}
},
"state": {
"return": "string",
"arguments": {}
},
"userId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"answersCount": {
"return": "number",
"arguments": {}
},
"clientCreatedAt": {
"return": "object",
"arguments": {}
},
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"deletedAt": {
"return": "object",
"arguments": {}
},
"examId": {
"return": "string",
"arguments": {}
},
"examName": {}
}
]
}
}
ExamResultEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"answersCount": {
"return": "number",
"arguments": {}
},
"clientCreatedAt": {
"return": "object",
"arguments": {}
},
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"deletedAt": {
"return": "object",
"arguments": {}
},
"examId": {
"return": "string",
"arguments": {}
},
"examName": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"percentageCorrect": {
"return": "number",
"arguments": {}
},
"questionsCount": {
"return": "number",
"arguments": {}
},
"state": {
"return": "string",
"arguments": {}
},
"userId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
ExamResultFilter: object
Input fields for exam result search
- ids:
-
Search by IDs
- userId:
-
Search by user ID
- examId:
-
Search by exam ID
- examName:
-
Search by exam name
- contentPackageId:
-
Search by content package ID
- query:
-
Smart search across ID, exam ID, exam name
- withDeleted:
-
Search regardless of exam's reset state
Example
{
"ids": [
"string"
],
"userId": [
"string"
],
"examId": "string",
"examName": "string",
"contentPackageId": "string",
"query": "string",
"withDeleted": "boolean"
}
ExamResultResetMutationPayload: object
Autogenerated return type of ExamResultResetMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
examResult:
object
-
ExamResult
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"examResult": {
"return": {
"answersCount": {
"return": "number",
"arguments": {}
},
"clientCreatedAt": {
"return": "object",
"arguments": {}
},
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"deletedAt": {
"return": "object",
"arguments": {}
},
"examId": {
"return": "string",
"arguments": {}
},
"examName": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"percentageCorrect": {
"return": "number",
"arguments": {}
},
"questionsCount": {
"return": "number",
"arguments": {}
},
"state": {
"return": "string",
"arguments": {}
},
"userId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
ExamResultSortAttributes: string
-
objectid
-
Sort by ID
-
objectexam_id
-
Sort by exam ID
-
objectexam_name
-
Sort by exam name
-
objectcontent_package_id
-
Sort by content package ID
-
objectcontent_package_title
-
Sort by content package title
-
objectstate
-
Sort by state
-
objectpercentage_correct
-
Sort by score
-
objectclient_created_at
-
Sort by started date
-
objectcompleted_at
-
Sort by completed date
-
objectdeleted_at
-
Sort by reset date
ExamResultState: string
-
objectstarted
-
User started the exam
-
objectpaused
-
User paused the exam
-
objectcomplete
-
User completed the exam
ExternalPackage: object
Represents information about an external package.
-
bannerImageUrl:
object
-
Image URL of the ExternalPackage.
-
- return:
-
arguments:
object
-
-
enrollmentsCount:
object
-
Number of enrollments for the ExternalPackage.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the ExternalPackage.
-
- return:
-
arguments:
object
-
-
learnableConfiguration:
object
-
LearnableConfiguration
for the ExternalPackage. -
- return:
-
arguments:
object
-
-
summary:
object
-
Summary of the ExternalPackage.
-
- return:
-
arguments:
object
-
-
title:
object
-
Title of the ExternalPackage.
-
- return:
-
arguments:
object
-
-
type:
object
-
Record Type of the ExternalPackage.
-
- return:
-
arguments:
object
-
Example
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
}
ExternalPackageConnection: object
The connection type for ExternalPackage.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string"
}
}
}
}
]
}
}
ExternalPackageEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
ExternalPackageFilter: object
Input fields for external package search
- ids:
-
Search by IDs
- contentPackageId:
-
Search by content_package_id
- withoutContentPackages:
-
Return external packages that have no content package association
- query:
-
Smart search across ID and title
Example
{
"ids": [
"string"
],
"contentPackageId": "string",
"withoutContentPackages": "boolean",
"query": "string"
}
FeatureAccess: object
Represents information about a feature access
-
allowed:
object
-
Indicates if FeatureAccess is on.
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the associated feature.
-
- return:
-
arguments:
object
-
-
featureConfiguration:
object
-
FeatureConfiguration of the associated feature.
-
- return:
-
arguments:
object
-
-
group:
object
-
Feature group(s) that the associated feature belongs to.
-
- return:
-
arguments:
object
-
-
manageable:
object
-
Indicates if FeatureAccess is manageable.
-
- return:
-
arguments:
object
-
-
managedByControllableTypes:
object
-
Array of controllable types that
FeatureAccess
can be controlled by. -
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the associated feature.
-
- return:
-
arguments:
object
-
-
summary:
object
-
Full description of associated feature.
-
- return:
-
arguments:
object
-
-
title:
object
-
Title of the associated feature.
-
- return:
-
arguments:
object
-
Example
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
FeatureAccessUpdateMutationPayload: object
Autogenerated return type of FeatureAccessUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
FeatureConfiguration: object
Represents information about a feature configuration
-
configuration:
object
-
Configuration of the feature configuration.
-
- return:
-
arguments:
object
-
-
configurationTypesJson:
object
-
Configuration types of the feature configuration.
-
- return:
-
arguments:
object
-
-
controllableId:
object
-
ID of the associated controllable.
-
- return:
-
arguments:
object
-
-
controllableType:
object
-
Type of the associated controllable.
-
- return:
-
arguments:
object
-
-
featureId:
object
-
ID of the associated feature.
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the associated feature.
-
- return:
-
arguments:
object
-
Example
{
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
FeatureConfigurationUpdateMutationPayload: object
Autogenerated return type of FeatureConfigurationUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
featureConfiguration:
object
-
FeatureConfiguration
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
Float: number
Represents signed double-precision fractional values as specified by IEEE 754.
Example
number
Group: object
Represents information for Groups.
-
branch:
object
-
Branch
(resolver) associated with the Group. -
- return:
-
arguments:
object
-
-
branchId:
object
-
Branch ID of the Group.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the Group was created.
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the Group.
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External ID of the Group.
-
- return:
-
arguments:
object
-
-
externalSystemId:
object
-
User defined field.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Group.
-
- return:
-
arguments:
object
-
-
memberCount:
object
-
Count of Users who are members of the Group.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Group.
-
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
GroupConnection: object
The connection type for Group.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {}
}
}
}
}
}
]
}
}
GroupCreateMutationPayload: object
Autogenerated return type of GroupCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
group:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"group": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
GroupEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {}
}
}
}
}
}
}
}
GroupMembershipUpdateMutationPayload: object
Autogenerated return type of GroupMembershipUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
GroupSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by Name
-
objectexternal_id
-
Sort by External ID
-
objectmember_count
-
Sort by Member Count
-
objectcreated_at
-
Sort by Created At
GroupUpdateMutationPayload: object
Autogenerated return type of GroupUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
group:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"group": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
GroupsCreateInput: object
- fileName:
- dataFormat:
- groups:
Example
{
"fileName": "string",
"dataFormat": "string",
"groups": [
{
"name": "string",
"branchSlug": "string",
"externalId": "string",
"description": "string"
}
]
}
GroupsCreateMutationPayload: object
Autogenerated return type of GroupsCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
uploadStatus:
object
-
A message indicating the status of the upload.
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"uploadStatus": {
"return": "string",
"arguments": {}
}
}
ID: string
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA=="
) or integer (such as 4
) input value will be accepted as an ID.
Int: number
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
number
Integration: object
Represents information about an Integration.
-
accessToken:
object
-
Access Token of the Integration.
-
- return:
-
arguments:
object
-
-
accountName:
object
-
Account name for the Integration.
-
- return:
-
arguments:
object
-
-
clientId:
object
-
Client ID of the Integration.
-
- return:
-
arguments:
object
-
-
clientSecret:
object
-
Client Secret of the Integration.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
When the Integration was created.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Integration.
-
- return:
-
arguments:
object
-
-
storeHash:
object
-
Store Hash of the Integration.
-
- return:
-
arguments:
object
-
-
type:
object
-
Type of the Integration.
-
- return:
-
arguments:
object
-
Example
{
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
}
IntegrationConnection: object
The connection type for Integration.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {}
}
}
}
IntegrationCreateMutationPayload: object
Autogenerated return type of IntegrationCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
integration:
object
-
Integration
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"integration": {
"return": {
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
IntegrationDeleteMutationPayload: object
Autogenerated return type of IntegrationDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
integration:
object
-
Integration
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"integration": {
"return": {
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
IntegrationEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
IntegrationUpdateMutationPayload: object
Autogenerated return type of IntegrationUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
integration:
object
-
Integration
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"integration": {
"return": {
"accessToken": {
"return": "string",
"arguments": {}
},
"accountName": {
"return": "string",
"arguments": {}
},
"clientId": {
"return": "string",
"arguments": {}
},
"clientSecret": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"storeHash": {
"return": "string",
"arguments": {}
},
"type": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearnableConfiguration: object
Represents information about a Learnable Configuration
-
enableDisplayRecognitions:
object
-
Represents if the user can see recognitions on
My Learning Page
-
- return:
-
arguments:
object
-
-
enableInBrowse:
object
-
Represents if the user can see content package on
My Learning Page
orLearning Hub browse page
-
- return:
-
arguments:
object
-
-
label:
object
-
ContentType
label of the LearnableConfiguration -
- return:
-
arguments:
object
-
-
learnableId:
object
-
ID of the Learnable
-
- return:
-
arguments:
object
-
-
learnableType:
object
-
Learnable type of the LearnableConfiguration
-
- return:
-
arguments:
object
-
-
purchaseType:
object
-
Purchase Type (
free
orpaid
) of the LearnableConfiguration -
- return:
-
arguments:
object
-
-
purchaseUrl:
object
-
Purchase URL when Purchase Type is paid of the LearnableConfiguration
-
- return:
-
arguments:
object
-
Example
{
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
}
LearnableConfigurationCreateInput: object
- learnableType:
- purchaseType:
- purchaseUrl:
- enableInBrowse:
- enableDisplayRecognitions:
- label:
Example
{
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
}
LearnableConfigurationUpdateInput: object
- learnableType:
- learnableId:
- purchaseType:
- purchaseUrl:
- enableInBrowse:
- enableDisplayRecognitions:
- label:
Example
{
"learnableType": "string",
"learnableId": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
}
LearnableConfigurationUpdateMutationPayload: object
Autogenerated return type of LearnableConfigurationUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learnableConfiguration:
object
-
LearnableConfiguration
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearnableItem: object
Represents information about a Learnable Item.
-
id:
object
-
ID of the LearnableItem.
-
- return:
-
arguments:
object
-
-
resourceId:
object
-
Resource ID of the LearnableItem.
-
- return:
-
arguments:
object
-
-
resourceImage:
object
-
Resource Image URL of the LearnableItem.
-
- return:
-
arguments:
object
-
-
resourceSummary:
object
-
Resource Summary of the LearnableItem.
-
- return:
-
arguments:
object
-
-
resourceTitle:
object
-
Resource Title of the LearnableItem.
-
- return:
-
arguments:
object
-
-
resourceType:
object
-
Resource Type of the LearnableItem.
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
}
LearnableItemAssociationConnection: object
The connection type for LearnableItem.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
LearnableItemSectionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
LearningHubEvent: object
Represents information about a Learning Hub event.
-
bannerImageUrl:
object
-
Image URL of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the Learning Hub event was created.
-
- return:
-
arguments:
object
-
-
deliveryType:
object
-
The delivery type of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
digitalEventId:
object
-
ID of the Digital Event associated to the Learning Hub event.
-
- return:
-
arguments:
object
-
-
duration:
object
-
Duration of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
endDate:
object
-
Timestamp when the Learning Hub event ends.
-
- return:
-
arguments:
object
-
-
hostEmail:
object
-
Presenter email for the Learning Hub event.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
isRecognitionIssuing:
object
-
Determines if the Learning Hub Event can issue recognitions
-
- return:
-
arguments:
object
-
-
learnableConfiguration:
object
-
LearnableConfiguration
for the Learning Hub event. -
- return:
-
arguments:
object
-
-
meetingId:
object
-
Meeting ID for the Learning Hub event.
-
- return:
-
arguments:
object
-
-
meetingPasscode:
object
-
Meeting passcode for the Learning Hub event.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
recordingLink:
object
-
Link to the recording of the Learning Hub event
-
- return:
-
arguments:
object
-
-
registrantsCount:
object
-
Number of registrations associated with the Learning Hub event.
-
- return:
-
arguments:
object
-
-
startDate:
object
-
Timestamp when the Learning Hub event starts.
-
- return:
-
arguments:
object
-
-
status:
object
-
The status of the Learning Hub event.
-
- return:
-
arguments:
object
-
-
url:
object
-
URL to the invitation for the Learning Hub event.
-
- return:
-
arguments:
object
-
Example
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recordingLink": {
"return": "string",
"arguments": {}
},
"registrantsCount": {
"return": "number",
"arguments": {}
},
"startDate": {
"return": "object",
"arguments": {}
},
"status": {
"return": "string"
}
}
LearningHubEventConnection: object
The connection type for LearningHubEvent.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recordingLink": {
"return": "string",
"arguments": {}
}
}
}
}
]
}
}
LearningHubEventCreateInput: object
- name:
- description:
- startDate:
- endDate:
- deliveryType:
- hostEmail:
- learnableConfiguration:
- isRecognitionIssuing:
- url:
Example
{
"name": "string",
"description": "string",
"startDate": "object",
"endDate": "object",
"deliveryType": "string",
"hostEmail": "string",
"learnableConfiguration": {
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string"
},
"isRecognitionIssuing": "boolean",
"url": "string"
}
LearningHubEventCreateMutationPayload: object
Autogenerated return type of LearningHubEventCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubEvent:
object
-
LearningHubEvent
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubEvent": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {}
}
}
}
LearningHubEventDeleteMutationPayload: object
Autogenerated return type of LearningHubEventDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubEvent:
object
-
LearningHubEvent
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubEvent": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {}
}
}
}
LearningHubEventEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recordingLink": {
"return": "string",
"arguments": {}
},
"registrantsCount": {
"return": "number",
"arguments": {}
}
}
}
}
LearningHubEventSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by name
-
objectduration
-
Sort by duration
-
objectstart_date
-
Sort by start date
-
objectstart_time
-
Sort by start time
LearningHubEventUpdateInput: object
- id:
- name:
- hostEmail:
- url:
- recordingLink:
- startDate:
- endDate:
Example
{
"id": "string",
"name": "string",
"hostEmail": "string",
"url": "string",
"recordingLink": "string",
"startDate": "object",
"endDate": "object"
}
LearningHubEventUpdateMutationPayload: object
Autogenerated return type of LearningHubEventUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubEvent:
object
-
LearningHubEvent
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubEvent": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"deliveryType": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"digitalEventId": {
"return": "number",
"arguments": {}
},
"duration": {
"return": "number",
"arguments": {}
},
"endDate": {
"return": "object",
"arguments": {}
},
"hostEmail": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isRecognitionIssuing": {
"return": "boolean",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"meetingId": {
"return": "string",
"arguments": {}
},
"meetingPasscode": {}
}
}
}
LearningHubPage: object
Represents information about a Learning Hub Page.
-
configuration:
object
-
Configuration of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the Learning Hub Page was created.
-
- return:
-
arguments:
object
-
-
html:
object
-
HTML that represents the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
pageType:
object
-
Type of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
sortOrder:
object
-
Order of the Learning Hub Page.
-
- return:
-
arguments:
object
-
-
tenantId:
object
-
ID of the tenant the Learning Hub Page belongs to.
-
- return:
-
arguments:
object
-
-
visible:
object
-
Whether the Learning Hub Page is visible.
-
- return:
-
arguments:
object
-
Example
{
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
}
LearningHubPageConnection: object
The connection type for LearningHubPage.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {}
}
LearningHubPageCreateInput: object
- name:
- pageType:
- html:
Example
{
"name": "string",
"pageType": "string",
"html": "string"
}
LearningHubPageCreateMutationPayload: object
Autogenerated return type of LearningHubPageCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubPage:
object
-
Resource participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubPage": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearningHubPageDeleteMutationPayload: object
Autogenerated return type of LearningHubPageDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubPage:
object
-
LearningHubPage
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubPage": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearningHubPageEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
LearningHubPageFilter: object
Input fields for learning hub page search
- ids:
-
Search by IDs
Example
{
"ids": [
"string"
]
}
LearningHubPageUpdateMutationPayload: object
Autogenerated return type of LearningHubPageUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
learningHubPage:
object
-
LearningHubPage
resource to update in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"learningHubPage": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"pageType": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
},
"tenantId": {
"return": "number",
"arguments": {}
},
"visible": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearningHubPagesReorderInput: object
- learningHubPages:
Example
{
"learningHubPages": [
{
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
]
}
LearningHubPagesReorderMutationPayload: object
Autogenerated return type of LearningHubPagesReorderMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LearningPath: object
Represents information about a Learning Path.
-
bannerImageUrl:
object
-
Image URL of the LearningPath
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the LearningPath.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the LearningPath.
-
- return:
-
arguments:
object
-
-
learnableConfiguration:
object
-
LearnableConfiguration
for the LearningPath. -
- return:
-
arguments:
object
-
-
learningPathSections:
object
-
Collection of
LearningPathSection
s of a LearningPath. -
- return:
-
arguments:
object
-
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
orderType:
object
-
Order of the LearningPath.
-
- return:
-
arguments:
object
-
-
status:
object
-
Status of a LearningPath: draft, published.
-
- return:
-
arguments:
object
-
-
stepsCount:
object
-
Number of learnable items of a LearningPath.
-
- return:
-
arguments:
object
-
-
title:
object
-
Title of the LearningPath.
-
- return:
-
arguments:
object
-
Example
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"learningPathSections": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string"
}
}
}
}
]
}
}
}
}
}
}
]
}
}
}
}
LearningPathConnection: object
The connection type for LearningPath.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"learningPathSections": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
}
}
}
}
]
}
}
}
}
}
}
]
}
}
}
}
}
}
]
}
}
LearningPathEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"learnableConfiguration": {
"return": {
"enableDisplayRecognitions": {
"return": "boolean",
"arguments": {}
},
"enableInBrowse": {
"return": "boolean",
"arguments": {}
},
"label": {
"return": "string",
"arguments": {}
},
"learnableId": {
"return": "string",
"arguments": {}
},
"learnableType": {
"return": "string",
"arguments": {}
},
"purchaseType": {
"return": "string",
"arguments": {}
},
"purchaseUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"learningPathSections": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
}
}
}
}
]
}
}
}
}
}
}
]
}
}
}
}
}
}
LearningPathSection: object
Represents information about a Learning Path Section.
-
id:
object
-
ID of the LearningPathSection.
-
- return:
-
arguments:
object
-
-
learnableItems:
object
-
Collection of
LearnableItem
s of a LearningPathSection. -
- return:
-
arguments:
object
-
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
name:
object
-
Name of the LearningPathSection.
-
- return:
-
arguments:
object
-
-
sortOrder:
object
-
Order of the LearningPathSection.
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
},
"arguments": {}
}
}
LearningPathSectionAssociationConnection: object
The connection type for LearningPathSection.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
}
}
}
}
}
}
}
}
]
}
}
LearningPathSectionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"learnableItems": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"resourceId": {
"return": "string",
"arguments": {}
},
"resourceImage": {
"return": "string",
"arguments": {}
},
"resourceSummary": {
"return": "string",
"arguments": {}
},
"resourceTitle": {
"return": "string",
"arguments": {}
},
"resourceType": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LearningPathSortAttributes: string
-
objectid
-
Sort by ID
-
objecttitle
-
Sort by title
-
objectorder_type
-
Sort by order type
-
objectstatus
-
Sort by status
License: object
Represents information about an individual license.
-
activatedAt:
object
-
Activation date of the License.
-
- return:
-
arguments:
object
-
-
branchPlan:
object
-
BranchPlan
to which the license is associated -
- return:
-
arguments:
object
-
-
branchPlanId:
object
-
ID of the associated BranchPlan
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the License was created.
-
- return:
-
arguments:
object
-
-
enrollments:
object
-
List of
Enrollment
s (resolver) associated with the License. -
- return:
-
arguments:
object
-
- offset:
-
The index of the first item in the records to be returned
- limit: 25
-
The maximum number of records to be returned
- sort:
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
extendable:
object
-
Indicates whether the license may be extended.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the License.
-
- return:
-
arguments:
object
-
-
isEnterpriseLicense:
object
-
Indicates if license is tied to any enerprise contracts.
-
- return:
-
arguments:
object
-
-
maxExtensionDate:
object
-
Timestamp of maximum date beyond which extension is not permitted.
-
- return:
-
arguments:
object
-
-
planAccessExpirationDate:
object
-
Final access date of the plan.
-
- return:
-
arguments:
object
-
-
planKind:
object
-
Kind of the plan: One of "Lifetime Access", "Enterprise", "Subject Access", "Multiple Access", "MultipleAccess", "Library", "Single Access", "Solo", "Upfront Charge", etc.
-
- return:
-
arguments:
object
-
-
seatExclusion:
object
-
Indicates if the license is excluded from seat counts.
-
- return:
-
arguments:
object
-
-
source:
object
-
Source of the License.
-
- return:
-
arguments:
object
-
-
state:
object
-
Status of the License.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
associated with the License. -
- return:
-
arguments:
object
-
-
validUntil:
object
-
Enrolled until date of the License.
-
- return:
-
arguments:
object
-
Example
{
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {}
}
}
}
}
}
}
}
LicenseAssociationConnection: object
The connection type for License.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
LicenseConnection: object
The connection type for License.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
LicenseCreateMutationPayload: object
Autogenerated return type of LicenseCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
licenses:
object
-
License
records created by the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"licenses": {
"return": [
{
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
]
}
}
LicenseEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
LicenseRemoveMutationPayload: object
Autogenerated return type of LicenseRemoveMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
license:
object
-
License
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
}
}
LicenseSortAttributes: string
-
objectid
-
Sort by ID
-
objectactivated_at
-
Sort by activation date
-
objectvalid_until
-
Sort by valid until date
-
objectstate
-
Sort by state
-
objectcreated_at
-
Sort by time created
-
objectseat_exclusion
-
Sort by seat exclusion
-
objectuser_id
-
Sort by User ID
-
objectuser_sis_id
-
Sort by User SIS ID
LicenseUpdateMutationPayload: object
Autogenerated return type of LicenseUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
license:
object
-
License
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
}
}
Locale: object
Represents information on locales
-
defaults:
object
-
Default locales in JSON.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the LocaleType.
-
- return:
-
arguments:
object
-
-
overrides:
object
-
Overrides of default locales in JSON.
-
- return:
-
arguments:
object
-
Example
{
"defaults": {
"return": "object",
"arguments": {}
},
"id": {
"return": "number",
"arguments": {}
},
"overrides": {
"return": "object",
"arguments": {}
}
}
LocaleConnection: object
The connection type for Locale.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"defaults": {
"return": "object",
"arguments": {}
},
"id": {
"return": "number",
"arguments": {}
},
"overrides": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"defaults": {
"return": "object",
"arguments": {}
},
"id": {
"return": "number",
"arguments": {}
},
"overrides": {
"return": "object",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
LocaleEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"defaults": {
"return": "object",
"arguments": {}
},
"id": {
"return": "number",
"arguments": {}
},
"overrides": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
LocaleFilter: object
Input fields for locale search
- language:
-
Search by language
Example
{
"language": "string"
}
LocaleUpdateMutationPayload: object
Autogenerated return type of LocaleUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
locales:
object
-
Locale
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"locales": {
"return": {
"defaults": {
"return": "object",
"arguments": {}
},
"id": {
"return": "number",
"arguments": {}
},
"overrides": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LoginTracking: object
Represents information about the login tracking of an user
-
attemptedAt:
object
-
Time of the LoginTracking.
-
- return:
-
arguments:
object
-
-
browser:
object
-
Browser of the LoginTracking.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the LoginTracking.
-
- return:
-
arguments:
object
-
-
ip:
object
-
IP Address of the LoginTracking.
-
- return:
-
arguments:
object
-
-
operatingSystem:
object
-
Operating system of the LoginTracking.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates if the login attempt was successful.
-
- return:
-
arguments:
object
-
Example
{
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
LoginTrackingAssociationConnection: object
The connection type for LoginTracking.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
LoginTrackingConnection: object
The connection type for LoginTracking.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
LoginTrackingEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"attemptedAt": {
"return": "object",
"arguments": {}
},
"browser": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"ip": {
"return": "string",
"arguments": {}
},
"operatingSystem": {
"return": "string",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
LoginTrackingSortAttributes: string
-
objectip
-
Sort by ip
-
objectsuccess
-
Sort by success status
-
objectattempted_at
-
Sort by attempted date
LtiDeployment: object
Represents information about a Learning Tools Interoperability (LTI) Tool Deployment.
-
branch:
object
-
Branch
associated with the LTI Deployment. -
- return:
-
arguments:
object
-
-
contentPackages:
object
-
List of
ContentPackage
s (resolver) permitted by the LTI Deployment. -
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the LTI Deployment was created.
-
- return:
-
arguments:
object
-
-
enableNrps:
object
-
Indicates if it enables nightly NRPS job
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External Deployment ID of the LTI Deployment.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the LTI Deployment.
-
- return:
-
arguments:
object
-
-
ltiContextClaimType:
object
-
LTI Claim Context
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the LTI Deployment.
-
- return:
-
arguments:
object
-
-
tool:
object
-
LTI Tool
associated with the LTI Deployment. -
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
LtiDeploymentConnection: object
The connection type for LtiDeployment.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {}
}
}
}
}
}
]
}
}
LtiDeploymentCreateMutationPayload: object
Autogenerated return type of LtiDeploymentCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiDeployment:
object
-
LTI Deployment created by the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiDeployment": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiDeploymentDeleteMutationPayload: object
Autogenerated return type of LtiDeploymentDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiDeployment:
object
-
LTI Deployment participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiDeployment": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiDeploymentEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {}
}
}
}
}
}
}
}
LtiDeploymentSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by Name
-
objectexternal_id
-
Sort by external deployment ID.
-
objectcreated_at
-
Sort by time created.
LtiDeploymentUpdateCoursesMutationPayload: object
Autogenerated return type of LtiDeploymentUpdateCoursesMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiDeployment:
object
-
LTI Deployment updated by the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiDeployment": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiDeploymentUpdateMutationPayload: object
Autogenerated return type of LtiDeploymentUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiDeployment:
object
-
LTI Deployment updated by the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiDeployment": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiTool: object
Represents information about a Learning Tools Interoperability (LTI) Tool.
-
branch:
object
-
Branch
associated with the LTI Tool. -
- return:
-
arguments:
object
-
-
clientId:
object
-
Client ID of the LTI Tool.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the LTI Tool was created.
-
- return:
-
arguments:
object
-
-
deepLinkingUrl:
object
-
Deep Linking URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the LTI Tool.
-
- return:
-
arguments:
object
-
-
jwksUrl:
object
-
JWKS URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
keysetUrl:
object
-
Keyset URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
launchesEndpoint:
object
-
Launches Endpoint of the LTI Tool.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the LTI Tool.
-
- return:
-
arguments:
object
-
-
oauth2Aud:
object
-
OAuth2 AUD of the LTI Tool.
-
- return:
-
arguments:
object
-
-
oauth2Url:
object
-
OAuth2 URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
oidcLoginInitiationUrl:
object
-
OIDC Login Initiation URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
platformOidcAuthUrl:
object
-
OAuth2 URL of the LTI Tool.
-
- return:
-
arguments:
object
-
-
publicKey:
object
-
Public Key of the LTI Tool.
-
- return:
-
arguments:
object
-
-
roleMapping:
object
-
Mapping of the LTI roles to application roles.
-
- return:
-
arguments:
object
-
-
version:
object
-
Version of the LTI Tool.
-
- return:
-
arguments:
object
-
Example
{
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {}
}
}
}
}
}
LtiToolConnection: object
The connection type for LtiTool.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {}
}
}
}
}
}
]
}
}
LtiToolCreateMutationPayload: object
Autogenerated return type of LtiToolCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiTool:
object
-
LTI Tool created by the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiTool": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiToolDeleteMutationPayload: object
Autogenerated return type of LtiToolDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiTool:
object
-
LTI Tool participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiTool": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
LtiToolEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {}
}
}
}
}
}
}
}
LtiToolSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by Name
-
objectclient_id
-
Sort by Client ID.
-
objectcreated_at
-
Sort by time created.
LtiToolUpdateInput: object
- id:
- name:
- clientId:
- keysetUrl:
- oauth2Url:
- oauth2Aud:
- platformOidcAuthUrl:
- roleMapping:
Example
{
"id": "string",
"name": "string",
"clientId": "string",
"keysetUrl": "string",
"oauth2Url": "string",
"oauth2Aud": "string",
"platformOidcAuthUrl": "string",
"roleMapping": "object"
}
LtiToolUpdateMutationPayload: object
Autogenerated return type of LtiToolUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
ltiTool:
object
-
LTI Tool updated by the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"ltiTool": {
"return": {
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
}
}
}
}
}
}
}
}
MarketingPageUpdateMutationPayload: object
Autogenerated return type of MarketingPageUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
marketingPage:
object
-
MarketingPage
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
Message: object
Represents information about a message of the platform
-
body:
object
-
Body of the Message
-
- return:
-
arguments:
object
-
-
contentPackage:
object
-
ContentPackage of the Message.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Datetime of when the Message was created
-
- return:
-
arguments:
object
-
-
endDate:
object
-
The end date for an automated Message.
-
- return:
-
arguments:
object
-
-
eventTrigger:
object
-
The EventTrigger that subscribes to events for an automated Message delivery.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Message.
-
- return:
-
arguments:
object
-
-
startDate:
object
-
The start date for the Message.
-
- return:
-
arguments:
object
-
-
state:
object
-
The activation state of the Message.
-
- return:
-
arguments:
object
-
-
title:
object
-
Title of the Message
-
- return:
-
arguments:
object
-
-
userSegment:
object
-
The UserSegment specifying to which users this Message will be delivered.
-
- return:
-
arguments:
object
-
Example
{
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"features": {}
}
}
}
MessageConnection: object
The connection type for Message.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string"
}
}
]
}
}
}
}
}
}
]
}
}
MessageCreateInput: object
- title:
- body:
- contentPackageId:
- userSegment:
- startDate:
- endDate:
- eventTrigger:
Example
{
"title": "string",
"body": "string",
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
MessageCreateMutationPayload: object
Autogenerated return type of MessageCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
message:
object
-
Message
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"message": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {}
}
]
}
}
}
}
}
}
MessageDeleteMutationPayload: object
Autogenerated return type of MessageDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
message:
object
-
Message
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"message": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {}
}
]
}
}
}
}
}
}
MessageEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"summary": {
"return": "string"
}
}
]
}
}
}
}
}
}
MessageFilter: object
Input fields for message search
- ids:
-
Search by IDs
Example
{
"ids": [
"string"
]
}
MessageSortAttributes: string
-
objectid
-
Sort by ID
-
objecttitle
-
Sort by Title
-
objectcreated_at
-
Sort by time created
MessageUpdateInput: object
- id:
- title:
- body:
- contentPackageId:
- startDate:
- endDate:
- eventTrigger:
Example
{
"id": "string",
"title": "string",
"body": "string",
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
MessageUpdateMutationPayload: object
Autogenerated return type of MessageUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
message:
object
-
Message
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"message": {
"return": {
"body": {
"return": "string",
"arguments": {}
},
"contentPackage": {
"return": {
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {}
}
]
}
}
}
}
}
}
MilestoneConnection: object
The connection type for Milestone.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
MilestoneEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"title": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
MutationResult: object
-
creationGuard:
object
-
Message describing details of the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Array of
RecordError
errors from the service response. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates successfull service response.
-
- return:
-
arguments:
object
-
-
userRole:
object
-
UserRole
resource response for the mutation. -
- return:
-
arguments:
object
-
Example
{
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
]
}
}
}
}
}
}
PageComponent: object
Represents how a brandable resource's Page Components are structured
-
html:
object
-
HTML that represents the PageComponent.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the PageComponent.
-
- return:
-
arguments:
object
-
-
isDefault:
object
-
Indicates if the PageComponent uses default HTML.
-
- return:
-
arguments:
object
-
-
variables:
object
-
Variables for the PageComponent in JSON.
-
- return:
-
arguments:
object
-
Example
{
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
PageInfo: object
Information about pagination in a connection.
-
endCursor:
object
-
When paginating forwards, the cursor to continue.
-
- return:
-
arguments:
object
-
-
hasNextPage:
object
-
When paginating forwards, are there more items?
-
- return:
-
arguments:
object
-
-
hasPreviousPage:
object
-
When paginating backwards, are there more items?
-
- return:
-
arguments:
object
-
-
startCursor:
object
-
When paginating backwards, the cursor to continue.
-
- return:
-
arguments:
object
-
Example
{
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
}
Permission: object
-
accessContexts:
object
-
Array of Access Contexts of the Permission.
-
- return:
-
arguments:
object
-
-
action:
object
-
Action of the Permission.
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the Permission.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Permission.
-
- return:
-
arguments:
object
-
-
resource:
object
-
Resource of the Permission.
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the Permission.
-
- return:
-
arguments:
object
-
Example
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
PermissionConnection: object
The connection type for Permission.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
PermissionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
PermissionFilter: object
Input fields for permission search
- accessContexts:
-
Search by access_contexts
Example
{
"accessContexts": [
"string"
]
}
Plan: object
Represents information about a contract Plan
.
-
accessExpirationDate:
object
-
Final access date of the Plan.
-
- return:
-
arguments:
object
-
-
activatedLicenseCount:
object
-
Number of associated licenses that were activated
-
- return:
-
arguments:
object
-
-
activeLicenseCount:
object
-
Number of licenses that have learner activity
-
- return:
-
arguments:
object
-
-
availableSeatCount:
object
-
Number of seats available to be used
-
- return:
-
arguments:
object
-
-
contentPackages:
object
-
List of
ContentPackage
s (resolver) authorized with the Plan. -
- return:
-
arguments:
object
-
-
duration:
object
-
Duration of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
durationUnit:
object
-
Duration units
-
- return:
-
arguments:
object
-
-
externalId:
object
-
External ID of BasePlanInterface
-
- return:
-
arguments:
object
-
-
finalAccessDate:
object
-
Final date when all learner access gets cut off
-
- return:
-
arguments:
object
-
-
finalAdminAccessDate:
object
-
Final date when all admin access gets cut off
-
- return:
-
arguments:
object
-
-
firstActivationDate:
object
-
First date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the BasePlanInterface
-
- return:
-
arguments:
object
-
-
initialDuration:
object
-
Number of initial duration units of the Plan.
-
- return:
-
arguments:
object
-
-
initialDurationUnit:
object
-
Unit of initial duration of the Plan.
-
- return:
-
arguments:
object
-
-
kind:
object
-
Kind of the Plan.
-
- return:
-
arguments:
object
-
-
lastActivationDate:
object
-
Last date when a learner can activate their access
-
- return:
-
arguments:
object
-
-
licenseCount:
object
-
Number of associated licenses
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the
BasePlanInterface
. -
- return:
-
arguments:
object
-
-
planType:
object
-
Type of the Plan.
-
- return:
-
arguments:
object
-
-
seatCount:
object
-
Number of seats
-
- return:
-
arguments:
object
-
-
seatCountType:
object
-
Type of the seating
-
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the Plan used to generate purchase and voucher URL.
-
- return:
-
arguments:
object
-
-
usedSeatCount:
object
-
Number of seats used
-
- return:
-
arguments:
object
-
-
validFrom:
object
-
Date from which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
-
validTo:
object
-
Date until which BasePlanInterface is valid
-
- return:
-
arguments:
object
-
Example
{
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean",
"arguments": {}
},
"managedByControllableTypes": {
"return": [
"string"
],
"arguments": {}
},
"slug": {}
}
]
}
}
]
}
}
PlanConnection: object
The connection type for Plan.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string"
}
}
]
}
}
]
}
}
}
}
]
}
}
PlanCreateInput: object
- name:
- slug:
- externalId:
- validFrom:
- validTo:
- durationUnit:
- duration:
- finalAccessDate:
- firstActivationDate:
- kind:
- contentPackageIds:
- planType:
Example
{
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "string",
"finalAccessDate": "string",
"firstActivationDate": "object",
"kind": "string",
"contentPackageIds": [
"string"
],
"planType": "string"
}
PlanCreateMutationPayload: object
Autogenerated return type of PlanCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
plan:
object
-
Plan
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"plan": {
"return": {
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {}
}
}
}
]
}
}
]
}
}
}
}
PlanEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"group": {
"return": "string",
"arguments": {}
},
"manageable": {
"return": "boolean"
}
}
]
}
}
]
}
}
}
}
PlanSortAttributes: string
-
objectid
-
Sort by ID
-
objectexternal_id
-
Sort by external ID
-
objectname
-
Sort by name
-
objectplan_type
-
Sort by plan type
PlanUpdateAuthorizationsMutationPayload: object
Autogenerated return type of PlanUpdateAuthorizationsMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
plan:
object
-
Plan
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"plan": {
"return": {
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {}
}
}
}
]
}
}
]
}
}
}
}
PlanUpdateInput: object
- id:
- name:
- slug:
- externalId:
- validFrom:
- validTo:
- durationUnit:
- duration:
- finalAccessDate:
- firstActivationDate:
Example
{
"id": "string",
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "number",
"finalAccessDate": "string",
"firstActivationDate": "string"
}
PlanUpdateMutationPayload: object
Autogenerated return type of PlanUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
plan:
object
-
Plan
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"plan": {
"return": {
"accessExpirationDate": {
"return": "object",
"arguments": {}
},
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"contentPackages": {
"return": [
{
"bannerImageUrl": {
"return": "string",
"arguments": {}
},
"collaboratorEmails": {
"return": [
"string"
],
"arguments": {}
},
"courseType": {
"return": "string",
"arguments": {}
},
"deactivatedAt": {
"return": "object",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"enrollmentsCount": {
"return": "number",
"arguments": {}
},
"featureAccesses": {
"return": [
{
"allowed": {
"return": "boolean",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"featureConfiguration": {
"return": {
"configuration": {
"return": "object",
"arguments": {}
},
"configurationTypesJson": {
"return": "object",
"arguments": {}
},
"controllableId": {
"return": "string",
"arguments": {}
},
"controllableType": {
"return": "string",
"arguments": {}
},
"featureId": {}
}
}
}
]
}
}
]
}
}
}
}
ProductCategory: object
Represents information about an individual product category.
-
id:
object
-
ID of the ProductCategory.
-
- return:
-
arguments:
object
-
-
locale:
object
-
Locale of the ProductCategory.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the ProductCategory.
-
- return:
-
arguments:
object
-
-
parentCategoryName:
object
-
Name of the parent category of the ProductCategory.
-
- return:
-
arguments:
object
-
-
sortOrder:
object
-
Sort order of the ProductCategory.
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentCategoryName": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
}
}
ProductCategoryAssignment: object
Represents information about an individual product category assignment.
-
categorizableId:
object
-
ID of the referenced categorizable of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
-
categorizableType:
object
-
Type of the referenced categorizable of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
-
locale:
object
-
Locale of the referenced ProductCategory
-
- return:
-
arguments:
object
-
-
parentProductCategoryName:
object
-
Name of the parent ProductCategory of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
-
productCategoryId:
object
-
ID of the ProductCategory of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
-
productCategoryName:
object
-
Name of the ProductCategory of the ProductCategoryAssignment.
-
- return:
-
arguments:
object
-
Example
{
"categorizableId": {
"return": "string",
"arguments": {}
},
"categorizableType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"parentProductCategoryName": {
"return": "string",
"arguments": {}
},
"productCategoryId": {
"return": "string",
"arguments": {}
},
"productCategoryName": {
"return": "string",
"arguments": {}
}
}
ProductCategoryAssignmentConnection: object
The connection type for ProductCategoryAssignment.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"categorizableId": {
"return": "string",
"arguments": {}
},
"categorizableType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"parentProductCategoryName": {
"return": "string",
"arguments": {}
},
"productCategoryId": {
"return": "string",
"arguments": {}
},
"productCategoryName": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"categorizableId": {
"return": "string",
"arguments": {}
},
"categorizableType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"parentProductCategoryName": {
"return": "string",
"arguments": {}
},
"productCategoryId": {
"return": "string",
"arguments": {}
},
"productCategoryName": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
ProductCategoryAssignmentEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"categorizableId": {
"return": "string",
"arguments": {}
},
"categorizableType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"parentProductCategoryName": {
"return": "string",
"arguments": {}
},
"productCategoryId": {
"return": "string",
"arguments": {}
},
"productCategoryName": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
ProductCategoryAssignmentFilter: object
Input fields for product category assignment search
- forCategorizable:
-
Search for product category assignments for a specific categorizable record
Example
{
"forCategorizable": "string"
}
ProductCategoryAssignmentsUpdateInput: object
- categorizableId:
- categorizableType:
- productCategoryIds:
Example
{
"categorizableId": "string",
"categorizableType": "string",
"productCategoryIds": [
"string"
]
}
ProductCategoryAssignmentsUpdateMutationPayload: object
Autogenerated return type of ProductCategoryAssignmentsUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
productCategoryAssignments:
object
-
ProductCategoryAssignment
resources created in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"productCategoryAssignments": {
"return": [
{
"categorizableId": {
"return": "string",
"arguments": {}
},
"categorizableType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"parentProductCategoryName": {
"return": "string",
"arguments": {}
},
"productCategoryId": {
"return": "string",
"arguments": {}
},
"productCategoryName": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
ProductCategoryConnection: object
The connection type for ProductCategory.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentCategoryName": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentCategoryName": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
ProductCategoryEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"locale": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentCategoryName": {
"return": "string",
"arguments": {}
},
"sortOrder": {
"return": "number",
"arguments": {}
}
},
"arguments": {}
}
}
ProductCategoryFilter: object
Input fields for product category search
- childOnly:
-
Search only for product categories that have a parent
Example
{
"childOnly": "boolean"
}
RecognitionConnection: object
The connection type for Recognition.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
RecognitionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
RecognitionType: object
Represents information about a Recognition Type.
-
awardType:
object
-
Type of Recognition awarded.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Recognition Type.
-
- return:
-
arguments:
object
-
-
isUsedInCourse:
object
-
Whether the Recognition Type is associated with an Issuance.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Recognition Type.
-
- return:
-
arguments:
object
-
Example
{
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
RecognitionTypeConnection: object
The connection type for RecognitionType.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
RecognitionTypeCreateInput: object
- name:
- awardType:
Example
{
"name": "string",
"awardType": "string"
}
RecognitionTypeCreateMutationPayload: object
Autogenerated return type of RecognitionTypeCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
recognitionType:
object
-
RecognitionType
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"recognitionType": {
"return": {
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
RecognitionTypeDeleteMutationPayload: object
Autogenerated return type of RecognitionTypeDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
recognitionType:
object
-
Recognition Type participating in the mutation.
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"recognitionType": {
"return": {
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
RecognitionTypeEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
RecognitionTypeFilter: object
Input fields for Recognition Type search
- ids:
-
Search by IDs
Example
{
"ids": [
"string"
]
}
RecognitionTypeUpdateMutationPayload: object
Autogenerated return type of RecognitionTypeUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
recognitionType:
object
-
RecognitionType
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"recognitionType": {
"return": {
"awardType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isUsedInCourse": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
RecordError: object
Documents an error that occurred while update a record.
-
message:
object
-
Description of the RecordError.
-
- return:
-
arguments:
object
-
-
path:
object
-
Associated input value of the RecordError.
-
- return:
-
arguments:
object
-
Example
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
Role: object
A set of Permissions assignable to a User
-
accessContexts:
object
-
Array of access context this role contains
-
- return:
-
arguments:
object
-
-
description:
object
-
Description of the Role.
-
- return:
-
arguments:
object
-
-
editable:
object
-
Indicates if the Role can be edited.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Role.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the Role.
-
- return:
-
arguments:
object
-
-
permissionBased:
object
-
Indicates if Role's authorization is based on permissions.
-
- return:
-
arguments:
object
-
-
permissions:
object
-
Permission
s (resolver) available to the Role. -
- return:
-
arguments:
object
-
-
slug:
object
-
Slug of the Role.
-
- return:
-
arguments:
object
-
-
updatedAt:
object
-
Timestamp when the Role was last updated.
-
- return:
-
arguments:
object
-
Example
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
}
RoleConnection: object
The connection type for Role.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {}
}
]
}
}
RoleCreateInput: object
- slug:
- name:
- permissionSlugs:
-
Assignable Permissions: access:blueprint,access:console,activate:users,create:communications,create:licenses,create:materials,create:plans,create:subscriptions,create:users,create:user_roles,create:vouchers,deactivate:content_packages,deactivate:users,delete:communications,delete:materials,delete:user_roles,grade:assignments,impersonate:users,manage:assignments,manage:big_commerce,manage:branding,manage:custom_urls,manage:product_categories,read:activities,read:communications,read:content,read:content_packages,read:enrollments,read:integrations,read:licenses,read:login_trackings,read:materials,read:permissions,read:plans,read:product_categories,read:reports,read:resources,read:roles,read:subscriptions,read:users,read:user_roles,read:vouchers,remove:licenses,reset:activities,reset:enrollments,update:communications,update:content_packages,update:enrollments,update:learning_hub,update:licenses,update:materials,update:plans,update:tenants,update:users,update:user_roles,update:vouchers,create:developer_tokens (if developer_tools feature access enabled),create:webhooks (if developer_tools feature access enabled),read:developer_tokens (if developer_tools feature access enabled),read:webhooks (if developer_tools feature access enabled),update:developer_tokens (if developer_tools feature access enabled),update:webhooks (if developer_tools feature access enabled),create:branches (if branches feature access enabled),delete:branches (if branches feature access enabled),read:branches (if branches feature access enabled),update:branches (if branches feature access enabled),read:branch_plans (if branches feature access enabled),update:branch_plans (if branches feature access enabled),create:branch_plans (if branches feature access enabled),read:groups (if branches feature access enabled),update:groups (if branches feature access enabled),create:groups (if branches feature access enabled),read:psychometric_dashboard (if psychometric_and_usage_dashboards feature access enabled),read:usage_dashboard (if psychometric_and_usage_dashboards feature access enabled),create:curriculums (if curriculum feature access enabled),read:curriculums (if curriculum feature access enabled),update:curriculums (if curriculum feature access enabled),delete:curriculums (if curriculum feature access enabled),create:lti (if lti_tools feature access enabled),read:lti (if lti_tools feature access enabled),update:lti (if lti_tools feature access enabled),delete:lti (if lti_tools feature access enabled),create:recognition_types (if recognition_issuance feature access enabled),read:recognition_types (if recognition_issuance feature access enabled),update:recognition_types (if recognition_issuance feature access enabled),delete:recognition_types (if recognition_issuance feature access enabled),read:test_reports (if test_reports feature access enabled),read:realtime_dashboards (if realtime_dashboards feature access enabled)
- description:
Example
{
"slug": "string",
"name": "string",
"permissionSlugs": [
"string"
],
"description": "string"
}
RoleCreateMutationPayload: object
Autogenerated return type of RoleCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
role:
object
-
Role
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
RoleDeleteMutationPayload: object
Autogenerated return type of RoleDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
role:
object
-
Role
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
RoleEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
RoleFilter: object
Input fields for role search
- ids:
-
Search by IDs
- notSlugs:
-
Exclude Roles with provided slugs
- query:
-
Smart search by name
- accessContexts:
-
Search by permissions access contexts
Example
{
"ids": [
"string"
],
"notSlugs": [
"string"
],
"query": "string",
"accessContexts": [
"string"
]
}
RoleSortAttributes: string
-
objectname
-
Sort by name
-
objectslug
-
Sort by slug
-
objecteditable
-
Sort by whether the role is editable
-
objectupdated_at
-
Sort by last updated at timestamp
RoleUpdateInput: object
- id:
- name:
- description:
- permissionSlugs:
-
Assignable Permissions: access:blueprint,access:console,activate:users,create:communications,create:licenses,create:materials,create:plans,create:subscriptions,create:users,create:user_roles,create:vouchers,deactivate:content_packages,deactivate:users,delete:communications,delete:materials,delete:user_roles,grade:assignments,impersonate:users,manage:assignments,manage:big_commerce,manage:branding,manage:custom_urls,manage:product_categories,read:activities,read:communications,read:content,read:content_packages,read:enrollments,read:integrations,read:licenses,read:login_trackings,read:materials,read:permissions,read:plans,read:product_categories,read:reports,read:resources,read:roles,read:subscriptions,read:users,read:user_roles,read:vouchers,remove:licenses,reset:activities,reset:enrollments,update:communications,update:content_packages,update:enrollments,update:learning_hub,update:licenses,update:materials,update:plans,update:tenants,update:users,update:user_roles,update:vouchers,create:developer_tokens (if developer_tools feature access enabled),create:webhooks (if developer_tools feature access enabled),read:developer_tokens (if developer_tools feature access enabled),read:webhooks (if developer_tools feature access enabled),update:developer_tokens (if developer_tools feature access enabled),update:webhooks (if developer_tools feature access enabled),create:branches (if branches feature access enabled),delete:branches (if branches feature access enabled),read:branches (if branches feature access enabled),update:branches (if branches feature access enabled),read:branch_plans (if branches feature access enabled),update:branch_plans (if branches feature access enabled),create:branch_plans (if branches feature access enabled),read:groups (if branches feature access enabled),update:groups (if branches feature access enabled),create:groups (if branches feature access enabled),read:psychometric_dashboard (if psychometric_and_usage_dashboards feature access enabled),read:usage_dashboard (if psychometric_and_usage_dashboards feature access enabled),create:curriculums (if curriculum feature access enabled),read:curriculums (if curriculum feature access enabled),update:curriculums (if curriculum feature access enabled),delete:curriculums (if curriculum feature access enabled),create:lti (if lti_tools feature access enabled),read:lti (if lti_tools feature access enabled),update:lti (if lti_tools feature access enabled),delete:lti (if lti_tools feature access enabled),create:recognition_types (if recognition_issuance feature access enabled),read:recognition_types (if recognition_issuance feature access enabled),update:recognition_types (if recognition_issuance feature access enabled),delete:recognition_types (if recognition_issuance feature access enabled),read:test_reports (if test_reports feature access enabled),read:realtime_dashboards (if realtime_dashboards feature access enabled)
Example
{
"id": "string",
"name": "string",
"description": "string",
"permissionSlugs": [
"string"
]
}
RoleUpdateMutationPayload: object
Autogenerated return type of RoleUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
role:
object
-
Role
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
SortOrder: string
Sort direction Enums
-
objectasc
-
Sort records in ascending order by the specified attributes
-
objectdesc
-
Sort records in descending order by the specified attributes
StandardTag: object
Represents information about a StandardTag
-
ancestryDepth:
object
-
Depth of each node
-
- return:
-
arguments:
object
-
-
code:
object
-
Code of the StandardTag.
-
- return:
-
arguments:
object
-
-
displayOnLearningHub:
object
-
Indicates if the StandardTag is set to display in the Learning Hub dashboard.
-
- return:
-
arguments:
object
-
-
displayOnWebapp:
object
-
Indicates if the StandardTag is set to display in WebApp content.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the StandardTag.
-
- return:
-
arguments:
object
-
-
isParent:
object
-
Indicates if the StandardTag is a parent to other StandardTags.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the StandardTag.
-
- return:
-
arguments:
object
-
-
parentId:
object
-
ID of the StandardTag that is the parent.
-
- return:
-
arguments:
object
-
-
rootId:
object
-
ID of the StandardTag that is the category.
-
- return:
-
arguments:
object
-
Example
{
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
}
StandardTagConnection: object
The connection type for StandardTag.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {}
}
}
}
StandardTagCreateMutationPayload: object
Autogenerated return type of StandardTagCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
standardTag:
object
-
StandardTag
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"standardTag": {
"return": {
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
StandardTagDeleteMutationPayload: object
Autogenerated return type of StandardTagDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
standardTag:
object
-
StandardTag
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"standardTag": {
"return": {
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
StandardTagEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
StandardTagUpdateMutationPayload: object
Autogenerated return type of StandardTagUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
standardTag:
object
-
StandardTag
resource to update in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"standardTag": {
"return": {
"ancestryDepth": {
"return": "number",
"arguments": {}
},
"code": {
"return": "string",
"arguments": {}
},
"displayOnLearningHub": {
"return": "boolean",
"arguments": {}
},
"displayOnWebapp": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isParent": {
"return": "boolean",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"parentId": {
"return": "string",
"arguments": {}
},
"rootId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
String: string
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
StudyTaskConnection: object
The connection type for StudyTask.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
StudyTaskEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
Subscription: object
Represents information about a subscription to a plan.
-
createdAt:
object
-
Timestamp when the Subscription was created.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Subscription.
-
- return:
-
arguments:
object
-
-
license:
object
-
License
(resolver) associated with the Subscription. -
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with the Subscription. -
- return:
-
arguments:
object
-
-
voucher:
object
-
Voucher
(resolver) associated with the Subscription. -
- return:
-
arguments:
object
-
Example
{
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
SubscriptionConnection: object
The connection type for Subscription.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
SubscriptionCreateMutationPayload: object
Autogenerated return type of SubscriptionCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
subscription:
object
-
Subscription
resource participating in the mutation. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"subscription": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {}
}
}
}
}
}
}
}
}
}
}
}
SubscriptionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"license": {
"return": {
"activatedAt": {
"return": "object",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {}
}
}
}
}
}
}
}
}
}
}
}
}
}
SubscriptionSortAttributes: string
-
objectcreated_at
-
Sort by time created
-
objectlicense_id
-
Sort by license ID
-
objectlicense_state
-
Sort by status of the license
-
objectuser_email
-
Sort by user email
-
objectuser_id
-
Sort by user ID
-
objectuser_name
-
Sort by user name
-
objectuser_sis_id
-
Sort by user SIS ID
-
objectvoucher_token
-
Sort by voucher token
UrlRegistration: object
Represents information about a UrlRegistration for a LiveEvent.
-
id:
object
-
ID of the UrlRegistration.
-
- return:
-
arguments:
object
-
-
joinTime:
object
-
Timestamp when the user joined the event.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with the UrlRegistration. -
- return:
-
arguments:
object
-
-
userId:
object
-
ID of the User
-
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"joinTime": {
"return": "object",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {}
}
}
}
}
}
}
}
UrlRegistrationConnection: object
The connection type for UrlRegistration.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"joinTime": {
"return": "object",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
]
}
}
UrlRegistrationEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"joinTime": {
"return": "object",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
User: object
Represents information about a user of the platform
-
authenticationProvider:
object
-
The name of the authentication or Identity Provider for the User.
-
- return:
-
arguments:
object
-
-
branch:
object
-
Branch
(resolver) associated with the User. -
- return:
-
arguments:
object
-
-
branchMembershipGuard:
object
-
Indicates why the user's membership cannot be transferred to a new branch. If the user can be transferred, then this field returns null.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the User was created.
-
- return:
-
arguments:
object
-
-
email:
object
-
Email address of the User.
-
- return:
-
arguments:
object
-
-
enrollments:
object
-
A paginated list of
Enrollment
s (resolver) of the User. -
- return:
-
arguments:
object
-
- offset:
-
The index of the first item in the records to be returned
- limit: 25
-
The maximum number of records to be returned
- sort:
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
extendedTimeAccommodation:
object
-
Determines if the User has Extended Time Accommodations enabled.
-
- return:
-
arguments:
object
-
-
groups:
object
-
A paginated list of
Group
s (resolver) of the User. -
- return:
-
arguments:
object
-
-
id:
object
-
ID of the User.
-
- return:
-
arguments:
object
-
-
identifier:
object
-
An ID for the user which may come from sis_id, SSO ID, Identity UUID, etc.
-
- return:
-
arguments:
object
-
-
impersonatable:
object
-
Indicates if this User can be impersonated by the CurrentUser.
-
- return:
-
arguments:
object
-
-
isSsoUser:
object
-
Indicates if the User is an SSO User.
-
- return:
-
arguments:
object
-
-
lastLoginAt:
object
-
Timestamp when the User last logged in.
-
- return:
-
arguments:
object
-
-
licenses:
object
-
A paginated list of
License
s (resolver) of the User. -
- return:
-
arguments:
object
-
- offset:
-
The index of the first item in the records to be returned
- limit: 25
-
The maximum number of records to be returned
- sort:
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
loginTrackings:
object
-
A paginated list of
LoginTracking
s (resolver) of the User. -
- return:
-
arguments:
object
-
- offset:
-
The index of the first item in the records to be returned
- limit: 25
-
The maximum number of records to be returned
- sort:
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
name:
object
-
Name of the User.
-
- return:
-
arguments:
object
-
-
sisId:
object
-
An external System ID of the User.
-
- return:
-
arguments:
object
-
-
state:
object
-
Active/inactive status of the User's account.
-
- return:
-
arguments:
object
-
-
userRoles:
object
-
A paginated list of
UserRole
s (resolver) of the User. -
- return:
-
arguments:
object
-
Example
{
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {}
}
}
}
}
}
UserActivateMutationPayload: object
Autogenerated return type of UserActivateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
UserBranchMembershipGuardErrorEnum: string
-
objecthas_group_membership
-
This user is a member of one or more groups, and cannot be assigned to a new branch or moved from their current branch.
UserConfirmationStatus: string
The user's valid confirmation states
-
objectconfirmed
-
Confirmed by password
-
objectunconfirmed
-
Not confirmed by password
UserConnection: object
The connection type for User.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {}
}
}
}
}
}
}
}
]
}
}
UserCreateMutationPayload: object
Autogenerated return type of UserCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
user:
object
-
User
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
}
}
}
}
}
}
UserDeactivateMutationPayload: object
Autogenerated return type of UserDeactivateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
UserEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {}
}
}
}
}
}
UserExternalPackage: object
Represents information about a user's enrollment in an External Package.
-
id:
object
-
ID of the User External Package.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with the User External Package. -
- return:
-
arguments:
object
-
Example
{
"id": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string",
"arguments": {}
},
"whiteLogoUrl": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"branding": {}
}
}
}
}
}
UserExternalPackageConnection: object
The connection type for UserExternalPackage.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
]
}
}
UserExternalPackageSortAttributes: string
-
objectuser_id
-
Sort by User ID
-
objectuser_status
-
Sort by status
-
objectuser_sis_id
-
Sort by User SIS ID
UserExternalPackageTypeEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"id": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
UserFilter: object
Input fields for user search
- ids:
-
Search by IDs
- excludedIds:
-
Exclude users that match IDs
- email:
-
Search by email
- name:
-
Search by name
- query:
-
Smart search across ID, SIS ID, name, and email
- branchId:
-
Search by branch_id
- withoutBranch:
-
Search only for users without a branch
- roleSlug:
-
Search by role
- withoutRole:
-
Search only for users without a role
- withoutBranchPlanLicense:
-
Search only for users who do not have an active or pending License for the specified BranchPlan
- confirmationStatus:
-
Search by confirmation status
- managersBranchId:
-
Search Managers by Branch ID
- groupId:
-
Search members by Group ID
- groupIdPlusUserIds:
-
Search users in Group with Group ID, plus additional users with IDs
- notGroupIdPlusUserIds:
-
Search users not in Group with Group ID, plus additional users with IDs
- withoutGroup:
-
Search only for users without a group
- managersGroupId:
-
Search Managers by Group ID
- createdAfter:
-
Search users created after given epoch timestamp
- createdBefore:
-
Search users created before given epoch timestamp
Example
{
"ids": [
"string"
],
"excludedIds": [
"string"
],
"email": "string",
"name": "string",
"query": "string",
"branchId": "string",
"withoutBranch": "boolean",
"roleSlug": "string",
"withoutRole": "boolean",
"withoutBranchPlanLicense": "string",
"confirmationStatus": "string",
"managersBranchId": "string",
"groupId": "string",
"groupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"notGroupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"withoutGroup": "boolean",
"managersGroupId": "string",
"createdAfter": "number",
"createdBefore": "number"
}
UserRecognition: object
Represents information about a user recognition
-
completedAt:
object
-
Timestamp when the user recognition was earned.
-
- return:
-
arguments:
object
-
-
contentPackageId:
object
-
ID of the content package associated with the earned user recognition.
-
- return:
-
arguments:
object
-
-
contentPackageTitle:
object
-
Title of the content package associated with the earned user recognition.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the user recognition.
-
- return:
-
arguments:
object
-
-
name:
object
-
Name of the user recognition.
-
- return:
-
arguments:
object
-
-
recognitions:
object
-
Information about the recognitions earned by user.
-
- return:
-
arguments:
object
-
Example
{
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recognitions": {
"return": [
{
"type": {
"return": "string",
"arguments": {}
},
"value": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
}
}
UserRecognitionConnection: object
The connection type for UserRecognition.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recognitions": {
"return": [
{
"type": {
"return": "string",
"arguments": {}
},
"value": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recognitions": {
"return": [
{
"type": {
"return": "string",
"arguments": {}
},
"value": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
}
}
}
}
UserRecognitionEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"completedAt": {
"return": "object",
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"recognitions": {
"return": [
{
"type": {
"return": "string",
"arguments": {}
},
"value": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
}
},
"arguments": {}
}
}
UserRecognitionSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by recognition name
-
objectcontent_package_id
-
Sort by content package id
-
objectcontent_package_title
-
Sort by content package title
-
objectcompleted_at
-
Sort by time user recognition was earned
UserRemoveGroupsMutationPayload: object
Autogenerated return type of UserRemoveGroupsMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
UserRole: object
-
accessContext:
object
-
The AccessContext associated to the CurrentUser's UserRole
-
- return:
-
arguments:
object
-
-
accessContextId:
object
-
Access context ID of the UserRole.
-
- return:
-
arguments:
object
-
-
accessContextType:
object
-
Access context type of the UserRole.
-
- return:
-
arguments:
object
-
-
applicableAccessContexts:
object
-
Array of scopes to which the
UserRole
can be applied. -
- return:
-
arguments:
object
-
-
id:
object
-
ID of the UserRole.
-
- return:
-
arguments:
object
-
-
properties:
object
-
Set of configuration values for the specific user role
-
- return:
-
arguments:
object
-
-
role:
object
-
Role
(resolver) associated with UserRole. -
- return:
-
arguments:
object
-
-
roleSlug:
object
-
Role slug of the UserRole.
-
- return:
-
arguments:
object
-
-
user:
object
-
User
(resolver) associated with UserRole. -
- return:
-
arguments:
object
-
-
userId:
object
-
User ID for the UserRole.
-
- return:
-
arguments:
object
-
Example
{
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"roleSlug": {
"return": "string",
"arguments": {}
},
"user": {
"return": {}
}
}
UserRoleConnection: object
The connection type for UserRole.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {}
}
}
}
}
}
]
}
}
UserRoleCreateInput: object
- userId:
- roleSlug:
- accessContextType:
- accessContextId:
Example
{
"userId": "string",
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
}
UserRoleCreateMutationPayload: object
Autogenerated return type of UserRoleCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
creationGuard:
object
-
Message describing details of the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
userRole:
object
-
UserRole
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
}
}
]
}
}
}
}
}
}
UserRoleDeleteMutationPayload: object
Autogenerated return type of UserRoleDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
userRole:
object
-
UserRole
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
]
}
}
}
}
}
}
UserRoleEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"resource": {
"return": "string",
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"slug": {
"return": "string",
"arguments": {}
},
"updatedAt": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
}
}
UserRoleUpdateMutationPayload: object
Autogenerated return type of UserRoleUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
userRole:
object
-
Contains the mutated
UserRole
resource. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean",
"arguments": {}
},
"permissions": {
"return": [
{
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"action": {
"return": "string",
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
]
}
}
}
}
}
}
UserRolesCreateInput: object
- roleSlug:
- userIds:
- accessContextType:
- accessContextId:
Example
{
"roleSlug": "string",
"userIds": [
"string"
],
"accessContextType": "string",
"accessContextId": "string"
}
UserRolesCreateMutationPayload: object
Autogenerated return type of UserRolesCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
results:
object
-
Contains Array of results of the mutation for participating
UserRole
resources. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"results": {
"return": [
{
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean"
}
}
}
}
}
}
]
}
}
UserRolesDeleteByAccessContextInput: object
- userId:
- accessContextType:
- accessContextId:
Example
{
"userId": "string",
"accessContextType": "string",
"accessContextId": "string"
}
UserRolesDeleteByAccessContextMutationPayload: object
Autogenerated return type of UserRolesDeleteByAccessContextMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
results:
object
-
Contains Array of results of the mutation for participating
UserRole
resources. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"results": {
"return": [
{
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean"
}
}
}
}
}
}
]
}
}
UserRolesDeleteByIdMutationPayload: object
Autogenerated return type of UserRolesDeleteByIdMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
results:
object
-
Contains Array of results of the mutation for participating
UserRole
resources. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"results": {
"return": [
{
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean"
}
}
}
}
}
}
]
}
}
UserRolesDeleteMutationPayload: object
Autogenerated return type of UserRolesDeleteMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
results:
object
-
Contains Array of results of the mutation for participating
UserRole
resources. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"results": {
"return": [
{
"creationGuard": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"userRole": {
"return": {
"accessContext": {
"arguments": {}
},
"accessContextId": {
"return": "string",
"arguments": {}
},
"accessContextType": {
"return": "string",
"arguments": {}
},
"applicableAccessContexts": {
"return": [
"string"
],
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"properties": {
"return": "object",
"arguments": {}
},
"role": {
"return": {
"accessContexts": {
"return": [
"string"
],
"arguments": {}
},
"description": {
"return": "string",
"arguments": {}
},
"editable": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"permissionBased": {
"return": "boolean"
}
}
}
}
}
}
]
}
}
UserSegment: object
-
componentTypes:
object
-
A list of unique UserSegmentComponent types.
-
- return:
-
arguments:
object
-
-
components:
object
-
A paginated list of UserSegmentComponents.
-
- return:
-
arguments:
object
-
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
Example
{
"componentTypes": {
"return": [
"string"
],
"arguments": {}
},
"components": {
"return": {
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
},
"arguments": {
"after": "string",
"before": "string",
"first": "number",
"last": "number"
}
}
}
UserSegmentComponent: object
-
accessContext:
object
-
The AccessContext associated with the UserSegmentComponent. This is only valid for Role components.
-
- return:
-
arguments:
object
-
-
component:
object
-
The component that represents a set of segmented users.
-
- return:
-
arguments:
object
-
-
id:
object
-
The ID of the UserSegmentComponent
-
- return:
-
arguments:
object
-
Example
{
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
UserSegmentComponentAssociationConnection: object
The connection type for UserSegmentComponent.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
UserSegmentComponentCreateInput: object
- componentId:
- componentType:
- accessContextId:
- accessContextType:
Example
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
UserSegmentComponentEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessContext": {
"arguments": {}
},
"component": {
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
UserSegmentComponentType:
Data pertaining to the component that represents a set of segmented Users
Example
UserSegmentCreateInput: object
- components:
Example
{
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
}
UserSegmentTypeEnum: string
-
objectTenant
-
Segment defined by a Tenant.
-
objectBranch
-
Segment defined by a Branch.
-
objectRole
-
Segment defined by a Role.
-
objectContentPackage
-
Segment defined by a ContentPackage.
-
objectGroup
-
Segment defined by a Group.
-
objectLearningHubEvent
-
Segment defined by a LearningHubEvent.
-
objectUser
-
Segment defined by a User.
-
objectRoleAccessContext
-
Segment defined by a RoleAccessContext.
UserSortAttributes: string
-
objectid
-
Sort by ID
-
objectsis_id
-
Sort by SIS ID
-
objectname
-
Sort by name
-
objectemail
-
Sort by email
-
objectstate
-
Sort by state
-
objectcreated_at
-
Sort by time created
UserUpdateInput: object
- id:
- name:
- email:
- password:
- passwordConfirmation:
- sisId:
- extendedTimeAccommodation:
Example
{
"id": "string",
"name": "string",
"email": "string",
"password": "string",
"passwordConfirmation": "string",
"sisId": "string",
"extendedTimeAccommodation": "boolean"
}
UserUpdateMutationPayload: object
Autogenerated return type of UserUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
user:
object
-
User
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
}
}
}
}
}
}
}
}
UsersCreateInput: object
- fileName:
- dataFormat:
- users:
- branchId:
- groupId:
- role:
- branchPlanId:
Example
{
"fileName": "string",
"dataFormat": "string",
"users": [
{
"name": "string",
"email": "string",
"password": "string",
"sisId": "string"
}
],
"branchId": "string",
"groupId": "string",
"role": {
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
},
"branchPlanId": "string"
}
UsersCreateMutationPayload: object
Autogenerated return type of UsersCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
uploadStatus:
object
-
A message indicating the status of the user upload.
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"uploadStatus": {
"return": "string",
"arguments": {}
}
}
UsersCreateRoleInput: object
- roleSlug:
- accessContextType:
- accessContextId:
Example
{
"roleSlug": "string",
"accessContextType": "string",
"accessContextId": "string"
}
UsersGroupAssignInput: object
- fileName:
- dataFormat:
- users:
Example
{
"fileName": "string",
"dataFormat": "string",
"users": [
{
"userId": "string",
"groupId": "string"
}
]
}
UsersGroupAssignMutationPayload: object
Autogenerated return type of UsersGroupAssignMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
uploadStatus:
object
-
A message indicating the status of the group assignment upload.
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"uploadStatus": {
"return": "string",
"arguments": {}
}
}
Voucher: object
Represents information about a plan's vouchers
-
accessTokenRedemptionsCount:
object
-
Number of times this Voucher has been redeemed.
-
- return:
-
arguments:
object
-
-
branchPlan:
object
-
The
BranchPlan
(resolver) associated with the Voucher. -
- return:
-
arguments:
object
-
-
createdAt:
object
-
Timestamp when the Voucher was created.
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Voucher.
-
- return:
-
arguments:
object
-
-
maxUseCount:
object
-
Maximum number of times a Voucher can be redeemed.
-
- return:
-
arguments:
object
-
-
plan:
object
-
The
Plan
(resolver) associated with the Voucher. -
- return:
-
arguments:
object
-
-
redemptions:
object
-
The
AccessTokenRedemptions
associated with the Voucher. -
- return:
-
arguments:
object
-
- offset:
-
The index of the first item in the records to be returned
- limit: 25
-
The maximum number of records to be returned
- filters:
- sort:
- after:
-
Returns the elements in the list that come after the specified cursor.
- before:
-
Returns the elements in the list that come before the specified cursor.
- first:
-
Returns the first n elements from the list.
- last:
-
Returns the last n elements from the list.
-
subscriptionsCount:
object
-
Number of current subscriptions using the Voucher.
-
- return:
-
arguments:
object
-
-
token:
object
-
Token created for the Voucher.
-
- return:
-
arguments:
object
-
-
usesRemaining:
object
-
Number of redemptions allowed remaining on the Voucher.
-
- return:
-
arguments:
object
-
Example
{
"accessTokenRedemptionsCount": {
"return": "number",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string",
"arguments": {}
},
"primaryColor": {
"return": "string",
"arguments": {}
},
"secondaryColor": {}
}
}
}
}
}
}
}
VoucherConnection: object
The connection type for Voucher.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessTokenRedemptionsCount": {
"return": "number",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
}
VoucherCreateMutationPayload: object
Autogenerated return type of VoucherCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
vouchers:
object
-
Contains Array of
Voucher
resources participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"vouchers": {
"return": [
{
"accessTokenRedemptionsCount": {
"return": "number",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {}
}
}
}
}
}
}
}
}
}
]
}
}
VoucherEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"accessTokenRedemptionsCount": {
"return": "number",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"mobileIconUrl": {
"return": "string"
}
}
}
}
}
}
}
}
}
}
VoucherRedemptionMutationPayload: object
Autogenerated return type of VoucherRedemptionMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
enrollments:
object
-
Enrollment
resources created as a result of redemption. -
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
license:
object
-
License
resource created as a result of redemption. -
- return:
-
arguments:
object
-
-
subscription:
object
-
Subscription
resource created as a result of redemption. -
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"enrollments": {
"return": {
"additionalResets": {
"return": "number",
"arguments": {}
},
"baseExamResetLimit": {
"return": "number",
"arguments": {}
},
"clients": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"contentPackageId": {
"return": "string",
"arguments": {}
},
"contentPackageTitle": {
"return": "string",
"arguments": {}
},
"enrolledUntil": {
"return": "object",
"arguments": {}
},
"examResetsAllowed": {
"return": "boolean",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"npsRating": {
"return": "number",
"arguments": {}
},
"status": {
"return": "string",
"arguments": {}
},
"user": {
"return": {
"authenticationProvider": {
"return": "string",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean"
}
}
}
}
}
}
}
}
}
}
}
}
VoucherSortAttributes: string
-
objectid
-
Sort by ID
-
objecttoken
-
Sort by Name
-
objectuses_remaining
-
Sort by Uses Remaining
-
objectsubscriptions_count
-
Sort by Subscription Count
-
objectaccess_token_redemptions_count
-
Sort by Redemption Count
-
objectplan_name
-
Sort by Plan Name
VoucherUpdateMutationPayload: object
Autogenerated return type of VoucherUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
voucher:
object
-
Voucher
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"voucher": {
"return": {
"accessTokenRedemptionsCount": {
"return": "number",
"arguments": {}
},
"branchPlan": {
"return": {
"activatedLicenseCount": {
"return": "number",
"arguments": {}
},
"activeLicenseCount": {
"return": "number",
"arguments": {}
},
"availableSeatCount": {
"return": "number",
"arguments": {}
},
"branch": {
"return": {
"appliedBranding": {
"return": {
"brandableId": {
"return": "string",
"arguments": {}
},
"brandableType": {
"return": "string",
"arguments": {}
},
"colorLogoUrl": {
"return": "string",
"arguments": {}
},
"emailLogoUrl": {
"return": "string",
"arguments": {}
},
"faviconUrl": {
"return": "string",
"arguments": {}
},
"footer": {
"return": {
"html": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"isDefault": {
"return": "boolean",
"arguments": {}
},
"variables": {
"return": "object",
"arguments": {}
}
},
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"marketingPage": {
"return": {
"html": {}
}
}
}
}
}
}
}
}
}
}
}
Webhook: object
Represents information about a webhook.
-
contentLocation:
object
-
The content_location that matches (with wildcards) the content_location on the WebhookEvent
-
- return:
-
arguments:
object
-
-
contentLocationModels:
object
-
Information about content location models.
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Creation timestamp for the Webhook
-
- return:
-
arguments:
object
-
-
customHeaders:
object
-
Custom headers of the Webhook
-
- return:
-
arguments:
object
-
-
enabled:
object
-
Indicates whether the Webhook should be handled or ignored
-
- return:
-
arguments:
object
-
-
eventType:
object
-
The event_type that matches the event_type on the WebhookEvent
-
- return:
-
arguments:
object
-
-
formatter:
object
-
Event Data Formatter for the Webhook.
-
- return:
-
arguments:
object
-
-
hmacSecret:
object
-
The secret key used to sign Webhook payloads
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Webhook
-
- return:
-
arguments:
object
-
-
name:
object
-
The name of the Webhook
-
- return:
-
arguments:
object
-
-
url:
object
-
Destination URL for the Webhook
-
- return:
-
arguments:
object
-
Example
{
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
}
WebhookConnection: object
The connection type for Webhook.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
}
}
]
}
}
WebhookCreateInput: object
- name:
- url:
- enabled:
- eventType:
- contentLocation:
- customHeaders:
- formatter:
Example
{
"name": "string",
"url": "string",
"enabled": "boolean",
"eventType": "string",
"contentLocation": "string",
"customHeaders": "object",
"formatter": "string"
}
WebhookCreateMutationPayload: object
Autogenerated return type of WebhookCreateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
webhook:
object
-
Webhook
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"webhook": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
WebhookDelivery: object
Represents information about a webhook delivery.
-
attempt:
object
-
Attempt number of this WebhookDelivery
-
- return:
-
arguments:
object
-
-
createdAt:
object
-
Creation timestamp for the Webhook Delivery
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the Webhook Delivery
-
- return:
-
arguments:
object
-
-
responseBody:
object
-
HTTP response body from Webhook destination server
-
- return:
-
arguments:
object
-
-
statusCode:
object
-
The HTTP response status code of the Webhook Delivery
-
- return:
-
arguments:
object
-
-
success:
object
-
Boolean value indicating request success or failure
-
- return:
-
arguments:
object
-
-
testEvent:
object
-
Boolean value indicating whether the WebhookEvent was real or a test
-
- return:
-
arguments:
object
-
-
webhookEventId:
object
-
ID of the asscoated webhook event
-
- return:
-
arguments:
object
-
-
webhookId:
object
-
ID of the associated Webhook
-
- return:
-
arguments:
object
-
Example
{
"attempt": {
"return": "number",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"responseBody": {
"return": "string",
"arguments": {}
},
"statusCode": {
"return": "number",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
},
"webhookEventId": {
"return": "string",
"arguments": {}
},
"webhookId": {
"return": "string",
"arguments": {}
}
}
WebhookDeliveryConnection: object
The connection type for WebhookDelivery.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"attempt": {
"return": "number",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"responseBody": {
"return": "string",
"arguments": {}
},
"statusCode": {
"return": "number",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
},
"webhookEventId": {
"return": "string",
"arguments": {}
},
"webhookId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"attempt": {
"return": "number",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"responseBody": {
"return": "string",
"arguments": {}
},
"statusCode": {
"return": "number",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
},
"webhookEventId": {
"return": "string",
"arguments": {}
},
"webhookId": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {}
}
}
}
WebhookDeliveryEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"attempt": {
"return": "number",
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"responseBody": {
"return": "string",
"arguments": {}
},
"statusCode": {
"return": "number",
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
},
"webhookEventId": {
"return": "string",
"arguments": {}
},
"webhookId": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
WebhookDeliverySortAttributes: string
-
objectid
-
Sort by ID
-
objectwebhook_id
-
Sort by Webhook ID
-
objectwebhook_event_id
-
Sort by Webhook Event ID
-
objectattempt
-
Sort by number of attempts
-
objecttest_event
-
Sort by test_event boolean
-
objectstatus_code
-
Sort by HTTP response status code
-
objectcreated_at
-
Sort by created_at
WebhookEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
WebhookEvent: object
Represents information about a webhook event.
-
createdAt:
object
-
Creation timestamp for the WebhookEvent
-
- return:
-
arguments:
object
-
-
data:
object
-
The data of the WebhookEvent
-
- return:
-
arguments:
object
-
-
deliveriesCount:
object
-
Number of WebhookDelivery records of the WebhokEvent
-
- return:
-
arguments:
object
-
-
eventType:
object
-
The event_type that matches the event_type on the WebhookEvent
-
- return:
-
arguments:
object
-
-
id:
object
-
ID of the WebhookEvent
-
- return:
-
arguments:
object
-
-
testEvent:
object
-
Indicates if this event was triggered as a test event
-
- return:
-
arguments:
object
-
Example
{
"createdAt": {
"return": "object",
"arguments": {}
},
"data": {
"return": "object",
"arguments": {}
},
"deliveriesCount": {
"return": "number",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
}
}
WebhookEventConnection: object
The connection type for WebhookEvent.
-
edges:
object
-
A list of edges.
-
- return:
-
arguments:
object
-
-
nodes:
object
-
A list of nodes.
-
- return:
-
arguments:
object
-
-
pageInfo:
object
-
Information to aid in pagination.
-
- return:
-
arguments:
object
-
-
totalCount:
object
-
Total count of records without pagination.
-
- return:
-
arguments:
object
-
Example
{
"edges": {
"return": [
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"data": {
"return": "object",
"arguments": {}
},
"deliveriesCount": {
"return": "number",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
],
"arguments": {}
},
"nodes": {
"return": [
{
"createdAt": {
"return": "object",
"arguments": {}
},
"data": {
"return": "object",
"arguments": {}
},
"deliveriesCount": {
"return": "number",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
}
}
],
"arguments": {}
},
"pageInfo": {
"return": {
"endCursor": {
"return": "string",
"arguments": {}
},
"hasNextPage": {
"return": "boolean",
"arguments": {}
},
"hasPreviousPage": {
"return": "boolean",
"arguments": {}
},
"startCursor": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
},
"totalCount": {
"return": "number",
"arguments": {}
}
}
WebhookEventEdge: object
An edge in a connection.
-
cursor:
object
-
A cursor for use in pagination.
-
- return:
-
arguments:
object
-
-
node:
object
-
The item at the end of the edge.
-
- return:
-
arguments:
object
-
Example
{
"cursor": {
"return": "string",
"arguments": {}
},
"node": {
"return": {
"createdAt": {
"return": "object",
"arguments": {}
},
"data": {
"return": "object",
"arguments": {}
},
"deliveriesCount": {
"return": "number",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"testEvent": {
"return": "boolean",
"arguments": {}
}
},
"arguments": {}
}
}
WebhookEventFilter: object
Input fields for webhook event search
- ids:
-
Search by IDs
- eventType:
-
Filter by trigger event type
- startDate:
-
Filter to WebhookEvents created after the given timestamp (inclusively)
- endDate:
-
Filter to WebhookEvents created before the given timestamp (inclusively)
Example
{
"ids": [
"string"
],
"eventType": "string",
"startDate": "object",
"endDate": "object"
}
WebhookEventSortAttributes: string
-
objectid
-
Sort by ID
-
objectevent_type
-
Sort by trigger event_type
-
objecttest_event
-
Sort by test_event
-
objectcreated_at
-
Sort by created_at
WebhookResendDeliveryMutationPayload: object
Autogenerated return type of WebhookResendDeliveryMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
deliveryJobInProgress:
object
-
Boolean value indicating whether the delivery job is queued or in progress
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"deliveryJobInProgress": {
"return": "boolean",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
}
}
WebhookSortAttributes: string
-
objectid
-
Sort by ID
-
objectname
-
Sort by name
-
objectevent_type
-
Sort by trigger event_type
-
objectenabled
-
Sort by enabled
WebhookTestMutationPayload: object
Autogenerated return type of WebhookTestMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
webhook:
object
-
Webhook
resource being tested. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"webhook": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}
WebhookUpdateMutationPayload: object
Autogenerated return type of WebhookUpdateMutation
-
clientMutationId:
object
-
A unique identifier for the client performing the mutation.
-
- return:
-
arguments:
object
-
-
errors:
object
-
Errors encountered during Mutation execution
-
- return:
-
arguments:
object
-
-
success:
object
-
Indicates the status of the Mutation
-
- return:
-
arguments:
object
-
-
webhook:
object
-
Webhook
resource participating in the mutation. -
- return:
-
arguments:
object
-
Example
{
"clientMutationId": {
"return": "string",
"arguments": {}
},
"errors": {
"return": [
{
"message": {
"return": "string",
"arguments": {}
},
"path": {
"return": [
"string"
],
"arguments": {}
}
}
],
"arguments": {}
},
"success": {
"return": "boolean",
"arguments": {}
},
"webhook": {
"return": {
"contentLocation": {
"return": "string",
"arguments": {}
},
"contentLocationModels": {
"return": [
{
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
}
}
],
"arguments": {}
},
"createdAt": {
"return": "object",
"arguments": {}
},
"customHeaders": {
"return": "object",
"arguments": {}
},
"enabled": {
"return": "boolean",
"arguments": {}
},
"eventType": {
"return": "string",
"arguments": {}
},
"formatter": {
"return": "string",
"arguments": {}
},
"hmacSecret": {
"return": "string",
"arguments": {}
},
"id": {
"return": "string",
"arguments": {}
},
"name": {
"return": "string",
"arguments": {}
},
"url": {
"return": "string",
"arguments": {}
}
},
"arguments": {}
}
}